导读:JarsLink是一个基于JAVA的模块化开发框架,它提供在运行时动态加载模块(JAR包)、卸载模块和模块间调用的API,它能够帮助你进行模块化开发,也能帮助你的系统在运行时动态添加新功能,减少编译、打包和部署带来的发布耗时,同时它也是阿里巴巴的开源项目之一,目前在蚂蚁金服微贷事业群各团队广泛使用。
开源地址:https://github.com/alibaba/jarslink
需求背景:
- 应用拆分的多或少都有问题。多则维护成本高,每次发布一堆应用。少则拆分成本高,无用功能很难下线。
- 故障不隔离。当一个系统由多人同时参与开发时,修改A功能,可能会影响B功能,引发故障。
- 多分支开发引发冲突。多分支开发完之后合并会产生冲突。
- 牵一发动全身。一处核心代码的改动,或一个基础Jar的升级需要回归整个系统。
- 升级和迁移成本高。中间件升级每个应用都有升级成本。
模块化开发的好处
- 可插拔,一个应用由多个模块组成,应用里的模块可拆和合,模块可快速在多个系统中迁移和部署。
- 模块化开发,模块之间互相隔离,实现故障隔离。
- 一个模块一个分支,不会引发代码冲突。
- 在模块中增加或修改功能,只会影响当前模块,不会影响整个应用。
- 动态部署,在运行时把模块部署到应用中,快速修复故障,提高发布效率。
- 多版本部署,可以在运行时同时部署某个模块的新旧版本,进行AB TEST。
- 减少资源消耗,通过部署模块的方式减少应用数量和机器数量。
JarsLink的应用场景
- 数据管理中心,如果你需要开发一个数据管理系统,这个系统需要去不同的异构系统采集数据,这些系统会提供不同类型的接口,如RPC,HTTP等。并且数据采集的数据源多,每种数据源都需要对接和开发,数据质量比较差,需要经常修改代码进行发布。在这种场景下,通过模块化开发,实现一个数据源使用一个模块进行对接,上线新数据源只需要新增模块,修改BUG只需要修改某个模块,并能快速上线。
- 后台管理系统,互联网应用发展到一定阶段会出现很多后台需求,如客服查询用户的信息帮助解答问题,开发查后台数据排查系统BUG,运营使用后台功能发送运营活动等。这些功能发布频率会大于核心系统,如果放在核心系统里会影响其稳定性,所以我们必须要建一个后台系统来开发后台功能,但是这样又带来一个新的问题,很多开发都会来这个系统进行开发,拉多分支造成代码冲突,A业务的BUG影响到B业务。所以如果每个业务线一个模块,每个模块使用一个单独的分支进行开发,就能进行隔离开发,提高开发速度,开发完后在运行时加载到系统中。
- 微服务集成测试, 目前一个微服务是一个FAT JAR,如果有几十个微服务,则需要启动很多进程,DEBUG端口会很多,使用JarsLink框架合并FAT JAR,再路由请求到其他JAR,就可以只启动一个进程进行DEBUG测试。
- 指标计算系统,可以把消息转发到不同的模块中进行处理,并输出指标。
目前蚂蚁金服微贷事业部几个系统和几十个模块已经使用JarsLink框架。
JarsLink的应用场景
隔离性
- 类隔离:框架为每个模块的Class使用单独的ClassLoader来加载,每个模块可以依赖同一种框架的不同的版本。
- 实例隔离:框架为每个模块创建了一个独立的Spring上下文,来加载模块中的BEAN,实例化失败不会影响其他模块。
资源隔离:后续会支持模块之间的资源隔离,每个模块使用独立的CPU和内存资源。
动态性类隔离:动态发布:模块能在运行时动态加载到系统中,实现不需要重启和发布系统新增功能。支持突破双亲委派机制,在运行时加载父加载器已经加载过的类,实现模块升级依赖包不需要系统发布。
- 动态卸载:模块能在运行时被动态卸载干净,实现快速下线不需要功能。
易用性
- 提供了通用灵活的API让系统和模块进行交互。
实现原理
模块加载
- JarsLink为每个模块创建一个新的URLClassLoader来加载模块。并且支持突破双亲委派,设置了overridePackages的包将由子类加载进行加载,不优先使用父类加载器已加载的。
模块的卸载
卸载模块需要满足三个条件:
- 模块里的实例对象没有被引用
- 模块里的Class没有被引用
- 类加载器没有被引用
所以需要做到三点卸载实例,卸载类和卸载类加载器,整个模块的卸载顺序如下:
- 关闭资源:关闭HTTP连接池或线程池。
- 关闭IOC容器:调用applicationContext.close()方法关闭IOC容器。
- 移除类加载器:去掉模块的引用。
- 卸载JVM租户(开发中):卸载该模块使用的JVM租户,释放资源。
模块间隔离
模块化开发需要解决隔离性问题,否则各模块之间会互相影响。模块之间的隔离有三个层次:
- 类隔离:为每个模块创建一个类加载器来实现类隔离。
- 实例隔离:为每个模块创建一个新的IOC容器来加载模块里面的BEAN。
- 资源隔离:对每个模块只能使用指定的CPU和内存。
目前JarsLink实现了类隔离和实例隔离,资源隔离准备引入ALIJVM多租户来解决。
模块间通讯
模块之间的通讯也有三种方式,RPC,本地调用,深克隆/反射。
- 本地调用:目前JarsLink的doAction就是使用的这种通讯方式,这种方式要求模块的类加载器是父子关系,且IOC容器也是父子容器。
- RPC调用:用于跨JVM的模块之间调用,利用SOFA 4动态API在模块中发布和引用TR服务来实现。
- 深克隆/反射:深克隆其他模块的入参,反射其他模块的方法实现调用。
类加载机制
OSGI类加载机制的关系采用的是网状结构,每个模块通过 Export-Package 来声明我要给别人用哪些类,通过 Import-Package来声明我要用别人的哪些类。JarsLink采用扁平化管理,每个模块都有一个共同的父类,这个父类加载器就是加载ModuleLoader类的加载器,如果是SOFA应用,模块的父加载器是KernelAceClassLoader,类加载器关系如下:
如果所有模块都需要使用的类,可以通过KernelAceClassLoader加载,如果是SOFA系统可以通过POM引入。
JarsLink框架类图
JarsLink框架的类图如下:
- AbstractModuleRefreshScheduler:入口类,负责定期扫描本地和内存中的模块是否发生变更,如果变更,则更新模块。
- ModuleLoader:模块加载引擎,负责模块加载。
- ModuleManager:模块管理者,负责在运行时注册,卸载,查找模块和执行Action。
- Module:模块,一个模块有多个Action。
- Action:模块里的执行者。
如何使用?
1:引入POM
2:引入jarslink BEAN
系统中引入以下两个BEAN。
<!-- 模块加载引擎 -->
<bean name="moduleLoader" class="com.alipay.jarslink.api.impl.ModuleLoaderImpl"></bean>
<!-- 模块管理器 -->
<bean name="moduleManager" class="com.alipay.jarslink.api.impl.ModuleManagerImpl"></bean>
<!-- 模块服务 -->
<bean name="moduleService" class="com.alipay.jarslink.api.impl.ModuleServiceImpl">
<property name="moduleLoader" ref="moduleLoader"></property>
<property name="moduleManager" ref="moduleManager"></property>
</bean>
3:集成JarsLink API
使用JarsLink API非常简单,只需要继承AbstractModuleRefreshScheduler,并提供模块的配置信息,代码如下:
package com.alipay.jarslink.api.impl;
import com.alipay.jarslink.api.ModuleConfig;
import java.util.List;
/**
* 模块刷新调度器
*
* @author tengfei.fangtf
* @version $Id: AbstractModuleRefreshSchedulerImpl.java, v 0.1 2017年07月21日 2:50 PM tengfei.fangtf Exp $
*/
public class AbstractModuleRefreshSchedulerImpl extends AbstractModuleRefreshScheduler {
private List<ModuleConfig> moduleConfigs;
@Override
public List<ModuleConfig> queryModuleConfigs() {
return moduleConfigs;
}
public void setModuleConfigs(List<ModuleConfig> moduleConfigs) {
this.moduleConfigs = moduleConfigs;
}
}
这个调度器在bean初始化的时候会启动一个调度任务,每分钟刷新一次模块,如果模块的版本号发生变更则会更新模块。实现这个方法时,必须把模块(jar包)下载到机器本地,模块的配置信息说明如下:
- name:全局唯一,建议使用英文,忽略大小写。
- enabled:当前模块是否可用,默认可用,卸载模块时可以设置成false。
- version:模块的版本,如果版本号和之前加载的不一致,框架则会重新加载模块。
- Properties:spring属性配置文件。
- moduleUrl:模块的本地存放地址。
- overridePackages:需要突破双亲委派的包名,一般不推荐使用,范围越小越好,如com.alipay.XX。
你也可以使用API来加载并注册模块,详细使用方式可以参考ModuleManagerTest,代码如下。
/*
*/
package com.alipay.jarslink.api.impl;
import com.alipay.jarslink.api.Module;
import com.alipay.jarslink.api.ModuleManager;
import com.alipay.jarslink.api.Action;
import com.alipay.jarslink.api.ModuleConfig;
import com.alipay.jarslink.api.ModuleLoader;
import com.google.common.collect.ImmutableList;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
/**
* 模块加载和执行测试
*
* @author tengfei.fangtf
* @version $Id: ModuleManagerTest.java
*
* v 0.1 2017年06月20日 3:24 PM tengfei.fangtf Exp $
*
* */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath*:META-INF/spring/jarslink.xml"})
public class ModuleManagerTest {
@Autowired
private ModuleManager moduleManager;
@Autowired
private ModuleLoader moduleLoader;
@Test
public void shouldLoadModule() {
//1:加载模块
Module module = loadModule();
Assert.assertNotNull(module);
Assert.assertNotNull(module.getCreation());
Assert.assertNotNull(module.getChildClassLoader());
//卸载模块
module.destroy();
Assert.assertNotNull(module.getChildClassLoader());
}
@Test
public void shouldRegisterModule() throws MalformedURLException {
//2:注册模块
Module module = loadModule();
Module removedModule = moduleManager.register(module);
Assert.assertNull(removedModule);
//3:查找模块
Module findModule = moduleManager.find(module.getName());
Assert.assertNotNull(findModule);
Assert.assertNotNull(moduleManager.getErrorModuleContext());
Assert.assertEquals(1, moduleManager.getModules().size());
Module remove = moduleManager.remove(module.getName());
Assert.assertNull(moduleManager.find(remove.getName()));
Assert.assertEquals(0, moduleManager.getModules().size());
}
@Test
public void shouldDoAction() {
Module findModule = loadModule();
Module removedModule = moduleManager.register(findModule);
//4.1:查找和执行Action
String actionName = "helloworld";
ModuleConfig moduleConfig = new ModuleConfig();
moduleConfig.setName("h");
moduleConfig.setEnabled(true);
ModuleConfig result = findModule.doAction(actionName, moduleConfig);
Assert.assertEquals(1, findModule.getActions().size());
Assert.assertNotNull(result);
Assert.assertEquals(result.getName(), moduleConfig.getName());
Assert.assertEquals(result.getEnabled(), moduleConfig.getEnabled());
//4.2:查找和执行Action
Action<ModuleConfig, ModuleConfig> action = findModule.getAction(actionName);
Assert.assertNotNull(action);
result = action.execute(moduleConfig);
Assert.assertNotNull(result);
Assert.assertEquals(result.getName(), moduleConfig.getName());
Assert.assertEquals(result.getEnabled(), moduleConfig.getEnabled());
//卸载模块
moduleManager.remove(findModule.getName());
}
/**
* 构建模块配置信息
*/
public static ModuleConfig buildModuleConfig() {
return buildModuleConfig(true);
}
public static ModuleConfig buildModuleConfig(boolean enabled) {
URL demoModule = Thread.currentThread().getContextClassLoader().getResource("jarslink-module-demo-1.0.0.jar");
ModuleConfig moduleConfig = new ModuleConfig();
moduleConfig.setName("demo");
moduleConfig.setEnabled(enabled);
moduleConfig.setOverridePackages(ImmutableList.of("com.alipay.jarslink.demo"));
moduleConfig.setVersion("1.0.0.20170621");
Map<String, Object> properties = new HashMap();
properties.put("url", "127.0.0.1");
moduleConfig.setProperties(properties);
moduleConfig.setModuleUrl(ImmutableList.of(demoModule));
return moduleConfig;
}
private Module loadModule() {return moduleLoader.load(buildModuleConfig());}
}
3:开发模块
在模块中只需要实现并开发Action,代码如下:
package com.alipay.jarslink.demo;
import com.alipay.jarslink.api.Action;
import com.alipay.jarslink.api.ModuleConfig;
/**
* 一个简单的Action实现
*
*/
public class HelloWorldAction implements Action<ModuleConfig, ModuleConfig> {
@Override
public ModuleConfig execute(ModuleConfig actionRequest) {
ModuleConfig moduleConfig = new ModuleConfig();
moduleConfig.setName(actionRequest.getName());
moduleConfig.setEnabled(actionRequest.getEnabled());
moduleConfig.setVersion(actionRequest.getVersion());
moduleConfig.setModuleUrl(actionRequest.getModuleUrl());
moduleConfig.setProperties(actionRequest.getProperties());
moduleConfig.setOverridePackages(actionRequest.getOverridePackages());
return moduleConfig;
}
@Override
public String getActionName() {
return "helloworld";
}
}
5:调用接口
开发者需要利用JarsLink API把请求转发给模块,先根据模块名查找模块,再根据aciton name查找Action,最后执行Action。
@Test
public void shouldAddModule() {
//装载模块
abstractModuleRefreshSchedulerImpl.setModuleConfigs(ImmutableList.of(ModuleManagerTest.buildModuleConfig()));
Assert.assertEquals(1, abstractModuleRefreshSchedulerImpl.queryModuleConfigs().size());
abstractModuleRefreshSchedulerImpl.run();
Module demo = moduleManager.find("demo");
Assert.assertNotNull(demo.getAction("helloworld"));
修改模块
//ModuleConfig moduleConfig = ModuleManagerTest.buildModuleConfig(false);
//moduleConfig.setVersion("1.1");
//abstractModuleRefreshSchedulerImpl.queryModuleConfigs().add(moduleConfig);
//abstractModuleRefreshSchedulerImpl.run();
//卸载模块
abstractModuleRefreshSchedulerImpl.setModuleConfigs(new ArrayList<ModuleConfig>());
Assert.assertEquals(0, abstractModuleRefreshSchedulerImpl.queryModuleConfigs().size());
abstractModuleRefreshSchedulerImpl.run();
Assert.assertNull(moduleManager.find("demo"));
}
其他特性
通过moduleConfig的Properties属性可以设置Spring bean变量的配置信息。
最佳实践
HTTP请求转发
消息请求转发
可以把消息转发给模块进行处理。遵循默认大于配置的方式,你可以把TOPIC当做模块名,EventCode当做ActionName来转发请求。
接口说明
JarsLink框架最重要的两个接口是ModuleManager和ModuleLoader。
ModuleManager接口
/*
* * Copyright 1999-2018 Alibaba Group Holding Ltd
*/
package com.alipay.jarslink.api;
import java.util.List;
import java.util.Map;
/**
* 模块管理者, 提供注册,移除和查找模块能力
*
* @author tengfei.fangtf
* @version $Id: ModuleManager.java, v 0.1 2017年05月30日 2:55 PM tengfei.fangtf Exp $
*/
public interface ModuleManager {
/**
* 根据模块名查找Module
* @param name
* @return
*/
Module find(String name);
/**
* 获取所有已加载的Module
*
* @return
*/
List<Module> getModules();
/**
* 注册一个Module
*
* @param module 模块
* @return 旧模块,如果没有旧模块则返回null
*/
Module register(Module module);
/**
* 移除一个Module
*
* @param name 模块名
* @return 被移除的模块
*/
Module remove(String name);
/**
* 获取发布失败的模块异常信息
*
* @return key:模块名,value:错误信息
*/
Map<String, String> getErrorModuleContext();
}
现实类
/*
* * Copyright 1999-2018 Alibaba Group Holding Ltd
*/
package com.alipay.jarslink.api.impl;
import com.alipay.jarslink.api.Module;
import com.alipay.jarslink.api.ModuleManager;
import com.google.common.collect.ImmutableList;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.DisposableBean;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Predicates.instanceOf;
import static com.google.common.collect.Iterables.filter;
/**
* 模块管理,包含获取模块,执行模块里的方法
*
* @author tengfei.fangtf
*
*/
public class ModuleManagerImpl implements ModuleManager, DisposableBean {
private static final Logger LOGGER = LoggerFactory
.getLogger(ModuleManagerImpl.class);
/**
* 运行时模块,模块名:模块对象
*/
private final ConcurrentHashMap<String, Module> modules = new ConcurrentHashMap();
/**
* 加载模块错误信息
*/
private final ConcurrentHashMap<String, String> errorContext = new ConcurrentHashMap();
@Override
public List<Module> getModules() {
return ImmutableList
.copyOf(filter(modules.values(), instanceOf(SpringModule.class)));
}
@Override
public Module find(String name) {
checkNotNull(name, "module name is null");
return modules.get(name.toUpperCase());
}
@Override
public Module register(Module module) {
checkNotNull(module, "module is null");
String name = module.getName();
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Put Module: {}-{}", name, module.getVersion());
}
return modules.put(name.toUpperCase(Locale.CHINESE), module);
}
@Override
public Module remove(String name) {
checkNotNull(name, "module name is null");
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Remove Module: {}", name);
}
return modules.remove(name.toUpperCase());
}
@Override
public void destroy() throws Exception {
for (Module each : modules.values()) {
try {
each.destroy();
} catch (Exception e) {
LOGGER.error("Failed to destroy module: " + each.getName(), e);
}
}
modules.clear();
}
@Override
public Map<String, String> getErrorModuleContext() {
return errorContext;
}
}
ModuleLoader接口
/*
* * Copyright 1999-2018 Alibaba Group Holding Ltd.
*/
package com.alipay.jarslink.api;
/**
* 模块加载器
*
* @author tengfei.fangtf
* @version $Id: ModuleLoader.java, v 0.1 2017年05月30日 2:55 PM tengfei.fangtf Exp $
*/
public interface ModuleLoader {
/**
* 根据配置加载一个模块,创建一个新的ClassLoadr加载jar里的class,初始化Spring ApplicationContext等
*
* @param moduleConfig 模块配置信息
*
* @return 加载成功的模块
*/
Module load(ModuleConfig moduleConfig);
}
实现类
/*
* * Copyright 1999-2018 Alibaba Group Holding Ltd.
*/
package com.alipay.jarslink.api.impl;
import com.alipay.jarslink.api.Module;
import com.alipay.jarslink.api.ModuleConfig;
import com.alipay.jarslink.api.ModuleLoader;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.CachedIntrospectionResults;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.collect.Iterables.toArray;
import static org.apache.commons.lang.StringUtils.isBlank;
/**
* 模块加载器实现
*
* @author tengfei.fangtf
* @version $Id: ModuleLoaderImpl.java, v 0.1 2017-4-24 上午9:58:12 tengfei.fangtf Exp $
*/
public class ModuleLoaderImpl implements ModuleLoader, ApplicationContextAware {
private static final Logger LOGGER = LoggerFactory.getLogger(ModuleLoaderImpl.class);
/**
* Spring bean文件所在目录
*/
public static String SPRING_XML_PATTERN = "classpath*:META-INF/spring/*.xml";
/**
* Spring bean文件所在目录,不同的路径确保能取到资源
*/
public static String SPRING_XML_PATTERN2 = "classpath*:*META-INF/spring/*.xml";
/**
* 模块版本属性
*/
private static final String MODULE_PROPERTY_VERSION = "module_version";
/**
* 模块名属性
*/
private static final String MODULE_PROPERTY_NAME = "module_name";
/**
* 不加载的Spring配置文件
*/
private static final String MODULE_EXCLUSION_CONFIGE_NAME = "exclusion_confige_name";
/**
* 注入父applicationContext
*/
private ApplicationContext applicationContext;
@Override
public Module load(ModuleConfig moduleConfig) {
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Loading module: {}", moduleConfig);
}
List<String> tempFileJarURLs = moduleConfig.getModuleUrlPath();
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Local jars: {}", tempFileJarURLs);
}
ConfigurableApplicationContext moduleApplicationContext = loadModuleApplication(moduleConfig, tempFileJarURLs);
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Loading module complete:{}", moduleConfig);
}
return new SpringModule(moduleConfig, moduleConfig.getVersion(), moduleConfig.getName(), moduleApplicationContext);
}
/**
* 根据本地临时文件Jar,初始化模块自己的ClassLoader,初始化Spring Application Context,同时要设置当前线程上下文的ClassLoader问模块的ClassLoader
*
* @param moduleConfig
* @param tempFileJarURLs
* @return
*/
private ClassPathXmlApplicationContext loadModuleApplication(ModuleConfig moduleConfig, List<String> tempFileJarURLs) {
ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader();
//获取模块的ClassLoader
ClassLoader moduleClassLoader = new ModuleClassLoader(moduleConfig.getModuleUrl(), applicationContext.getClassLoader(),
getOverridePackages(moduleConfig));
try {
//把当前线程的ClassLoader切换成模块的
Thread.currentThread().setContextClassLoader(moduleClassLoader);
ModuleApplicationContext moduleApplicationContext = new ModuleApplicationContext(applicationContext);
Properties properties = getProperties(moduleConfig);
moduleApplicationContext.setProperties(properties);
moduleApplicationContext.setClassLoader(moduleClassLoader);
moduleApplicationContext.setConfigLocations(findSpringConfigs(tempFileJarURLs, moduleClassLoader,
getExclusionConfigeNameList(properties)));
moduleApplicationContext.refresh();
return moduleApplicationContext;
} catch (Throwable e) {
CachedIntrospectionResults.clearClassLoader(moduleClassLoader);
throw Throwables.propagate(e);
} finally {
//还原当前线程的ClassLoader
Thread.currentThread().setContextClassLoader(currentClassLoader);
}
}
/**
* 获取不加载的spring配置文件名称
* @param properties
* @return
*/
private List<String> getExclusionConfigeNameList(Properties properties) {
String property = properties.getProperty(MODULE_EXCLUSION_CONFIGE_NAME);
if (property != null) {
return Lists.newArrayList(property.split(","));
}
return Lists.newArrayList();
}
/**
* 获得模块的配置,并会增加一些模块的常量信息
*
* @param moduleConfig
* @return
*/
private Properties getProperties(ModuleConfig moduleConfig) {
Properties properties = toProperties(moduleConfig.getProperties());
properties.setProperty(MODULE_PROPERTY_NAME, moduleConfig.getName());
properties.setProperty(MODULE_PROPERTY_VERSION, moduleConfig.getVersion());
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Module Properties: {}", properties);
}
return properties;
}
/**
* 查找资源(JAR)中的Spring配置文件
*
* @param tempFileJarURLs
* @param moduleClassLoader
* @return
*/
private String[] findSpringConfigs(List<String> tempFileJarURLs, ClassLoader moduleClassLoader, List<String> exclusionConfigeNameList) {
try {
PathMatchingResourcePatternResolver pmr = new PathMatchingResourcePatternResolver(
moduleClassLoader);
Resource[] resources = ImmutableSet.builder().add(pmr.getResources(SPRING_XML_PATTERN)).add(
pmr.getResources(SPRING_XML_PATTERN2)).build().toArray(new Resource[] {});
checkNotNull(resources, "resources is null");
checkArgument(resources.length > 0, "resources length is 0");
// 因为ClassLoader是树形结构,这里会找到ModuleClassLoader以及其父类中所有符合规范的spring配置文件,所以这里需要过滤,只需要Module Jar中的
return filterURLsIncludedResources(tempFileJarURLs, resources, exclusionConfigeNameList);
} catch (IOException e) {
throw new IllegalStateException("Failed to find spring configs from " + tempFileJarURLs, e);
}
}
/**
* 过滤查找到的spring配置文件资源,只查找tempFileJarURLs中的spring配置文件
*
* @param tempFileJarURLs
* @param resources
* @param exclusionConfigeNameList
* @return
* @throws IOException
*/
private String[] filterURLsIncludedResources(List<String> tempFileJarURLs, Resource[] resources, List<String> exclusionConfigeNameList)
throws IOException {
List<String> configLocations = Lists.newArrayList();
for (Resource resource : resources) {
String configLocation = resource.getURL().toString();
for (String url : tempFileJarURLs) {
if (isExclusionConfig(configLocation, exclusionConfigeNameList)) {
if (LOGGER.isInfoEnabled()) {
LOGGER.info("exclusion url: {}", configLocation);
}
continue;
}
if (configLocation.contains(url)) {
configLocations.add(configLocation);
}
}
}
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Config locations: {}", configLocations);
}
return toArray(configLocations, String.class);
}
/**
* 是否是需要不载入的spring配置
*
* @param url
* @param exclusionConfigeNameList
* @return
*/
private boolean isExclusionConfig(String url, List<String> exclusionConfigeNameList) {
for (String tmp : exclusionConfigeNameList) {
if (url.contains(tmp)) {
return true;
}
}
return false;
}
/**
* 去除list中的空白元素,string.startWith("")==true
*
* @param moduleConfig
* @return
*/
private List<String> getOverridePackages(ModuleConfig moduleConfig) {
List<String> list = Lists.newArrayList();
for (String s : moduleConfig.getOverridePackages()) {
if (!StringUtils.isBlank(s)) {
list.add(s);
}
}
return list;
}
/**
* Map 转换为Properties
*
* @param map
* @return
*/
private static Properties toProperties(Map<String, Object> map) {
Properties properties = new Properties();
for (Entry<String, Object> each : map.entrySet()) {
if (each.getKey() == null || each.getValue() == null) {
if (LOGGER.isWarnEnabled()) {
LOGGER.warn("Ignore null properties: {}={}", each.getKey(), each.getValue());
}
continue;
}
if (isBlank(each.getKey())) {
continue;
}
properties.setProperty(each.getKey(), each.getValue().toString());
}
return properties;
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
}
JarsLink会支持多版本加载,并陆续支持模块间调用、资源隔离等特性。还在不断更新和强化。