Architecture logicielle

Prise en compte des mises à niveau lors de la conception

Lors de l’extension de comportements prêts à l’emploi, il convient de garder à l’esprit les mises à niveau. Appliquez toujours des personnalisations dans le répertoire /apps et superposez-les au-dessus des nœuds correspondants dans le répertoire /libs ou utilisez sling:resourceSuperType pour étendre le comportement standard. Bien que quelques modifications puissent s’avérer nécessaires pour la prise en charge d’une nouvelle version d’AEM, cette dernière ne devrait normalement pas écraser vos personnalisations si cette pratique est observée.

Réutilisation du modèle et des composants dans la mesure du possible

Outre une maintenance plus simple du code, cela permettra au site de conserver une interface plus cohérente. Lorsqu’un nouveau modèle est nécessaire, veillez à l’étendre à partir d’un modèle de base partagé, de sorte que les exigences globales, telles que l’inclusion de clienlib, puissent être codées à un seul endroit. Lorsqu’un nouveau composant est nécessaire, identifiez les possibilités d’extension depuis un composant existant.

Création de conceptions de modèle

En définissant les composants qui peuvent être inclus dans chaque système de paragraphes sur la page, une homogénéité d’aspect du site peut être gérée. En limitant l’accès à la conception sur les pages, des « super auteurs » peuvent être autorisés à modifier les composants autorisés par page sans l’intervention du développeur, tout en s’assurant que les autres auteurs respectent les normes de l’entreprise.

Développement d’une architecture SOLID

SOLID est un acronyme qui décrit cinq principes architecturaux qu’il convient de respecter :

• ​​Principe de responsabilité unique : chaque module, classe, méthode, etc., ne doit avoir qu’une seule responsabilité.
• ​​Principe ouvert/fermé : les modules doivent être ouverts pour extension et fermés pour modification.
• ​​Principe de substitution Liskov : les types doivent pouvoir être remplacés par leurs sous-types.
• ​​Principe de segmentation de l’interface : aucun client ne doit être contraint à dépendre de méthodes qu’il n’utilise pas.
• ​​Principe d’inversion des dépendances : les modules de haut niveau ne doivent pas dépendre des modules de bas niveau. Les deux doivent dépendre d’abstractions. Les abstractions ne doivent pas dépendre des détails. Les détails doivent dépendre des abstractions.

Vous devez vous efforcer de respecter ces cinq principes pour élaborer un système offrant une stricte séparation des préoccupations.

Observation du principe de robustesse

Le principe de robustesse stipule qu’il faut être tolérant dans ce que l’on accepte, et pointilleux dans ce que l’on envoie. En d’autres termes, lors de l’envoi de messages à un tiers, nous devons nous conformer entièrement aux spécifications, mais lors de la réception de messages d’un tiers, nous devons accepter les messages non conformes tant que la signification du message est claire.

Mise en œuvre de spikes dans leurs propres modules

Les pics et le code de test font partie intégrante de toute implémentation logicielle agile. Cependant, nous souhaitons nous assurer qu’ils ne se retrouvent pas dans le codebase de production sans le niveau de supervision approprié. Il est donc conseillé de créer des spikes dans leurs propres modules.

Mise en œuvre de scripts de migration de données dans leur propre module

En règle générale, les scripts de migration de données, bien qu’il s’agisse de code de production, ne sont exécutés qu’une seule fois au lancement initial d’un site. Par conséquent, dès que le site est en ligne, cela devient du code mort. Pour être sûr de ne pas créer du code d’implémentation qui dépend des scripts de migration, ceux-ci doivent être mis en œuvre dans leur propre module. Cela permet, en outre, de supprimer et de mettre hors service ce code juste après le lancement, et d’éliminer ainsi le code mort du système.

Respect des conventions Maven publiées dans les fichiers POM

Apache a publié des conventions de style à l’adresse https://maven.apache.org/developers/conventions/code.html. Il est conseillé de suivre ces conventions, dans la mesure où elles permettent une mise en route rapide de nouvelles ressources.