OSGi包 osgi-bundles

CAUTION
AEM 6.4已结束扩展支持,本文档将不再更新。 有关更多详细信息,请参阅 技术支助期. 查找支持的版本 此处.

使用语义版本控制 use-semantic-versioning

在上可找到语义版本编号的商定最佳实践 https://semver.org/.

请勿嵌入OSGi包中严格需要的类和Jar do-not-embed-more-classes-and-jars-than-strictly-needed-in-osgi-bundles

应将常用库划分为不同的包。 这样,它们便可在包中重复使用。 封装 JAR 在OSGi包中,确保检查在线源以查看是否有人以前已经这样做过。 查找现有包装器的一些常见位置包括:Apache Felix、Apache Sling、Apache Geronimo、Apache ServiceMix、Eclipse包方法和SpringSource企业包存储库。

取决于所需的最低包版本 depend-on-the-lowest-needed-bundle-versions

对于POM文件中的编译时依赖项,始终取决于公开所需API所需的最低版本。 这样可提高向后兼容性,并更轻松地将补丁移入旧版本。

从OSGi包导出一组最小的包 export-a-minimal-set-of-packages-from-osgi-bundles

导出资源包后,我们便立即为其他人员创建了一个API,供其他人员依赖。 确保尽可能少地导出,并确保要导出的内容是API。 采用私有方法/类并将其公开比采用先前导出的内容并将其公开容易得多。

实施应始终放在单独的 impl 包。 默认情况下, maven-bundle-plugin 将导出项目中没有 impl 以它的名称。

始终为导出的每个包显式定义语义版本 always-explicitly-define-a-semantic-version-for-each-package-exported

这将允许您的API消费者与您一起进化。 这样做时,请始终遵循语义版本控制最佳实践。 这样,您的API消费者就可以知道新版本中预期会发生哪些类型的更改。

包括显示的元类型信息 include-metatype-information-where-exposed

通过指定有意义的元类型信息,将使您的服务和组件在Felix控制台中更易于理解。 SCR注释和属性列表可在以下位置找到: https://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html.

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e