A.3. 配置捆绑包插件

捆绑包插件需要很少的信息才能正常工作。所有必要属性都使用默认设置来生成有效的 OSGi 捆绑包。

虽然您只能使用默认值创建有效的捆绑包，但您可能需要修改一些值。您可以在插件的 instructions 元素中指定大多数属性。

一些常用的配置属性是：

默认情况下，捆绑包插件将 Bundle-SymbolicName 属性的值设置为 groupId + "." + artifactId，但有以下例外：

要为捆绑包的符号名称指定您自己的值，请在插件的 instructions 元素中添加一个 Bundle-SymbolicName 子级，如 例 A.2 “设置捆绑包的符号名称” 所示。

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
     ...
    </instructions>
  </configuration>
</plugin>

默认情况下，捆绑包的名称设置为 ${project.name}。

要为捆绑包的名称指定您自己的值，请在插件的 instructions 元素中添加一个 Bundle-Name 子对象，如 例 A.3 “设置捆绑包名称” 所示。

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Bundle-Name>JoeFred</Bundle-Name>
     ...
    </instructions>
  </configuration>
</plugin>

默认情况下，捆绑包的版本设置为 ${project.version}。任何短划线(-)替换为点(.)，数字会加到四位。例如，4.2-SNAPSHOT 变为 4.2.0.SNAPSHOT。

要为捆绑包的版本指定您自己的值，请在插件的 instructions 元素中添加一个 Bundle-Version 子对象，如 例 A.4 “设置捆绑包的版本” 所示。

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Bundle-Version>1.0.3.1</Bundle-Version>
     ...
    </instructions>
  </configuration>
</plugin>

默认情况下，OSGi 清单的 Export-Package 列表由您的本地 Java 源代码中的所有软件包填充（在 src/main/java下），除了默认软件包.. 以及包含 .impl 或 .internal 的任何软件包。

默认行为可能会导致软件包非常大，并导出应保持私有的软件包。要更改导出的软件包列表，您可以在插件的 instructions 元素中添加 Export-Package 子子。

Export-Package 元素指定要包含在捆绑包中的软件包列表，以及要导出的软件包列表。可以使用 * 通配符符号指定软件包名称。例如，条目 com.fuse.demo 需要包括以 com.fuse.demo 开头的项目的 classpath 中的所有软件包。

您可以使用 ! 指定要排除的软件包作为前缀。例如，条目 !com.fuse.demo.private 排除软件包 com.fuse.demo.private。

在排除软件包时，列表中条目的顺序非常重要。从开始顺序处理列表，并忽略后续字典条目。

例如，要包含以 com.fuse.demo 开头的所有软件包，软件包 com.fuse.demo.private 除外，请使用以下方法列出软件包：

!com.fuse.demo.private,com.fuse.demo.*

但是，如果您使用 com.fuse.demofuse,!com.fuse.demo.private 列出软件包，那么 com.fuse.demo.private 将包含在捆绑包中，因为它与第一个模式匹配。

如果要在 不 导出捆绑包中指定要包含的软件包列表，您可以在捆绑插件配置中添加 Private-Package 指令。默认情况下，如果您没有指定 Private-Package 指令，则捆绑包中包含本地 Java 源中的所有软件包。

Private -Package 元素的工作方式与您要包含在捆绑包中的软件包列表类似。bundle 插件使用列表来查找要包含在捆绑包中的项目的 classpath 中的所有类。这些软件包打包在捆绑包中，但不会导出（除非它们也由 Export-Package 指令选择）。

例 A.5 “在捆绑包中包含私有软件包” 显示在捆绑包中包含私有软件包的配置

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Private-Package>org.apache.cxf.wsdlFirst.impl</Private-Package>
     ...
    </instructions>
  </configuration>
</plugin>

默认情况下，捆绑包插件使用由捆绑包内容引用的所有软件包列表填充 OSGi 清单的 Import-Package 属性。

虽然默认行为通常足以满足大多数项目，但您可能会找到您想导入没有自动添加到列表中的软件包的实例。默认行为还会导致导入不需要的软件包。

要指定捆绑包要导入的软件包列表，请在插件的 instructions 元素中添加 Import-Package 子级。软件包列表的语法与 Export-Package 元素和 Private-Package 元素的语法相同。

例 A.6 “指定捆绑包导入的软件包” 显示指定捆绑包导入的软件包的配置

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Import-Package>javax.jws, javax.wsdl, org.apache.cxf.bus, org.apache.cxf.bus.spring, org.apache.cxf.bus.resource, org.apache.cxf.configuration.spring, org.apache.cxf.resource, org.springframework.beans.factory.config, * </Import-Package>
     ...
   </instructions>
  </configuration>
</plugin>

有关配置捆绑包插件的更多信息，请参阅：