Score
0
Watch 1 Star 2 Fork 1

蒋固金 / JModuleLinkJavaApache-2.0

Create your Gitee Account
Explore and code with more than 5 million developers,Free private repositories !:)
Sign up
动态模块,实现模块热部署 spread retract

Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

第一部分 简介

JModuleLink是一个基于JAVA的模块化开发框架,它提供在运行时动态加载模块(一个或一组JAR包)、卸载模块的API,使开发者更加关注业务本身。

1.1 需求背景

现在在公司主要从事支付平台的开发工作,随着业务的增长,对接的银行支付通道越来越多,用户也不满足在一个通道下面开通单个商户,存在一个银行通道按照不同商户进行支付的需求,在传统实现当中,每次涉及到银行通道或者商户号的变更都需要重启服务器,体验较差。单个通道出现异常会影响其他通道的正常使用,用户对商户号的修改需要依赖开发人员对系统进行配置,增大后期维护成本。在同一个支付通道的多商户的背景下,部门银行提供的开发包无法兼容,需要对其进行隔离,于是在系统中使用了自定义的ClassLoader突破默认的双亲委托,自定义加载所需三方包以解决 冲突的问题,偶然的机会看到了阿里开源的jarslink,所以借鉴了其部分实现方式,编写了JModuleLink

传统开发模式问题:

  • 应用拆分的多或少都有问题。多则维护成本高,每次发布一堆应用。少则拆分成本高,无用功能很难下线。
  • 故障不隔离。当一个系统由多人同时参与开发时,修改A功能,可能会影响B功能,引发故障。
  • 多分支开发引发冲突。多分支开发完之后合并会产生冲突。
  • 牵一发动全身。一处核心代码的改动,或一个基础Jar的升级需要回归整个系统。
  • 升级和迁移成本高。中间件升级每个应用都有升级成本。

1.2 模块化开发的好处

  • 可插拔,一个应用由多个模块组成,应用里的模块可拆和合,模块可快速在多个系统中迁移和部署。
  • 模块化开发,模块之间互相隔离,实现故障隔离。
  • 一个模块一个分支,不会引发代码冲突。
  • 在模块中增加或修改功能,只会影响当前模块,不会影响整个应用。
  • 动态部署,在运行时把模块部署到应用中,快速修复故障,提高发布效率。
  • 多版本部署,可以在运行时同时部署某个模块的新旧版本,进行AB TEST。
  • 减少资源消耗,通过部署模块的方式减少应用数量和机器数量。

1.3 特性

1.3.1 隔离性

  • 类隔离:框架为每个模块的Class使用单独的ClassLoader来加载,每个模块可以依赖同一种框架的不同的版本。
  • 实例隔离:框架为每个模块创建了一个独立的Spring上下文,来加载模块中的BEAN,实例化失败不会影响其他模块(Spring环境)。

1.3.2 动态性

  • 动态发布:模块能在运行时动态加载到系统中,实现不需要重启和发布系统新增功能。支持突破双亲委派机制,在运行时加载父加载器已经加载过的类,实现模块升级依赖包不需要系统发布。
  • 动态卸载:模块能在运行时被动态卸载干净,实现快速下线不需要功能。

1.3.3 易用性

  • 提供了通用灵活的API让系统和模块进行交互。

第二部分 快速开始

使用JModuleLink可以直接下载源代码编译或者下载已经编译的jar文件,如果您是使用maven来构建项目,也可以直接在pom.xml中添加JModuleLink的坐标:

Maven central

<!-- http://mvnrepository.com/artifact/com.jianggujin/JModuleLink -->
<dependency>
    <groupId>com.jianggujin</groupId>
    <artifactId>JModuleLink</artifactId>
    <version>最新版本</version>
</dependency>

最新的版本可以从Maven仓库或者码云获取。

2.1 编写模块

对于模块而言,简单的来说就是Action的合集,所以我们需要掌握如何开发Action,编写一个Action我们只需要创建一个普通的类,然后让其实现JAction接口即可。

package com.jianggujin.modulelink.test.module;

import com.jianggujin.modulelink.JAction;
import com.jianggujin.modulelink.exception.JModuleLinkException;

