Lots OSGi

ATTENTION

AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Utilisation du contrôle de version sémantique

Les bonnes pratiques de numérotation de version sémantique sont disponibles à l’adresse https://semver.org/.

N’incorporez pas plus de classes et de fichiers JAR que nécessaire dans les lots OSGi.

Les bibliothèques courantes doivent être prises en compte dans des lots distincts. Cela leur permet d’être réutilisées dans vos lots. Lors de l’encapsulation d’une JAR dans un lot OSGI, veillez à vérifier les sources en ligne pour vérifier si quelqu’un a déjà effectué cette opération auparavant. Voici quelques emplacements courants pour trouver les wrappers de bundle existants : Apache Felix, Apache Sling, Apache Geronimo, Apache ServiceMix, Eclipse Bundle Recipes et le référentiel SpringSource Enterprise Bundle Repository.

Dépendre des versions de lots les plus basses nécessaires

Pour les dépendances au moment de la compilation dans les fichiers POM, utilisez toujours la plus ancienne version possible exposant l’API requise. Cela permet davantage de compatibilité ascendante et facilite les correctifs de rétroportage des versions plus anciennes.

Exportez un ensemble restreint de packages à partir des lots OSGi.

Dès qu’un package est exporté, nous créons une API dont les autres peuvent dépendre. Veillez à exporter le moins possible et à vérifier que ce qui est exporté est une API. Il est beaucoup plus facile de rendre publique une méthode/classe privée que de rendre privé un élément précédemment exporté.

Les mises en œuvre doivent toujours être placées dans un package impl distinct. Par défaut, la variable maven-bundle-plugin exportera tout élément du projet qui n’a pas de impl dans son nom.

Définissez toujours explicitement une version sémantique pour chaque package exporté.

Cela permet aux consommateurs de votre API d’évoluer avec vous. Lorsque vous procédez de la sorte, respectez toujours les bonnes pratiques de contrôle de version sémantique. Cela permet aux consommateurs de votre API de déterminer les types de modifications à attendre dans une nouvelle version.

Incluez les informations de métatype lorsqu’elles sont exposées.

En spécifiant des informations de métatype pertinentes, vos services et composants sont plus faciles à comprendre dans la console Felix. La liste des attributs et annotations SCR peut être trouvée à l’adresse : https://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html.