Paquetes OSGI

Usar versiones semánticas

Puede encontrar las mejores prácticas para la numeración semántica en https://semver.org/.

No incruste más clases y tarros que los estrictamente necesarios en los paquetes OSGi

Las bibliotecas comunes deben incluirse en paquetes separados. Esto les permitirá reutilizarlos en sus paquetes. Al ajustar un JAR en un paquete OSGI, asegúrese de comprobar las fuentes en línea para ver si alguien ya ha hecho esto antes. Algunos lugares comunes para encontrar los contenedores existentes son: Apache Felix, Apache Sling, Apache Geronimo, Apache ServiceMix, Eclipse Bundle Recipes y SpringSource Enterprise Bundle Repository.

Depende de las versiones de paquete más bajas necesarias

Para las dependencias de tiempo de compilación en archivos POM, siempre depende de la versión más baja necesaria que expone la API necesaria. Esto permitirá una mayor compatibilidad con versiones anteriores y facilita las correcciones de las versiones anteriores.

Exportar un conjunto mínimo de paquetes de paquetes OSGi

Tan pronto como se exporta un paquete, creamos una API de la que otros pueden depender. Asegúrese de exportar lo menos posible y de que lo que se está exportando es una API. Es mucho más fácil tomar un método o clase privado y hacerla pública que tomar algo que se exportó anteriormente y hacerlo privado.

Las implementaciones siempre deben colocarse en un paquete impl independiente. De forma predeterminada, maven-bundle-plugin exportará cualquier elemento del proyecto que no tenga un impl en su nombre.

Defina siempre explícitamente una versión semántica para cada paquete exportado

Esto permitirá que los consumidores de su API evolucionen junto con usted. Cuando lo haga, siga siempre las optimizaciones semánticas de versiones. Esto permitirá a los consumidores de su API saber qué tipos de cambios se esperan en una nueva versión.

Incluir información de tipo de metatipo cuando se exponga

Al especificar información significativa sobre los tipos de metadatos, sus servicios y componentes serán más fáciles de entender en la consola Felix. Puede encontrar una lista de las anotaciones y los atributos del SCR en: https://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html.