Ark 容器插件机制

Ark 插件启动

Ark 中提供了插件启动的接口 com.alipay.sofa.ark.spi.service.PluginActivator ，其定义如下：

  1. public interface PluginActivator {
  3.     /**
  4.      * Start Plugin
  5.      * @param context plugin context
  6.      * @throws ArkException
  7.      */
  8.     void start(PluginContext context) throws ArkException;
  10.     /**
  11.      * Stop Plugin
  12.      * @param context
  13.      * @throws ArkException
  14.      */
  15.     void stop(PluginContext context) throws ArkException;
  17. }

插件只需要实现此接口，并在 MANIFEST.MF 中配置 activator 属性，就会在启动时执行 start 方法，停止时执行 stop 方法

Ark 插件通信

Ark 之间的通信是通过服务来完成的， 在上述启动接口方法的入参类型 com.alipay.sofa.ark.spi.model.PluginContext 中提供了发布服务和引用服务的接口

  1. /**
  2.  * Publish Plugin Service
  3.  * @param ifClass service interface
  4.  * @param implObject service implement object
  5.  * @param <T>
  6.  * @return
  7.  */
  8. <T> ServiceReference<T> publishService(Class<T> ifClass, T implObject);
  10. /**
  11.  * Get Service publish by plugin, when there are multiple services, return the highest priority plugin service
  12.  * @param ifClass service interface
  13.  * @param <T>
  14.  * @return service reference
  15.  */
  16. <T> ServiceReference<T> referenceService(Class<T> ifClass);
  18. /**
  19.  * Get Service publish  by one specific plugin
  20.  * @param ifClass service interface
  21.  * @param <T>
  22.  * @param pluginName the name of the plugin which publish the service
  23.  * @return service reference
  24.  */
  25. <T> ServiceReference<T> referenceService(Class<T> ifClass, String pluginName);
  27. /**
  28.  * Get Service List publish by plugin
  29.  * @param ifClass service interface
  30.  * @param <T>
  31.  * @return
  32.  */
  33. <T> List<ServiceReference<T>> referenceServices(Class<T> ifClass);

插件服务是以接口为粒度的，针对同一个接口：

  • 每一个插件只允许发布一个服务，重复发布则会直接返回已经发布服务的引用
  • 当多有个插件发布服务时，若通过 referenceService 引用单个服务
    • 当不指定 pluginName 时，则返回优先级最高的服务
    • 当指定 pluginName 时，则返回该插件发布的服务
      返回的服务引用 ServiceReference 定义如下:
  1. public interface ServiceReference<T> {
  3.     /**
  4.      * get Service Object
  5.      * @return service
  6.      */
  7.     T getService();
  9.     /**
  10.      * get Service Metadata
  11.      * @return
  12.      */
  13.     ServiceMetadata getServiceMetadata();
  15. }
  17. public interface ServiceMetadata {
  19.     /**
  20.      * get Service Unique Name
  21.      * @return service name
  22.      */
  23.     String getServiceName();
  25.     /**
  26.      * get Service Interface Class
  27.      * @return interface class
  28.      */
  29.     Class<?> getInterfaceClass();
  31.     /**
  32.      * get ServiceProvider
  33.      * @return
  34.      */
  35.     ServiceProvider getServiceProvider();
  37. }

其中通过

  • getService() 可以获取到服务的实体 (也即发布服务时的 implObject)
  • getServiceMetadata() 可以获取到服务的元数据信息，包括
    • 服务名：即服务的接口名
    • 服务接口
    • 服务的提供方：包括提供方名字(插件名等)、提供方优先级(插件优先级)

原文: https://alipay.github.io/sofastack.github.io/docs/plugin.html