Skip to content

高级特性

Jump to bottom
Joe edited this page May 31, 2018 · 8 revisions

JarsLink框架还支持一些高级特性，后续会逐渐提供出来。

注解的使用

新版本加入了注解的支持，用户只需要在构建ModuleConfig的时候调用ModuleConfig.addScanPackage(String)方法即可，可以多次调用该方法来添加多个扫描包配置，该配置会被spring用来作为扫描包配置。

注解开启后的一些注意事项

  • 开启注解后如果想要同时使用xml定义bean，与在普通spring项目中一样，只需要有一个配置类（该类需要在spring的扫描路径中），即注解为@Configuration的类，然后在该类上注解@ImportResource("你的spring bean定义xml文件位置")即可，需要注意的是，由于此种方式限于spring的实现，xml中定义的bean不能依赖于注解定义的bean，而注解定义的bean则可以依赖于xml中定义的bean。
  • 如过通过注解的方式定义了一个name值与xml中name值相同的bean，那么注解定义的bean将会被xml中定义的bean所取代。

可以实现但是不推荐使用的

如果注解中依赖的bean在运行时不存在（也就是该bean是在maven中引入模块的，但是设置的scope是test或者provide等会在编译期排除掉的），那么此时可以在父容器中定义一个相同的bean，此时该模块A依然可以使用该bean。描述如下：

  1. 模块A依赖于其他jar包中的bean B；
  2. 打包时该jar包被剔除或者打包后被删除；
  3. 父容器中提供一个与bean B相同定义的bean C；
  4. 模块A在父容器中运行依然可以透明的使用bean B（其实此时是bean C提供的功能）

那如果父容器和模块中同时定义了相同的bean呢？此时模块中仍然会使用本模块的bean而不会使用父容器中的bean。

如果不是必要的情况下请不要使用该功能

什么时候应该优先使用注解加载

如果模块项目中存在这样的情况：要引入的依赖jar包中存在spring bean的xml文件，位置和模块项目中的一致，并且该xml文件是不需要的，那么此时使用xml的方式加载是无法排除该文件的，xml文件中的bean仍然会被加载，而使用注解的方式加载则不会存在该问题（注解其实也有，如果扫描的包名一致的话也会出现类似问题，但是正常来说包名是不会与第三方jar包一致的）。

多版本注册功能

如何使用多版本功能

1.6.1版本支持同时注册多个版本，该功能默认关闭，如果需要开启那么可以使用ModuleConfig.setNeedUnloadOldVersion(false)来开启多版本功能。开启后ModuleManager的register(Module)方法将可以注册同一模块的多个版本，不开启则后注册的会替换新注册的模块。

已知问题

1.6.1版本的ModuleManager默认实现存在并发问题，即使开启多版本功能，如果某个模块在第一次注册时同时两个线程或者多个线程注册，那么此时有可能会丢失一些模块，也就是有可能会有一个或多个模块注册失败。该问题将在下个版本修复。

该问题只在该模块第一次注册时会出现该问题，如果之前已经注册过该模块之后并发注册则不会有该问题。

示例代码

开启注解

    ModuleLoader moduleLoader = null;
    ModuleManager moduleManager = null;
    ModuleConfig config = new ModuleConfig();
    //*************
    //配置config的其他选项
    //*************
    config.addScanPackage("com.alipay");
    //使用此配置加载Module将会递归扫描jar包中所有com.alipay目录下的class
    Module module = moduleLoader.load(config);

使用多版本注册功能

    ModuleConfig config = new ModuleConfig();
    //*************
    //配置config的其他选项
    //*************
    config.withName("demo").withVersion("1.0").withNeedUnloadOldVersion(false);
    Module module = moduleLoader.load(config);
    moduleManager.register(module);
    config.withName("demo").withVersion("2.0").withNeedUnloadOldVersion(false);
    module = moduleLoader.load(config);
    moduleManager.register(module);
    //此处该module的版本号为2.0，后注册的module会被设置为默认module
    module = moduleManager.find("demo");
    //通过指定版本号可以获取到之前注册的（因为2.0版本配置了允许存在多个版本的module，所以此时1.0版本的仍然能被找到）
    module = moduleManager.find("demo" , "1.0");

多版本注册功能细节说明（实现机制）

