Configuration d'Eclipse en mode équipe

Dans l'article précédent, nous avons vu l'installation du JDK et d'Eclipse. Nous allons maintenant configurer Eclipse de façon à le rendre opérationnel pour les développements en équipe, notamment :

• Encodage
• Proxy
• JREs installés
• Compilateur Java
• Style de code Java
• Ressources ignorées lors d'un commit

Enfin, on verra comment exporter toutes ces préférences.

A noter que la configuration que nous allons mettre en oeuvre s'applique uniquement au workspace en cours d'utilisation. Si vous utilisez plusieurs workspaces, il faudra donc appliquer la configuration ci-dessous pour chaque workspace.

Encodage

Par défaut, l'encodage utilisé pour le workspace est celui de la machine. Donc, sous Windows, l'encodage par défaut sera "Cp1252". Donc, si vous êtes une équipe qui travaille sur des environnements distincts (Linux, Windows, ...), vous risquez d'avoir quelques soucis d'encodage.

Par conséquent, nous allons configurer Eclipse de façon à utiliser l'encodage UTF-8. Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" puis "Workspace"
• Modifier la valeur de "Text file encoding" de façon à choisir "UTF-8"

Changer l'encodage

Proxy

Si nécessaire, vous pouvez configurer le proxy pour que Eclipse puisse accéder à Internet. Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Network Connections"
• Dans "Active provider", sélectionner "Manual"
• Renseigner l'hôte, le port, voire l'authentification si nécessaire

Configuration du proxy

JREs installés

Dans un précédent article, nous avions lié Eclipse avec le JDK 1.7. Par conséquent, le JRE (Java Runtime Environment) utilisé par défaut pour compiler et exécuter les projets sera donc le JRE 1.7.

Vous avez bien entendu la possibilité d'ajouter d'autres JRE (1.5, 1.6, 1.8, ...) si vous avez des projets liés à une version spécifique de JRE. Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Java" / "Installed JREs"

JREs installées

Pour chaque environnement d'exécution (1.5, 1.6, 1.7, ...), vous avez la possibilité de sélectionner le JRE à utiliser par défaut. Dans notre cas, nous allons donc affecter le JDK 1.7 installé à l'environnement d'exécution "JavaSE-1.7" puisqu'il correspond parfaitement à cet environnement d'exécution.

Association Environnement d'exécution / JRE 

Ainsi, si vous avez un projet en 1.6, vous pouvez quand même utiliser le JDK 1.7 car il y a une compatibilité ascendante dans les versions de Java.

Association Environnement d'exécution / JRE compatible

Compilateur Java

Si vous avez un JDK 1.7 installé et que vous voulez que vos projets compilent en 1.5, il faut spécifier le niveau de compatibilité du compilateur. Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Java" / "Compiler"
• Spécifier la valeur souhaitée pour "Compiler compliance level"

Exemple où le code source doit être compatible 1.5

Style de code Java

Dans une équipe de développement, il est primordial que tous les membres se mettent d'accord sur la façon dont le texte java doit être écrit, notamment pour les critères suivants :

• Formater le code
• Définir les templates de code
• Organiser les imports

Grâce à Eclipse, tous ces critères peuvent être automatiquement appliqués, ce qui élimine complètement le risque de commiter du code mal formaté ou mal organisé.

Formater le code

Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Java" / "Code style" / "Formatter"

Vous avez la possibilité de :

• soit créer un nouveau profil à partir du profil Eclipse par défaut
• soit importer un profil existant (fichier XML)

Je vous propose celui que j'utilise dans mes développements : Code formatter.xml. Bien entendu, vous êtes libre de le modifier comme bon vous semble !

Définir les templates de code

Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Java" / "Code style" / "Code templates"

Tout d'abord, cocher la case "Automatically add comments for new methods and types" : cela permet d'ajouter automatiquement les commentaires (javadoc principalement) à toutes les nouvelles méthodes ou types (classes, énumérations, ...).

Deux templates à modifier :

• Comments/Files : spécifiez l'en-tête que vous souhaitez insérer dans chaque fichier java. Par exemple : nom de l'entreprise, année, licence, ...

  /*
   * Bruno Cornouiller 2001-2014. Tous droits réservés.
   */
  

• Comments/Overriding methods : par défaut, la javadoc n'est pas "héritée" pour les méthodes redéfinies dans les classes filles. Il est possible néanmoins d'activer la redéfinition de la javadoc dans la classe fille :

  /**
   * {@inheritDoc}
   */
  

 Organiser les imports

Pour cela :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Java" / "Code style" / "Organize imports"

L'organisation par défaut est en général suffisante. Vous pouvez, si vous le souhaitez, changer l'ordre ou ajouter d'autres packages, comme par exemple "fr".

Organisation des imports

Mise en forme automatique

Pour mettre en forme automatiquement le code lors de la sauvegarde d'un fichier :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "General" / "Java" / "Editor" / "Save actions"

Sur la copie d'écran ci-dessous, vous avez la liste des mises en forme que j'applique automatiquement pour l'ensemble des sources Java :

Actions à effectuer lors de la sauvegarde du code source java

Ressources ignorées lors d'un commit

Lorsque vous commitez des ressources dans un repository CVS/SVN, certains répertoires et/ou fichiers peuvent être ignorés. Par exemple, si vous utilisez Maven, il est inutile de commiter le répertoire "target", car il contient les classes compilées notamment.

Pour ignorer le répertoire "target" lors d'un commit :

• Aller dans le menu "Windows" puis "Préférences"
• Sélectionner "Team" / "Ignored resources"

Ignorer le répertoire "target" lors d'un commit

Exporter les préférences

Vous avez la possibilité d'exporter certaines préférences dans un fichier :

• Installed JREs
• Java Code Style Preferences
• Java Compiler Preferences
• Team Ignored Resources Transfer

Cela permettra d'appliquer ces préférences sur l'ensemble des postes de développement.

Malheureusement, la seule préférence que l'on ne peut pas exporter concerne la mise en forme automatique. C'est dommage ! Néanmoins, il sera possible comme on le verra dans un prochain article, de sauvegarder cette préférence directement dans le projet.

Bonne route !