Introduction Design patterns

Aujourd’hui, dans le monde Java, il est relativement rare d’écrire une nouvelle fonctionnalité technique. Nous assemblons plutôt des briques déjà faites en se basant sur des frameworks et des librairies open source. De plus en plus, nous essayons d’implémenter des briques fonctionnelles réutilisables afin de mutualiser le plus possible les développements. Il faut donc prendre soin de ne pas réinventer la roue d’une part et d’autre part, il faut s’efforcer de rendre son code réutilisable.

En effet, la maintenabilité du code est un sujet à prendre au sérieux car souvent c’est une équipe qui code et une autre qui fait la maintenance par la suite. Les projets s’inscrivent aussi dans la durée et sur des logiciels d’envergure développés sur plusieurs années, les développeurs ne font qu’une partie de l’application qui sera réutilisée par d’autres. Il faut à la limite considérer son code comme une partie d’un framework plus vaste et réutilisable à volonté. Le code se doit donc d’être modulaire, bien structuré, documenté avec la javadoc (avec des @snippet en Java 18) et doit aussi être testable (et testé).

Nous verrons dans le chapitre Documentation Spring REST Docs qu’il est aussi possible de documenter son code et ses API via des métadonnées...