Google Java Format est un outil développé par Google pour garantir que le code Java respecte un style uniforme et cohérent. Il applique un formatage strict, en accord avec les pratiques de Google, et permet de gagner du temps en évitant les discussions sur les conventions de style.
Comment ajouter Google Java Format sur IntelliJ IDEA
Installer le plugin Google Java Format
- Ouvrez IntelliJ IDEA.
- Allez dans File > Settings (ou Preferences sur macOS).
- Sélectionnez Plugins et recherchez Google Java Format.
- Cliquez sur Install pour ajouter le plugin.
- Redémarrez IntelliJ IDEA après l’installation.
Configurer Google Java Format
Après avoir installé le plugin, vous devez ajouter des options au JRE de votre IDE pour que Google Java Format fonctionne correctement. Cela est nécessaire car le plugin utilise des classes internes du compilateur Java (jdk.compiler), qui ne sont pas accessibles par défaut. Pour ce faire, suivez ces étapes :
- Allez dans Help > Edit Custom VM Options….
- Ajoutez les lignes suivantes dans le fichier .vmoptions qui s’ouvre :
--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
- Enregistrez le fichier et redémarrez IntelliJ IDEA pour que les changements prennent effet.
Activer et configurer Google Java Format
- Une fois le plugin installé et le JRE configuré, allez dans File > Settings > google-java-format Settings.
- Cochez l’option Enable Google Java Format et personnalisez les paramètres si nécessaire.
Utilisation du formatage
Pour formater votre code avec Google Java Format, ouvrez un fichier Java et appuyez sur Ctrl + Alt + L (ou Cmd + Alt + L sur Mac) pour appliquer les règles de formatage.
Pourquoi utiliser Google Java Format ?
- Cohérence : Il applique uniformément les conventions de Google pour que le code reste cohérent, peu importe les préférences individuelles des développeurs.
- Simplicité : Il élimine le besoin de configurer manuellement des règles complexes, car les règles de formatage sont déjà définies.
- Gain de temps : Réduit le temps passé à formater manuellement le code ou à discuter des conventions de style.
Avantages de Google Java Format
- Standardisation : Permet de s’assurer que tout le code respecte les mêmes règles, ce qui facilite l’intégration de nouveaux développeurs dans un projet.
- Productivité : Réduit les distractions liées au formatage manuel et aux discussions sur le style de code.
- Fiabilité : En tant qu’outil officiel de Google, il assure un formatage conforme aux meilleures pratiques de développement.