Generazione del codice con build_runner

Alcuni frammenti di codice sono boilerplate ripetitivo, come il parsing JSON. La Code generation li scrive per Lei a partire dalle annotazioni, così lavora rapidamente e con precisione. ⚙️

build_runner è lo strumento di Dart che esegue i generatori di codice nel progetto. Legge i file sorgente, individua le annotazioni e genera nuovi file.

Si aggiunge build_runner in dev_dependencies nel file pubspec.yaml, perché viene eseguito durante la build e non viene mai incluso nell'app.

I generatori scrivono in un file gemello. Lo si collega con una direttiva part il cui nome, per convenzione, termina con .g.dart.

Si attiva una generazione una tantum con il comando build. Questo analizza il codice e crea o aggiorna ogni file .g.dart.

Durante lo sviluppo, la modalità watch rigenera automaticamente i file ogni volta che si salva. In questo modo i file generati restano sincronizzati senza dover rieseguire manualmente il comando.

Se l'output entra in conflitto con vecchi file, si aggiunge --delete-conflicting-outputs. Questo elimina i file generati obsoleti, permettendo alla nuova build di riuscire.

I generatori agiscono solo sulle dichiarazioni che si annotano. L'annotazione indica al builder quale classe elaborare e quale codice produrre.

Consideri ogni file .g.dart come sola lettura. La build successiva sovrascriverà le modifiche, quindi modifichi invece il codice sorgente e le annotazioni.

I team scelgono se eseguire il commit dei file generati oppure aggiungerli a .gitignore e ricrearli in CI. In entrambi i casi, scelga una strategia e la applichi con coerenza.

Molti package si integrano con build_runner, ad esempio json_serializable e freezed. Condividono un'unica pipeline di builder, quindi un solo comando li esegue tutti.

Quale comando rigenera il codice a ogni salvataggio di un file?

build_runner trasforma le annotazioni in file .g.dart generati. Lo si aggiunge a dev_dependencies, si esegue build o watch e non si modifica mai l'output. 🎉