Utilisation de préfixes spécifiques au projet dans les noms d'artefacts

Vous devez ajouter un préfixe à tous les noms d'artefacts source (classes de modèles, fichiers source, messages, fichiers messages, etc.) en utilisant un acronyme ou une abréviation. Utilisez toujours le même acronyme ou la même abréviation. Au cours du projet, les ajouts aux artefacts principaux seront ainsi plus évidents. Cette distinction est très utile lorsque l'effort de développement grandit. En général, la plupart des projets sont décrits par des acronymes. Les acronymes sont parfaits comme préfixes.

L'utilisation d'un préfixe spécifique à un projet permet d'éviter tout conflit de noms entre les nouveaux artefacts que vous ajoutez et les nouveaux artefacts que Cúram ajoute ; les conflits de noms peuvent être coûteux et difficiles à corriger.

Par exemple, vous utilisez un module de mise à jour et vous découvrez que l'un de vos ajouts de zones de base de données personnalisées porte le même nom qu'une nouvelle zone d'application n'ayant pas les mêmes significations commerciales ou types de données. Sinon, vous utilisez un module de mise à jour et vous découvrez qu'une nouvelle application Elément de table de codes a été ajoutée et qu'elle est en conflit avec un élément personnalisé que vous avez ajouté et nommé de la même manière, mais avec une autre signification. Ces types de conflits peuvent être évités en vous assurant toujours de nommer les nouveaux artefacts personnalisés avec un préfixe cohérent.

Certains types d'artefacts possèdent plusieurs identificateurs, et cela doit être pris en compte lors du nommage. Les classes Entity et les éléments de tables de codes sont dans ce cas. Une classe Entity personnalisée possède un nom de table, qui partage le même espace de nom non hiérarchique (schéma de base de données) que les tables d'application, et doit comporter un nom de table unique dans cet espace de nom. Elle possède également un nom de classe Java, qui partage un espace de nom hiérarchique (structure de package) avec les classes Java de l'application. De même, un élément de table de codes personnalisé possède une valeur et un identificateur Java, qui partagent un espace de nom non hiérarchique avec les éléments d'application de la même table de codes.

Il est important de noter que l'utilisation de préfixes spécifiques au projet ne s'applique pas lorsque vous remplacez un artefact d'application, car le mécanisme de remplacement est généralement basé sur le fait que le nom de votre artefact personnalisé est exactement le même que celui de l'artefact d'application qu'il remplace.

Remarques supplémentaires :

Remarque : En plus des artefacts source, il est également important de prendre en compte les valeurs d'identificateurs pouvant entrer en conflit avec les valeurs utilisées par IBM.

Les API TransactionInfo.setFacadeScopeObject et TransactionInfo.getFacadeScopeObject permettent aux développeurs d'accéder aux objets associés à la transaction en cours. Lors de l'utilisation de cette API, pour garantir que les données de la transaction n'entrent pas en conflit avec les données appartenant à IBM, vous devez utiliser String comme identificateur d'objet et choisir un mot approprié comme préfixe pour cette chaîne, comme décrit ci-dessus.