标准的 Ark Plugin 需要满足以下规范：

  • 插件必须配置插件名，默认为 ${artifactId} ；运行时，不允许存在同名的插件，可以认为它是 Ark Plugin 的唯一 ID;

  • 插件必须配置优先级，默认为1000，数字越低表示优先级越高；

  • 插件最多配置一个入口类 activator ，它是容器启动插件的入口，统一实现 com.alipay.sofa.ark.spi.service.PluginActivator 接口类；优先级高的插件优先启动；

  • 导入类支持 package 和 class 两个级别；导入类优先从其他的插件加载；

  • 导出类支持 package 和 class 两个级别；优先级高的插件优先导出；

  • 支持导入 classpath 中资源，不支持通配符；优先从其他插件中查找指定资源；

  • 支持导出 classpath 中资源，不支持通配符；优先级高的插件优先导出；

Maven 插件

官方提供 Maven 插件 sofa-ark-plugin-maven-plugin 可以将工程打包成标准格式的 Ark Plugin ； Maven 插件坐标为：

sofa-ark-plugin-maven-plugin 插件提供 goal: ark-plugin，可以将工程打包成标准格式的 Ark Plugin, 如下配置：

  1. <build>
  2.     <plugin>
  3.         <groupId>com.alipay.sofa</groupId>
  4.         <artifactId>sofa-ark-plugin-maven-plugin</artifactId>
  5.         <version>0.2.0</version>
  6.         <executions>
  7.             <execution>
  8.                 <id>default-cli</id>
  9.                 <goals>
  10.                     <goal>ark-plugin</goal>
  11.             </excution>
  12.         </executions>
  13.         <configuration>
  14.             <!-- 配置信息 -->
  15.         </configuration>
  16.     </plugin>

完整配置模板

配置项含义如下：

  • outputDirectory: 指定打包的 ${pluginName}.ark.plugin 存放目录; 默认放在 ${project.build.directory};

  • attach: 是否把 ark plugin 安装、发布到仓库，默认为true;

  • activator: ark plugin 最多仅能指定一个 com.alipay.sofa.ark.spi.service.PluginActivator 接口实现类;

  • priority: 配置优先级，数字越小，优先级越高，优先启动，优先导出类，默认1000;

  • pluginName: 配置插件的名字，务必配置对，运行时，是插件的唯一标识 ID。比如 sofa-rpc 插件，可以配置为 sofa-rpc; 默认为 ${artifactId};

  • imported: 配置导入类、资源；需要注意一点，配置 package 级别的导入类时，如果包名末尾带通配符 *，则表示满足该 package 前缀的包或者类全部被导入。如果不带通配符 *，则表示满足该 package 前缀的类才会被导入，而子包不会被导入。

  • exported: 配置导出类、资源；同样需要注意一点，配置 package 级别的导出类时，如果包名末尾带通配符 *，则表示满足该 package 前缀的包或者类全部被导出。如果不带通配符 *，则表示满足该 package 前缀的类才会被导出，而子包不会被导出。

  • excludes: 打包插件时，排除指定的包依赖；格式为: ${groupId:artifactId} 或者 ${groupIdclassifier}；

  • excludeGroupIds: 打包插件时，排除和指定 groupId 相同的包依赖；

对于普通的 Java 工程，为了生成标准的 Ark Plugin ，只需要三步操作：

  • 在工程根目录中新建一个空模块打包 Ark Plugin，定义插件坐标，假设为：
  1. <dependency>
  2.     <groupId>com.alipay.sofa</groupId>
  3.     <artifactId>sofa-ark-plugin-demo</artifactId>
  4.     <version>1.0.0</version>
  5. </dependency>

  • 在该模块目录或工程根目录中敲击 mvn package 命令，即可在配置的 outputDirectory 目录中生成 ark-plugin-demo.ark.plugin 插件文件；敲击 mvn install 命令，则会安装到本地 Maven 仓库；

发布

在工程主 pom 中配置仓库地址，然后敲击 mvn deploy 命令，即可发布该 Ark Plugin ;需要指出的是，发布的 坐标会带上 classifier = ark-plugin ；如上述构建描述，会生成如下坐标的 Ark Plugin :

其他应用通过该坐标即可引用该插件。

  1. .
  2. │
  3. ├── com
  4. │   └── alipay
  5. │       └── sofa
  6. │           └── ark
  7. │               └── plugin
  8. │                   └── mark
  9. │
  10. ├── META-INF
  11. │   └── MANIFEST.MF
  12. │
  13. ├── conf
  14. │   └── export.index
  15. └── lib
  16.     ├── commons-lang3-3.3.1.jar
  17.     ├── sample-plugin-1.0.0.jar
  18.     └── sample-plugin-common-1.0.0.jar

上述目录结构相关文件和目录说明如下：

  • com/alipay/sofa/ark/plugin/mark ：标记文件，标记该 Jar 包是 sofa-ark-plugin-maven-plugin 打包生成的 Ark Plugin 文件。

  • META-INF/MANIFEST.MF ：记录插件元信息，内容类似如下：

  • conf/export.index ：插件导出类索引文件；为了避免在运行时计算插件 export-packages 下面具体的导出类，在打包生成 Ark Plugin 时，会生成插件所有导出类的索引文件，缩短 Ark Container 解析配置时间。而导入类只需要读取 META-INF/MANIFEST.MF 配置信息，直接比较 import-packages 和 import-classes 前缀即可，无需生成索引文件。

  • : lib 目录存放插件工程依赖的普通 Jar 包，一般包含插件需要和其他插件或者业务有隔离需求的 Jar 包；插件配置的导出类都包含在这些 Jar 包中。