On sait qu'il est très bon pour un programmeur d'être paresseux , car faire plus avec moins est la clé du progrès . Personne n'aime faire la même chose encore et encore. C'est fatigant, ennuyeux et pas du tout créatif. En répétant la même action, nous faisons souvent des erreurs, mais, heureusement, il y a ceux qui sont vraiment bons et efficaces pour effectuer des tâches similaires. Et ce sont des ORDINATEURS !

Aujourd'hui, la génération de code est la capacité de faire le travail dans les plus brefs délais . L'idée de base est simple: trouver un modèle dans les mêmes parties fastidieuses du code que vous devez écrire encore et encore, créer un outil de génération, l'exécuter et voir comment la magie opère!

Dans le monde du développement Android, ces outils sont bien connus de tous les développeurs. C'est Retrofit, et Dagger, and Room. Et Dart? Et une question non moins importante: de quoi avons-nous besoin pour créer nos propres outils de génération de code?

Génération de fléchettes et de code: des outils abordables

Pour créer un outil de génération de code, nous avons besoin des deux packages suivants:

• source_gen
• build_runner

source_gen

Ce package fournit une API pratique pour générer du code. Il s'agit d'une abstraction de certains packages Dart de bas niveau, tels que l' analyseur et la construction . Bien que l'utilisation de ce package soit facultative, elle peut vous éviter de nombreuses difficultés.

source_gen fournit deux classes génératrices abstraites qui suivent le modèle Visitor :

• Generator : lors de l'héritage de cette classe, chaque élément de votre code sera visité. Ainsi, vous avez un contrôle total sur ce qu'il faut faire avec chaque nœud ou élément visité.
• GeneratorForAnnotation : cette classe est similaire à un simple Generator, mais lorsque vous héritez de cette classe, vous spécifiez également "annotation". Ainsi, seuls les nœuds annotés avec cette annotation seront visités. Le reste du code sera ignoré.

Vous devez également configurer le générateur, qui sera un wrapper sur le générateur. Il y a trois options:

• Si vous souhaitez écrire un morceau de code partial , vous devez choisir SharedPartBuilder . "part" vous permet de diviser la bibliothèque en plusieurs fichiers Dart. SharedPartBuilder crée un fichier avec l'extension .g.dart .
• Vous pouvez également utiliser PartBuilder si vous souhaitez utiliser l'approche "part", mais vous avez besoin de plus de contrôle sur l'extension du fichier généré, par exemple .my_file.dart .
• Si vous souhaitez écrire une bibliothèque autonome pouvant être importée, utilisez LibraryBuilder .

build_runner

Cet outil vous permet d'exécuter le générateur au stade du développement. Il peut être appelé depuis la ligne de commande:

 pub run build_runner <command> 

Au lieu de <command> peut y avoir:

• build : démarre la génération une fois.
• watch : lance un démon qui suit les changements dans les fichiers et démarre la génération en cas de besoin.
• serve : similaire à watch, mais il démarre comme un serveur de développement.
• test : démarre la génération une fois, crée un répertoire de sortie partagé, puis exécute pub run test --precompiled <merged-output-dir> .

Pour que source_gen fonctionne, vous devez également créer un fichier buil.yaml , qui indique les détails de la configuration du générateur de code.

Utilisation de la génération de code dans Dart

La génération de code est utilisée dans de nombreuses bibliothèques bien connues pour Dart:

• built_value
• json_serializable
• kiwi
• hachoir
• lande (note du traducteur)

En savoir plus ...

La deuxième partie montrera comment utiliser les annotations et la génération de code pour suivre tous les TODO dans l'application.