如果查看源码可以得知，needUnloadOldVersion选项只在本次注册中有效，也就是如果当前注册的模块配置允许存在多版本，那么即使之前的模块是不允许存在多版本也会忽略，仅仅使用本次注册的模块的配置，反之，如果之前模块允许多版本存在，但是当前注册的模块不允许，那么就会将之前的卸载了。当前注册的模块不允许多版本存在时系统会如何卸载模块呢？如果当前注册的模块不允许存在多版本时只会将之前的默认版本模块删除，并不会删除其他模块。详情请看下列示例。

    ModuleConfig config = new ModuleConfig();
    //*************
    //配置config的其他选项
    //*************
    config.withName("demo").withVersion("1.0").withNeedUnloadOldVersion(true);
    Module module = moduleLoader.load(config);
    moduleManager.register(module);
    config.withName("demo").withVersion("2.0").withNeedUnloadOldVersion(false);
    module = moduleLoader.load(config);
    moduleManager.register(module);

上面这个例子最后系统将存在1.0版本和2.0版本的模块

    ModuleConfig config = new ModuleConfig();
    //*************
    //配置config的其他选项
    //*************
    config.withName("demo").withVersion("1.0").withNeedUnloadOldVersion(true);
    Module module = moduleLoader.load(config);
    moduleManager.register(module);
    config.withName("demo").withVersion("2.0").withNeedUnloadOldVersion(false);
    module = moduleLoader.load(config);
    moduleManager.register(module);

上面这个例子最后系统将只存在2.0版本，1.0版本在2.0版本注册时将会被卸载。

    ModuleConfig config = new ModuleConfig();
    //*************
    //配置config的其他选项
    //*************
    config.withName("demo").withVersion("1.0").withNeedUnloadOldVersion(true);
    Module module = moduleLoader.load(config);
    moduleManager.register(module);
    moduleManager.activeVersion("demo", "1.1");
	
    config.withName("demo").withVersion("2.0").withNeedUnloadOldVersion(false);
    module = moduleLoader.load(config);
    moduleManager.register(module);

上面这个例子最后仍然会同时存在1.0和2.0两个版本，因为1.0版本注册后系统将默认demo模块的默认版本切换到了一个不存在的1.1版本，当2.0版本的demo模块注册时，虽然2.0版本配置的不允许存在多个版本存在，会将此时的默认版本卸载，但是此时demo模块的默认版本是一个不存在的1.1，所以并不会有实际的版本会被卸载，1.0也因此保留了下来。

模块间调用功能

模块间调用功能存在1.7版本，当前仅支持使用注解的方式注入

模块间调用功能依赖于jarslink-inject项目，如果要启动模块间调用，，在模块项目和父容器项目的maven依赖中增加如下依赖：

<dependency>
    <groupId>com.alipay.jarslink.support</groupId>
    <artifactId>jarslink-inject</artifactId>
    <version>1.0.0.20180403</version>
</dependency>

注意：当前jarslink-inject项目暂时没有上传中央仓库，如果需要使用模块间调用功能请先clone代码到本地，然后切换到分支1.7.0.20180401，先把jarslink-api项目打包安装到本地，最后把jarslink-inject项目打包安装到本地。

当需要引入一个其他模块暴露出来的Action时，只需要像引入spring的bean一样引入即可，不同的是引入Action需要专门的注解@ActionReference，该注解在jarslink-inject项目中。

在模块中按照下列示例注入其他模块的Action：

@ActionReference(moduleName = "demo-b", version = "1.0", name = "action-b")
private Action<String, String> bAction;

其中moduleName为要引入的Action所在的模块名，version为要引入的Action所在的模块的版本号，name为Action的名字，除了该方法外也可以通过set方法注入，详情参照spring bean的注入。

除了上述操作还需要在父容器中进行如下操作才能实现模块间调用：

ApplicationContextAware aware = new ApplicationContextAwareImpl(moduleManager);
moduleLoader.registerAware(aware);

需要创建一个ApplicationContextAwareImpl然后注册到moduleLoader后才能使用模块间调用功能。

必须在加载模块前注册ApplicationContextAware方可生效，注册ApplicationContextAware前加载的模块无法使用模块间调用功能，也就是无法注入其他模块的Action

模块间调用功能使用注意事项

  • Action的注入只能在spring管理的bean中注入，直接new出来的对象或者其他方式得到的对象无法注入。
  • 当前调用时传入Action的参数没有经过深克隆，也就是会直接将引用传入其他Action，存在其他Action更改该引用值的风险。
Clone this wiki locally