Was ist Build Runner und warum solltest du es verwenden?

In der Welt der Softwareentwicklung geht es immer wieder um Effizienz. Niemand möchte Code schreiben, den ein Computer automatisch generieren könnte. Genau hier kommt Build Runner ins Spiel. Wenn du in Flutter oder Dart arbeitest und dich fragst, wie du repetitive Aufgaben automatisieren kannst, ist Build Runner ein mächtiges Werkzeug, das du kennen solltest. In diesem Beitrag erfährst du, was Build Runner ist, wie es funktioniert und wie du es für deine Projekte nutzen kannst.

Was ist Build Runner?

Eine Definition

Build Runner ist ein Befehlszeilen-Tool für Dart, das dir hilft, Code automatisch zu generieren. Es ist nicht selbst ein Generator, sondern ein Orchestrator, der mit sogenannten «Buildern» arbeitet. Diese Builder, wie z. B. json_serializable oder freezed, übernehmen die eigentliche Generierungsarbeit.

Stell dir vor, du musst für jede JSON-API ein Datenmodell schreiben, mit allen fromJson– und toJson-Methoden. Das klingt nach viel unnötigem Aufwand, oder? Genau solche Dinge kann Build Runner für dich erledigen.

Wie funktioniert Build Runner?

Build Runner arbeitet mit Konfigurationen und Buildern, um festgelegte Aufgaben auszuführen:

Es liest den aktuellen Zustand deines Projekts.
Es führt die konfigurierten Builder aus, um Code zu generieren.
Es erstellt generierte Dateien, die dann in deinem Projekt verwendet werden können.

Warum solltest du Build Runner verwenden?

Zeitersparnis

Manuelles Schreiben von Boilerplate-Code ist nicht nur mühsam, sondern birgt auch Fehlerpotenzial. Mit Build Runner sparst du Zeit und reduzierst Fehler, indem du standardisierte Prozesse automatisierst.

Konsistenz

Der generierte Code ist immer konsistent und entspricht den Konventionen der verwendeten Builder. Das macht deinen Code sauberer und einfacher zu warten.

Flexibilität

Build Runner ist extrem flexibel und unterstützt eine Vielzahl von Buildern für unterschiedliche Anwendungsfälle, wie:

JSON-Serialisierung mit json_serializable
Erstellen von Immutable-Objekten mit freezed
Generieren von Einstellungen oder Routen.

Praxisbeispiele für Build Runner

JSON-Serialisierung

Eines der häufigsten Anwendungsbeispiele ist die JSON-Serialisierung mit dem Paket json_serializable. Stell dir vor, du hast eine Dart-Klasse für Daten, die du aus einer API erhältst. Mit Build Runner kannst du die Konvertierungslogik automatisch generieren lassen.

Erstelle zuerst ein Modell:

import 'package:json_annotation/json_annotation.dart';

part 'user.g.dart';

@JsonSerializable()
class User {
  final String name;
  final int age;

  User({required this.name, required this.age});

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

Führe anschliessend diesen Befehl aus, um den Code zu generieren:

dart run build_runner build

Jetzt hast du automatisch generierte Methoden wie _$UserFromJson und _$UserToJson.

Einstellungen verwalten

Stell dir vor, du möchtest Benutzereinstellungen für eine Flutter-App verwalten. Mit YAML-Dateien und Build Runner kannst du Standardwerte definieren und den Zugriffscode generieren lassen.

In einer Datei settings.yaml könntest du folgendes definieren:

theme: dark
notifications: true
language: en

Der generierte Code bietet dir dann direkten Zugriff auf diese Werte in Dart:

final theme = Settings.defaults['theme']; // "dark"
final notifications = Settings.defaults['notifications']; // true

Routing in Flutter

Mit Build Runner und passenden Buildern kannst du sogar Navigationsrouten automatisch generieren lassen. Das spart dir Zeit und reduziert das Risiko von Fehlern, z. B. durch Tippfehler in den Routen.

Wie richtest du Build Runner ein?

Schritt 1: Abhängigkeiten hinzufügen

Füge in deiner pubspec.yaml die notwendigen Pakete hinzu:

dependencies:
  json_serializable: ^6.0.0

dev_dependencies:
  build_runner: ^2.4.0

Installiere die Pakete mit:

flutter pub get

Schritt 2: Builder ausführen

Führe den Build Runner aus, um Code zu generieren:

dart run build_runner build

Oder nutze den Watch-Modus, um Änderungen automatisch zu überwachen:

dart run build_runner watch

Schritt 3: Konflikte lösen

Falls generierte Dateien bereits existieren, füge --delete-conflicting-outputs hinzu:

dart run build_runner build --delete-conflicting-outputs

Tipps für den Umgang mit Build Runner

Modular arbeiten

Nutze Builder wie json_serializable oder freezed, um spezifische Aufgaben zu erledigen. Das macht deinen Workflow effizienter.

Automatisiere den Build-Prozess

Integriere Build Runner in deine CI/CD-Pipeline, damit generierte Dateien immer aktuell sind.

Vermeide manuelle Änderungen

Bearbeite generierte Dateien nie direkt. Ändere stattdessen die Quell-Dateien und führe Build Runner erneut aus.

Fazit

Build Runner ist ein unverzichtbares Tool für jeden, der in Flutter oder Dart arbeitet. Es spart Zeit, erhöht die Konsistenz und sorgt dafür, dass du dich auf das Wesentliche konzentrieren kannst – die Entwicklung grossartiger Features. Egal, ob du JSON-Serialisierung, Einstellungen oder Routen generierst, Build Runner ist dein zuverlässiger Helfer.

dimotec GmbH