Ark 扩展机制

编辑
更新时间: 0001-01-01

Ark 容器和 Ark Plugin 在运行时由不同的类加载器加载,不能使用常规的 ServiceLoader 提供 SPI 扩展,SOFAArk 自定义扩展点 SPI 机制, Ark Plugin 实现 SPI 机制,考虑到 Biz 卸载问题,Ark Biz 暂时不支持该 SPI 机制,只适用于 Ark Plugin 之间。

声明扩展接口

使用注解 @Extensible 声明扩展接口,注解定义如下:

@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Extensible {

    /**
     * return specify extensible file name, default value is the
     * full name of interface.
     */
    String file() default "";

    /**
     * return whether this a singleton, with a single, shared instance
     * returned on all calls, default value is true.
     */
    boolean singleton() default true;
}
  • file 用于声明 SPI 扩展文件名,默认为接口全类名
  • singleton 用于声明加载扩展类是否为单例模式

声明扩展实现

使用注解 @Extension 声明扩展实现,注解定义如下:

@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Extension {
    /**
     * extension name
     */
    String value();

    /**
     * extension order, Higher values are interpreted as lower priority.
     * As a consequence, the object with the lowest value has the highest
     * priority.
     */
    int order() default 100;
}
  • value 用于定义扩展实现名称,例如不同的插件扩展同一个接口,可能会取不同的名字。
  • order 用于决定具体扩展实现的生效顺序

运行时,对于同一个接口的扩展实现生效规则如下: + 规则一:名称相同的扩展实现,只会返回优先级高的扩展实现类,order 数字越小,优先级越高 + 规则二:名称不相同的扩展实现,则返回一个对应的 List 列表,每个名称返回优先级最高的扩展实现

加载 SPI 实现类

正常情况下,我们使用 ServiceLoader 加载 SPI 接口实现;SOFAArk 提供了工具类 ArkServiceLoader 用于加载扩展实现,工具类定义了两个简单的方法:

public class ArkServiceLoader {
    private static ExtensionLoaderService extensionLoaderService;

    // 方法一
    public static <T> T loadExtension(Class<T> interfaceType, String extensionName) {
        return extensionLoaderService.getExtensionContributor(interfaceType, extensionName);
    }

    // 方法二
    public static <T> List<T> loadExtension(Class<T> interfaceType) {
        return extensionLoaderService.getExtensionContributor(interfaceType);
    }
}
  • 方法一:用于加载指定接口和名称的扩展实现,返回单个结果。参考上述规则一
  • 方法二:用于加载指定接口的扩展实现,返回列表结果。参考上述规则二

需要注意下,定义 SPI 接口的插件需要导出该接口,负责实现 SPI 接口的插件需要导入该接口。另外 SOFAArk 容器本身也会定义部分用于插件扩展实现的 SPI 接口,例如 ClassLoaderHook

为什么不支持 Biz 的 SPI 扩展实现加载

考虑到 Biz 会动态的安装和卸载,如果支持 Biz 的扩展实现加载,生命周期容易引起混乱,暂时不考虑支持。如果确实存在 Ark Plugin 需要主动触发 Ark Biz 的逻辑调用,可以通过 SOFAArk 内部事件机制。

SOFAArk 默认扩展点

SOFAArk 容器目前提供了唯一一个扩展点 ClassLoaderHook,用于其他插件提供扩展实现,自定义类/资源加载逻辑。ClassLoaderHooker 接口定义如下,用于扩展 BizClassLoader 和 PluginClassLoader 类(资源)加载逻辑:

@Extensible
public interface ClassLoaderHook<T> {

    Class<?> preFindClass(String name, ClassLoaderService classLoaderService, T t)
                                                                                  throws ClassNotFoundException;


    Class<?> postFindClass(String name, ClassLoaderService classLoaderService, T t)
                                                                                   throws ClassNotFoundException;


    URL preFindResource(String name, ClassLoaderService classLoaderService, T t);


    URL postFindResource(String name, ClassLoaderService classLoaderService, T t);


    Enumeration<URL> preFindResources(String name, ClassLoaderService classLoaderService, T t)
                                                                                              throws IOException;

    Enumeration<URL> postFindResources(String name, ClassLoaderService classLoaderService, T t)
                                                                                               throws IOException;
}

通过在插件中扩展该 SPI 接口实现,可以自定义 PluginClassLoader 和 BizClassLoader 的类/资源的加载逻辑。

扩展实现 PluginClassLoader 加载逻辑

定义对 PluginClassLoader 的扩展实现,需要指定 extension 名为 plugin-classloader-hook; 这是因为目前 SOFAArk 的策略只允许一个Plugin ClassLoaderHook 扩展实现生效,如果同时定义多个扩展类,优先级最高的生效。

@Extension("plugin-classloader-hook")
public class TestPluginClassLoaderHook implements ClassLoaderHook<Plugin> {
}

扩展实现 BizClassLoader 加载逻辑

定义对 BizClassLoader 的扩展实现,需要指定 extension 名为 biz-classloader-hook; 理由同上,目前 SOFAArk 的策略只允许一个Biz ClassLoaderHook 扩展实现生效,如果同时定义多个扩展类,优先级最高的生效。