/**
 * 自定义Action
 * 
 * @author jianggujin
 *
 */
public class CustomAction implements JAction {

    @Override
    public Object execute(JModuleContext context) throws JModuleLinkException {
        // TODO
        return null;
    }

    @Override
    public String getActionName() {
        return "customAction";
    }

    @Override
    public boolean isDefault(String moduleName) {
        return false;
    }
}

JAction中包含三个方法:

修饰符与类型 方法 描述
Object execute(JModuleContext context) 真正的业务逻辑处理方法
String getActionName() Action的名称,在同一个模块中,该值唯一
boolean isDefault(String moduleName) 该方法用于判断Action在模块中
是否为默认的Action
用于找不到指定Action的时候
的默认处理(可控制是否使用)

最后只需要将编写好的模块打包即可。建议一个模块就是一个FAT JAR,当然了,这并不是强制的,JModuleLink也支持一个模块有多个资源或jar。除了上面的写法之外,JModuleLink提供了一个JAction的抽象实现JAbstractAction,多数情况下,我们只需要重写execute方法即可,默认的Action名称为当前类名首字母小写。

package com.jianggujin.modulelink.test.module;

import com.jianggujin.modulelink.exception.JModuleLinkException;
import com.jianggujin.modulelink.support.JAbstractAction;

/**
 * 自定义Action
 * 
 * @author jianggujin
 *
 */
public class CustomAction extends JAbstractAction {

    @Override
    public Object execute(JModuleContext context) throws JModuleLinkException {
        // TODO
        return null;
    }
}

2.2 模块管理器

模块的加载运行需要JModuleLink的核心支持,首先我们需要初始化JModuleManager,使用该类可以完成模块的加载、卸载、查找等操作,建议使用单例模式初始化该类的对象,使用全局唯一的模块管理器管理模块。

JModuleManager moduleManager = new JDefaultModuleManager();

除此之外,还可以使用更加简单的方式来获得JModuleManager的实例对象:

JModuleManager moduleManager = JDefaultModuleManager.getInstance();

该种方式获得的JModuleManager对象为单例对象,且只有第一次调用该方法的时候才会真正初始化。

2.3 加载模块

我们可以使用JModuleConfig 来定义一个模块信息。配置说明如下:

名称 说明
moduleName 模块名,建议用英文命名,全局唯一
description 模块描述
version 模块版本
moduleUrls 模块的资源地址,比如jar文件的位置
exclusionActionNames 需要排除的Action名称
exclusionActions 需要排除的action,值为全限定类名
scanPackages 需要扫描的包,不为空时会启动扫描包下面的Action与监听器
active 是否激活,仅当模块有多个版本的时候有效
reload 重新加载,如果该值为true,加载模块时会先卸载已加载模块然后重新加载
exclusionModuleListeners 需要排除的模块事件监听器

使用示例:

JModuleConfig moduleConfig = new JModuleConfig(moduleName, moduleVersion);
moduleConfig.setDescription(moduleDesc);
moduleConfig.addModuleUrl(moduleUrl);
moduleConfig.addScanPackage(scanPackage);
moduleManager.load(moduleConfig);

这样就完成了一个模块的加载。

2.4 使用模块

模块正常加载后,我们就可以通过模块管理器查找已经加载的模块并执行指定的Action。使用方式如下:

public Object service(String moduleName, String actionName) {
    JModule module = moduleManager.getModule(moduleName);
    if (actionName == null) {
        return module.doDefaultAction(null);
    }
    return module.doAction(actionName, null);
}

Action的参数按照实际情况传递

2.5 卸载模块

当一个模块或模块的版本不再使用的时候,我们可以动态的将其卸载,JModuleManager提供了相应的卸载方法:

   /**
    * 卸载一个模块
    */
   void unload(String moduleName);

   /**
    * 卸载一个模块的指定版本
    */
   void unload(String moduleName, String version);

需要注意的是如果仅仅是卸载模块的指定版本,且该版本为当前正在使用的版本,那么被卸载的模块中除去卸载版本后不能含有多个版本,否则无法卸载。

