Interface fluide : vers un code orienté métier

L'interface fluide est une bonne pratique suivie dans la construction d'une API centrée sur le domaine (Domain Specific Language). Le chaînage des méthodes améliore la lisibilité du code ainsi que l'expressivité objet.

La maintenabilité d'une application dépend fortement de la lisibilité du code source sous-jacent. Cette lisibilité peut être améliorée par :

- l'introduction (mesurée) de commentaires dans le code,
- la présence systématique de Javadoc,
- la vérification automatique à l'aide d'outils comme CheckStyle et PMD (règles de nommage, mesure de complexité, etc.),
- la revue de code effectuée par un développeur tiers.

L'objectif de ce billet est de présenter une technique supplémentaire permettant d'améliorer la lisibilité du code. Soit la classe suivante :

public class Person {

    private String firstName;
    private String lastName;
    private Person father;
    private Person mother;
    public void setFirstName(String firstName){
        this.firstName = firstName
    }
    public void setLastName(String lastName){
        this.lastName = lastName
    }
    public void setFather(Person father){this.father = father}
    public void setMother(Person mother){this.mother = mother}

    //Getters volontairement omis pour plus de clarté
    ...
}

Ceci est une classe Person pouvant servir d'entité dans une application d'arbre généalogique. Créons un objet de ce type :

//La personne
Person person = new Person();
person.setFirstName("Youri");
person.setLastName("Gagarine");
//Le papa
Person father= new Person();
father.setFirstName("Alexeï");
father.setLastName(" Ivanovitch");
//La maman
Person mother = new Person();
mother.setFirstName("Anna");
mother.setLastName("Timofeïevna");
//La famille
person.setFather(father);
person.setMother(mother);

Premier constat : ce code est verbeux. On aimerait qu'il ressemble à :

//La personne
Person person = new Person().setFirstName("Youri").setLastName("Gagarine");
//Le papa
Person father= new Person().setFirstName("Alexeï").setLastName("Ivanovitch");
//La maman
Person mother = new Person().setFirstName("Anna").setLastName("Timofeïevna");
//La famille
person.setFather(father).setMother(mother);

Notre code est désormais à la fois moins verbeux et beaucoup plus lisible. Même une personne non-technique pourrait lire :

- Créer une première personne dont le prénom et le nom....
- Créer une deuxième personne dont le prénom et le nom....
- Créer une troisième personne dont le prénom et le nom....
- Lier la première personne au deux autres à l'aide des liens de paternité et de maternité.

Pour pouvoir bénéficier de cette "expressivité", il suffit de modifier les setters de la classe Person afin que chacun de ces setters renvoie l'objet this :

public class Person {
    .....
    public Person setFirstName(String firstName){
        this.firstName = firstName;
        return this;
    }
    public Person setLastName(String lastName){
        this.lastName = lastName;
        return this;
    }
    public Person setFather(Person father){
        this.father = father ;
        return this;
    }
    public Person setMother(Person mother){
        this.mother = mother ;
        return this;
    }
    ...
}

Ici, on renvoie l'objet this mais rien n'empêche de renvoyer un objet d'un autre type. L'objectif de cette approche est de concevoir une API centrée sur le métier de l'application que l'on désire développer (Domain Specific Language). A titre d'exemple, L'API Criteria dans JPA 2.0 utilise cette technique pour construire les requêtes.

Conclusion
L'interface fluide aide à concevoir un API concise et orientée métier où l'accent est mis sur l'alignement du code sur la spécification.

Interface fluide : vers un code orienté métier

Guides

Repères