@Extension("biz-classloader-hook")
public class TestBizClassLoaderHook implements ClassLoaderHook<Biz> {
}

ClassLoaderHook 使用案例

这里以 BizClassLoaderHook 为例,来实现 模块中的类委托给基座加载 ,这种可以完全将所有依赖都打在基座(宿主)应用中,模块中可以什么依赖都不带,完全是纯的业务代码;带来的好处是,一个模块最终打出的包大小会非常小,在动态操作模块时,可以极大的提高性能。

例如有一个 sofa-dashboard-ark-facade 包,这个包本身就是由宿主应用提供,那么模块在引入这个包时就可以不再需要将 sofa-dashboard-ark-facade 打在自己的 biz 包里面。 这里将 sofa-dashboard-ark-facade 的 dependency 的 scope 改为 provided,使得打包时,不将 sofa-dashboard-ark-facade 打到模块 biz 中。然后通过 ClassLoaderHook 机制将 sofa-dashboard-ark-facade 包中提供的类委托给宿主来加载。具体过程如下:

<dependency>
    <groupId>com.glmapper.bridge.boot</groupId>
    <artifactId>sofa-dashboard-ark-facade</artifactId>
    <!-- sofa-dashboard-ark-facade 不打包进去,使用宿主里面提供的-->
    <scope>provided</scope>
</dependency>

在模块中提供 hook 实现

在模块代码中新建一个 DelegateMasterBizClassLoaderHook 类,如下:

@Extension("biz-classloader-hook")
public class DelegateMasterBizClassLoaderHook implements ClassLoaderHook<Biz> {

    @Override
    public Class<?> preFindClass(String name, ClassLoaderService classLoaderService, Biz biz) throws ClassNotFoundException {
        return null;
    }

    @Override
    public Class<?> postFindClass(String name, ClassLoaderService classLoaderService, Biz biz) throws ClassNotFoundException {
        // 按包名组织
        if (name.startsWith("io.sofastack.ark.biz.facade")){
            ClassLoader masterBizClassLoader = ArkClient.getMasterBiz().getBizClassLoader();
            return bizClassLoader.loadClass(name);
        }
        return null;
    }

    @Override
    public URL preFindResource(String name, ClassLoaderService classLoaderService, Biz biz) {
        // 资源也要委托
        if (name.startsWith("io/sofastack/ark/biz/facade")) {
            ClassLoader masterBizClassLoader = ArkClient.getMasterBiz().getBizClassLoader();
            try {
                return bizClassLoader.getResource(name);
            } catch (Exception e) {
                return null;
            }
        }
        return null;
    }

    @Override
    public URL postFindResource(String name, ClassLoaderService classLoaderService, Biz biz) {
        return null;
    }

    @Override
    public Enumeration<URL> preFindResources(String name, ClassLoaderService classLoaderService, Biz biz) throws IOException {
        if (name.startsWith("io/sofastack/ark/biz/facade")){
           ClassLoader masterBizClassLoader = ArkClient.getMasterBiz().getBizClassLoader();
            try {
                return bizClassLoader.getResources(name);
            } catch (Exception e) {
                return null;
            }
        }
        return null;
    }

    @Override
    public Enumeration<URL> postFindResources(String name, ClassLoaderService classLoaderService, Biz biz) throws IOException {
        return null;
    }
}

在 resources 目录下添加 /META-INF/services/sofa-ark/ 目录,再在 /META-INF/services/sofa-ark/ 添加一个 名为 com.alipay.sofa.ark.spi.service.classloader.ClassLoaderHook 的文件,文件里面内容为 hook 类的全限定名:

io.sofastack.ark.biz.provider.hooks.DelegateMasterBizClassLoaderHook

重新打包,打包之后验证下模块 biz 包,里面已经没有 sofa-dashboard-ark-facade 包,然后重新验证下执行是否正常。

SOFAArk ClassLoaderHook 的默认实现 DelegateToMasterBizClassLoaderHook

ClassLoaderHook 从 sofa-ark 0.6 版本就已经提供了,其主要目的是用户可以通过自定义 ClassLoaderHook 来控制 class 和 resources 的加载。在 2.0.1 版本中,sofaark 框架内部提供了一个默认得到 ClassLoaderHook 实现 DelegateToMasterBizClassLoaderHook,用于在模块 biz 在 load 不到 classes 或者 resourcecs 时,尝试从宿主 biz 去 load 相应的 classes 和 resources。

通过 plugin 提供 hook 实现

不支持,会出现循环应引用问题。模块 BizClassLoader getResources 过程描述:

1、preFindResource: 当前模块没有实现 hook,所以 preFindResource 不会执行,返回是 null 2、getInternalResouces 3、getJdkResource: 加载不到 4、getExportResource: 这里会尝试使用插件 pluginClassLoader 来加载 5、pluginClassLoader.getResources 6、preFindResource: 这里委托给宿主 bizClassLoader 加载,bizClassLoader.getResources -> getInternalResouces->getExportResource->pluginClassLoader.getResources->hook preFindResource -> 委托给宿主 bizClassLoader 加载 -> ….