Cette annexe contient des conseils destinés à vous aider à
structurer vos programmes et écrire le code source de ceux-ci.
Bien entendu, ce ne sont que des suggestions, en aucun cas des règles à
suivre à la lettre. L'idée ici est de s'en inspirer, tout en se rappelant que certaines situations
imposent de faire une entorse aux règles.
Conception
- L'élégance est toujours récompensée. C'est vrai que cela
peut prendre un peu plus de temps pour arriver à une solution élégante du problème considéré, mais
les bénéfices en sont tout de suite apparents (même si personne ne peut les quantifier réellement)
lorsque le programme marche du premier coup et s'adapte facilement à de nouvelles situations plutôt
que de devoir se battre avec pendant des heures, des jours et des mois. Non seulement le programme
est plus facile à écrire et à débugguer, mais il est aussi plus facile à comprendre et à maintenir,
et c'est là que réside sa valeur financière. Ce point demande de l'expérience pour être
complètement assimilé, parce qu'on est tenté de se dire que la recherche d'un code élégant fait
baisser la productivité. Se précipiter ne peut que vous ralentir.
- D'abord le faire marcher, ensuite l'optimiser. Ceci est
vrai même si on est certain qu'une portion de code est réellement importante et sera un goulot
d'étranglement pour le système. D'abord faire fonctionner le système avec une conception aussi
simple que possible. Ensuite le profiler s'il n'est pas assez rapide : on se rendra compte la
plupart du temps que le problème ne se situe pas là où on pensait qu'il serait. Il faut préserver
son temps pour les choses réellement importantes.
- Se rappeler le principe « Diviser pour mieux régner ». Si
le problème considéré est trop embrouillé, il faut essayer d'imaginer quelles opérations ferait le
programme s'il existait une « entité magique » qui prendrait en charge les parties confuses. Cette
entité est un objet - il suffit d'écrire le code qui utilise l'objet, puis analyser cet objet et
encapsuler ses parties confuses dans d'autres objets, et ainsi de suite.
- Séparer le créateur de la classe de l'utilisateur de la classe (le
programmeur client).L'utilisateur de la classe est le
« client », il n'a pas besoin et ne veut pas savoir ce qui se passe dans les coulisses de la
classe. Le créateur de la classe doit être un expert en conception et écrire la classe de manière à
ce qu'elle puisse être utilisée même par le plus novice des programmeurs, tout en remplissant
efficacement son rôle dans le fonctionnement de l'application. L'utilisation d'une bibliothèque ne
sera aisée que si elle est transparente.
- Quand on crée une classe, essayer de choisir des noms explicites
afin de rendre les commentaires inutiles. Le but est de présenter une interface
conceptuellement simple au programmeur client. Ne pas hésiter à surcharger une méthode si cela est
nécessaire pour proposer une interface intuitive et facile à utiliser.
- L'analyse et la conception doivent fournir, au minimum, les
classes du système, leur interface publique et leurs relations avec les autres classes, en
particulier les classes de base. Si la méthodologie de conception produit plus de
renseignements que cela, il faut se demander si tout ce qui est produit a de la valeur pendant
toute la durée du vie du programme. Si ce n'est pas le cas, les maintenir sera coûteux. Les membres
d'une équipe de développement tendent à « oublier » de maintenir tout ce qui ne contribue pas
à leur productivité ; ceci est un fait que beaucoup de méthodologie de conception
négligent.
- Tout automatiser. D'abord écrire le code de test (avant
d'écrire la classe), et le garder avec la classe. Automatiser l'exécution des tests avec un
Makefile ou un outil similaire. De cette manière, chaque changement peut être automatiquement
vérifié en exécutant les tests, et les erreurs seront immédiatement détectées. La présence du filet
de sécurité que constitue la suite de tests vous donnera plus d'audace pour effectuer des
changements radicaux quand vous en découvrirez le besoin. Se rappeler que l'amélioration la plus
importante dans les langages de programmation vient des tests intégrés fournis par la vérification
de type, la gestion des exceptions, etc. mais que ces tests ne sont pas exhaustifs. Il est de votre
responsabilité de fournir un système robuste en créant des tests qui vérifient les fonctionnalités
spécifiques à votre classe ou votre programme.
- D'abord écrire le code de test (avant d'écrire la classe) afin de
vérifier que la conception de la classe est complète. Si on ne peut écrire le code de
test, c'est qu'on ne sait pas ce à quoi la classe ressemble. De plus, l'écriture du code de test
montrera souvent de nouvelles fonctionnalités ou contraintes requises dans la classe - ces
fonctionnalités ou contraintes n'apparaissent pas toujours dans la phase d'analyse et de
conception. Les tests fournissent aussi des exemples de code qui montrent comment utiliser la
classe.
- Tous les problèmes de conception logicielle peuvent être
simplifiés en introduisant un niveau supplémentaire dans l'abstraction. Cette règle
fondamentale de l'ingénierie logicielle [85]
constitue la base de l'abstraction, la fonctionnalité première de la programmation orientée
objet.
- Toute abstraction doit avoir une signification (à mettre
en parallèle avec la règle no 9). Cette signification peut être aussi
simple que « mettre du code fréquemment utilisé dans une méthode ». Si on ajoute des abstractions
(abstraction, encapsulation, etc.) qui n'ont pas de sens, cela est aussi futile que de ne pas en
rajouter.
- Rendre les classes aussi atomiques que possible. Donner à
chaque classe un but simple et précis. Si les classes ou la conception du système gagnent en
complexité, diviser les classes complexes en classes plus simples. L'indicateur le plus évident est
bien sûr la taille : si une classe est grosse, il y a des chances qu'elle en fasse trop et devrait
être découpée.
Les indices suggérant la reconception d'une classe sont :
- Une instruction switch compliquée : utiliser le polymorphisme
;
- Un grand nombre de méthodes couvrant un large éventail d'opérations
différentes : utiliser plusieurs classes ;
- Un grand nombre de variables membres couvrant des caractéristiques
fondamentalement différentes : utiliser plusieurs classes.
- Eviter les longues listes d'arguments. Les appels de
méthode deviennent alors difficiles à écrire, lire et maintenir. A la place, essayer de déplacer la
méthode dans une classe plus appropriée, et / ou passer des objets en tant
qu'arguments.
- Ne pas se répéter. Si une portion de code est récurrente
dans plusieurs méthodes dans des classes dérivées, mettre ce code dans une méthode dans la classe
de base et l'appeler depuis les méthodes des classes dérivées. Non seulement on gagne en taille de
code, mais de plus les changements seront immédiatement effectifs. De plus, la découverte de ces
parties de code commun peut ajouter des fonctionnalités intéressantes à l'interface de la
classe.
- Eviter les instructions switch ou les if-else
enchaînés. Ceci est typiquement un indicateur de code
vérificateur de type, ce qui implique qu'on choisit le code à exécuter suivant une
information concernant le type (le type exact peut ne pas être évident à première vue). On peut
généralement remplacer ce genre de code avec l'héritage et le polymorphisme ; un appel à une
méthode polymorphique se charge de la vérification de type pour vous, et permet une extensibilité
plus sûre et plus facile.
- Du point de vue de la conception, rechercher et séparer les choses
qui changent des choses qui restent les mêmes. C'est à dire, trouver les éléments du
système qu'on pourrait vouloir changer sans forcer une reconception, puis encapsuler ces éléments
dans des classes. Ce concept est largement développé dans Thinking in Patterns with Java,
téléchargeable à www.BruceEckel.com.
- Ne pas étendre les fonctionnalités fondamentales dans les
sous-classes. Si un élément de l'interface est essentiel dans une classe il doit se
trouver dans la classe de base, et non pas rajouté par dérivation. Si on ajoute des méthodes par
héritage, la conception est peut-être à revoir.
- Moins c'est mieux. Partir d'une interface minimale pour
une classe, aussi restreinte et simple que possible pour résoudre le problème, mais ne pas essayer
d'anticiper toutes les façons dont la classe pourrait être utilisée. Au fur et à mesure
que la classe sera utilisée, on découvrira de nouvelles fonctionnalités à inclure dans l'interface.
Cependant, une fois qu'une classe est utilisée, son interface ne peut être réduite sans perturber
le code des classes clientes. S'il y a besoin d'ajouter de nouvelles méthodes, cela ne pose pas de
problèmes : on ne force qu'une recompilation du code. Mais même si de nouvelles méthodes remplacent
les fonctionnalités d'anciennes méthodes, il ne faut pas toucher à l'interface (on peut toujours
combiner les fonctionnalités dans l'implémentation sous-jacente si on veut). Si on veut étendre
l'interface d'une méthode existante en ajoutant des arguments, créer une méthode surchargée avec
les nouveaux arguments : de cette manière les appels à la méthode existante n'en seront pas
affectés.
- Relire la hiérarchie de classes à voix haute pour s'assurer de sa
logique. Les relations se lisent « est-une » entre classe de base et classe dérivées, et «
a-un » entre classe et objet membre.
- Se demander si on a besoin de surtyper jusqu'au type de base avant
de choisir entre héritage et composition. Préférer la composition (objets membres) à
l'héritage si on n'a pas besoin du transtypage ascendant. Cela permet d'éliminer le besoin d'avoir
de nombreux types de base. Si l'héritage est utilisé, les utilisateurs croiront qu'ils sont
supposés surtyper.
- Utiliser des données membres pour le stockage des valeurs, et des
redéfinitions de fonctions pour des modifications de comportement. Autrement dit, une
classe qui utilise des variables d'état en conjonction avec des méthodes qui modifient leur
comportement suivant la valeur de ces variables devrait être repensée afin d'exprimer les
différences de comportement au sein de classes dérivées et de méthodes redéfinies.
- Utiliser la surcharge. Une méthode ne doit pas se baser
sur la valeur d'un argument pour choisir quelle portion de code exécuter. Si le cas se présente, il
faut créer deux (voire plus) méthodes surchargées.
- Utiliser les hiérarchies d'exceptions - préférablement
dérivées des classes spécifiques appropriées de la hiérarchie standard d'exceptions de Java. La
personne capturant les exceptions peut alors capturer les types spécifiques d'exceptions, suivies
du type de base. Si de nouvelles exceptions dérivées sont ajoutées, le code client continuera de
capturer les exceptions à travers le type de base.
- Un simple agrégat peut suffire pour accomplir le travail.
Dans un avion, le confort des passagers est assuré par des éléments totalement indépendants :
siège, air conditionné, vidéo, etc. et pourtant ils sont nombreux dans un avion. Faut-il créer des
membres privés et construire une nouvelle interface ? Non - dans ce cas, les éléments font partie
de l'interface publique ; il faut donc créer des objets membres publics. Ces
objets ont leur propre implémentation privée, qui reste sûre. Un agrégat n'est pas une solution
fréquemment rencontrée, mais cela arrive.
- Se placer du point de vue du programmeur client et de la personne
maintenant le code. Concevoir les classes afin qu'elles soient aussi évidentes que
possibles à utiliser. Anticiper le type de changements qui seront effectués, et concevoir les
classes afin de faciliter l'introduction de ces changements.
- Surveiller qu'on n'est pas victime du « syndrome de l'objet géant
». Ce syndrome afflige souvent les programmeurs procéduraux nouvellement convertis à la
POO qui se retrouvent à écrire des programmes procéduraux en les encapsulant dans un ou deux
énormes objets. A l'exception des environnements de développement, les objets représentent des
concepts dans l'application et non l'application elle-même.
- Si on doit incorporer une horreur au système, au moins localiser
cette horreur à l'intérieur d'une classe.
- Si on doit incorporer une partie non portable, créer une
abstraction pour ce service et le localiser à l'intérieur d'une classe. Ce niveau
supplémentaire d'abstraction empêche la non-portabilité de s'étendre au reste du programme (cet
idiome est repris par l'image du Pont).
- Les objets ne doivent pas seulement contenir des données.
Ils doivent aussi avoir des comportements bien définis (occasionnellement, des « objets de données
» peuvent être appropriés, mais seulement s'ils sont utilisés pour empaqueter et transporter un
groupe d'articles là où un conteneur plus général ne répondrait pas aux besoins).
- Privilégier la composition lorsqu'on crée de nouvelles classes à
partir de classes existantes. L'héritage ne doit être utilisé que s'il est requis par la
conception. Si l'héritage est utilisé là où la composition aurait suffi, la modélisation deviendra
inutilement compliquée.
- Utiliser l'héritage et la redéfinition de méthodes pour exprimer
les différences de comportement, et des variables pour exprimer des variations dans
l'état. Un exemple extrême de ce qu'il ne faut pas faire est de dériver différentes
classes pour représenter des couleurs plutôt qu'utiliser un champ « couleur ».
- Se méfier de la variance. Deux objets sémantiquement différents peuvent avoir des actions ou des responsabilités
identiques, et il est tentant de faire de l'une une sous-classe de l'autre pour bénéficier de
l'héritage. Ceci est appelé la variance, mais il n'y a aucune raison d'instaurer une
relation superclasse / classe dérivée là où il n'y en a pas. Une meilleure solution est de créer
une classe de base générique qui produise une interface pour les deux classes dérivées - cela
nécessite un peu plus de place, mais on bénéficie toujours de l'héritage, et on va probablement
faire une découverte importante concernant la modélisation.
- Eviter les limitations introduites durant un
héritage. Les conceptions les plus claires ajoutent de
nouvelles capacités à des classes dérivées. Les conceptions suspectes enlèvent des capacités durant
l'héritage sans en ajouter de nouvelles. Mais les règles sont faites pour être transgressées, et si
on travaille avec une ancienne bibliothèque de classes, il peut être plus efficace de restreindre
une classe existante dans la classe dérivée que de restructurer la hiérarchie afin que la nouvelle
classe s'intègre là où elle devrait, c'est à dire au dessus de la vieille classe.
- Utiliser les patrons de conception (design patterns) pour éliminer
les « fonctionnalités non cachées ». C'est à dire que si un seul objet de la classe doit
être créé, ne pas livrer la classe telle quelle à l'application avec un commentaire du genre : « Ne
créer qu'un seul de ces objets. » ; il faut l'encapsuler dans un singleton. Si le programme
principal comporte trop de code embrouillé destiné à créer les objets de l'application, rechercher
un modèle de création, par exemple une méthode propriétaire dans laquelle on pourrait encapsuler la
création de ces objets. Eliminer les « fonctionnalités non cachées » rendra le code non seulement
plus facile à comprendre et maintenir, mais il le blindera aussi contre les mainteneurs bien
intentionnés qui viendront après.
- Eviter la « paralysie analytique ». Se rappeler qu'il
faut avancer dans un projet avant de tout savoir, et que parfois le meilleur moyen d'en apprendre
sur certains facteurs inconnus est de passer à l'étape suivante plutôt que d'essayer de les
imaginer. On ne peut connaître la solution tant qu'on ne l'a pas. Java possède des pare-feux
intégrés ; laissez-les travailler pour vous. Les erreurs introduites dans une classe ou un ensemble
de classes ne peuvent détruire l'intégrité du système dans son ensemble.
- Faire une relecture lorsqu'on pense avoir une bonne analyse,
conception ou implémentation. Demander à une personne extérieure au groupe - pas
obligatoirement un consultant, cela peut très bien être quelqu'un d'un autre groupe de
l'entreprise. Faire examiner le travail accompli par un oeil neuf peut révéler des problèmes durant
une phase où il est plus facile de les corriger, et largement compenser le temps et l'argent «
perdus » pendant le processus de relecture.
