Bundle OSGi osgi-bundles

Usa controllo delle versioni semantiche use-semantic-versioning

Le best practice concordate per la numerazione delle versioni semantiche sono disponibili all’indirizzo https://semver.org/.

Non incorporare più classi e file jar di quanto strettamente necessario nei bundle OSGi do-not-embed-more-classes-and-jars-than-strictly-needed-in-osgi-bundles

Le librerie comuni devono essere suddivise in bundle separati. Questo ne consente il riutilizzo in tutti i bundle. Quando si esegue il wrapping di un JAR in un bundle OSGi, assicurati di controllare le origini online per verificare se qualcuno l’ha già fatto in precedenza. Alcuni luoghi comuni in cui trovare i bundle wrapper esistenti sono: Apache Felix, Apache Sling, Apache Geronimo, Apache ServiceMix, Eclipse Bundle Recipes e SpringSource Enterprise Bundle Repository.

Dipende dalle versioni più basse necessarie del bundle depend-on-the-lowest-needed-bundle-versions

Per le dipendenze in fase di compilazione nei file POM, dipende sempre dalla versione minima necessaria che espone l’API necessaria. Questo consente una maggiore compatibilità con le versioni precedenti e semplifica il backporting delle correzioni per le versioni precedenti.

Esportare un set minimo di pacchetti dai bundle OSGi export-a-minimal-set-of-packages-from-osgi-bundles

Quando un pacchetto è stato esportato, è stata creata un’API da cui gli altri possono dipendere. Assicurati di esportare il meno possibile e assicurati che ciò che viene esportato sia un’API. È molto più facile prendere un metodo/classe privato e renderlo pubblico che prendere qualcosa che è stato precedentemente esportato e renderlo privato.

Posiziona sempre le implementazioni in un percorso separato impl pacchetto. Per impostazione predefinita, il maven-bundle-plugin esporta qualsiasi elemento del progetto che non abbia un impl nel suo nome.

Definisci sempre in modo esplicito una versione semantica per ciascun pacchetto esportato always-explicitly-define-a-semantic-version-for-each-package-exported

Questo consente ai consumatori della tua API di evolversi insieme a te. In questo caso, segui sempre le best practice per il controllo delle versioni semantiche. Questo consente ai consumatori dell’API di sapere quali tipi di modifiche aspettarsi in una nuova versione.

Includi informazioni sul metatipo se esposte include-metatype-information-where-exposed

Specificando informazioni significative sui metatipi, è più facile comprendere i servizi e i componenti nella console Felix. Un elenco di annotazioni e attributi SCR è disponibile all’indirizzo: https://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html.