卸载模块的时候必须调用JModuleManagerunload方法实现,虽然该接口提供了查找JModule的方法,并且JModule存在destroy()方法,但是我们依然不建议直接调用模块的的销毁方法,避免管理器模块状态不一致出现错误。

具体示例请参考:https://gitee.com/jianggujin/JModuleLink-demo

第三部分 扩展阅读

3.1 事件监听

JModuleLink中,我们可以对模块的开始加载、加载完成、激活、取消激活、卸载事件进行监听,以便于我们在代码中做一些额外的处理,监听模块的事件,我们需要实现JModuleListener接口,模块加载过程中,会先尝试从模块中加载实现了该接口的监听类,然后才会加载相关的Action,以便于监听器可以完整的获得事件回调。如果只需要监听模块的部分事件,JModuleLink中还提供了一个JModuleListenerAdapter,我们只需要重写需要处理的回调方法即可。

3.2 Spring模块

JModuleLink支持Spring模块,默认提供的加载器会针对Spring环境的模块进行特殊处理,我们可以使用XML或注解的形式创建Spring环境的上下文,当然,上下文的创建是加载器根据模块配置进行选择的。JModuleLinkSpring模块提供专用的配置类JSpringModuleConfig,该配置中除了拥有JModuleConfig的所有属性之外,还拥有一些扩展属性,扩展属性如下:

名称 说明
xmlPatterns XML配置,默认加载的配置文件:classpath*:META-INF/spring/*.xmlclasspath*:*META-INF/spring/*.xml,自定义配置文件后,默认配置无效
exclusions 需要排除的配置文件

需要注意的是,在模块配置中,如果配置了scanPackages,则模块加载器会初始化AnnotationConfigApplicationContext作为上下文,此时xmlPatternsexclusions配置无效,否则使用ClassPathXmlApplicationContext初始化上下文,加载器会扫描上下文中注入的Action监听器,需要排除的Action监听器的配置是正常生效的,排除的Action只能作为普通Bean使用而不能被模块执行。

想要加载器将模块作为Spring环境加载需要满足以下条件:

  • 配置类使用JSpringModuleConfigJSpringBootModuleConfig
  • 模块类路径中可以加载到org.springframework.context.support.ClassPathXmlApplicationContext对象,这里需要分清楚的是,JModuleLink的运行环境不一定是Spring环境也可以正常加载作为Spring环境的模块,主要在模块类路径下或JModuleLink运行的类路径下扫描到Spring相关类即可

如果加载器检测模块环境以及配置不满足Spring的加载条件,则会将其作为普通模块加载处理。

3.3 SpringBoot模块

Spring环境的模块类似,JModuleLinke也专门提供了对SpringBoot环境模块的特殊处理,使用SpringBoot才需要使用JModuleSpringBootConfig作为配置类,该配置中除了拥有JModuleConfig的所有属性之外,还拥有一些扩展属性,扩展属性如下:

名称 说明
sources SpringBoot source

SpringBoot环境下,scanPackages配置无效,将会将扫描与初始化完全交给SpringBoot处理,与Spring环境类似,想要加载器将模块作为SpringBoot环境加载需要满足以下条件:

  • 配置类使用JSpringBootModuleConfig
  • 模块类路径中可以加载到org.springframework.boot.SpringApplication对象

如果加载器检测模块环境以及配置不满足SpringBoot的加载条件,则会将其作为普通模块加载处理。

3.4 Web环境

JModuleLink的初衷是实现可插拔、多模块的热部署,对于Web环境暂时没有做过多的支持,后期可能会增加直接初始化Web环境模块的增强处理,目前针对Web环境做了简单的适配,提供了JGenericHttpActionJHttpAction两个用于Web环境的Action,这两个实现的关系和HttpServletGenericServlet非常相似,可以按照Servlet的开发方式开发Action。在执行Action的时候我们只需要使用JHttpHolderHttpServletRequestHttpServletResponse进行包装并作为入参传递,就可以使其正常工作。

Comments ( 0 )

Sign in for post a comment

Java
1
https://gitee.com/jianggujin/JModuleLink.git
git@gitee.com:jianggujin/JModuleLink.git
jianggujin
JModuleLink
JModuleLink
master

Search

231008 48f1a665 1899542 231017 9a6720c6 1899542