求求你别再手动部署 Jar 包了，太 low 了！动态上传热部署真的太爽了！

近期开发遇到的需求

在最近的开发过程中，我们遇到了一个需求：系统需要提供一个接口，允许用户自定义开发该接口的实现，并将实现打包成 Jar 上传到系统中。系统能够在不重启的情况下，自动热部署，并动态切换该接口的实现。

定义简单的接口

我们以一个简单的计算器功能为例，接口定义如下：

public interface Calculator {
    int calculate(int a, int b);
    int add(int a, int b);
}

接口的简单实现

考虑到用户实现接口的两种方式，一种是通过 Spring 上下文管理的注解方式，另一种是通过不依赖 Spring 的反射方式。calculate 方法对应注解方式，add 方法对应反射方式。实现类如下：

@Service
public class CalculatorImpl implements Calculator {
    @Autowired
    CalculatorCore calculatorCore;

    @Override
    public int calculate(int a, int b) {
        return calculatorCore.add(a, b);
    }

    @Override
    public int add(int a, int b) {
        return new CalculatorCore().add(a, b);
    }
}

CalculatorCore 的代码如下：

@Service
public class CalculatorCore {
    public int add(int a, int b) {
        return a + b;
    }
}

反射方式热部署

用户将 Jar 包上传到指定目录，接下来系统会将这个 Jar 包加载到当前线程的类加载器中，然后通过反射调用实现类的 add 方法。具体实现如下：

private static String jarAddress = "E:/zzq/IDEA_WS/CalculatorTest/lib/Calculator.jar";
private static String jarPath = "file:/" + jarAddress;

public static void hotDeployWithReflect() throws Exception {
    URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());
    Class clazz = urlClassLoader.loadClass("com.nci.cetc15.calculator.impl.CalculatorImpl");
    Calculator calculator = (Calculator) clazz.newInstance();
    int result = calculator.add(1, 2);
    System.out.println(result);
}

注解方式热部署

如果用户上传的 Jar 包中包含了 Spring 上下文，则需要动态注册其中的 Bean 到系统的 Spring 容器中。具体代码如下：

public static void hotDeployWithSpring() throws Exception {
    Set<String> classNameSet = DeployUtils.readJarFile(jarAddress);
    URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());
    for (String className : classNameSet) {
        Class clazz = urlClassLoader.loadClass(className);
        if (DeployUtils.isSpringBeanClass(clazz)) {
            BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
            defaultListableBeanFactory.registerBeanDefinition(DeployUtils.transformName(className), beanDefinitionBuilder.getBeanDefinition());
        }
    }
}

DeployUtils 工具类

DeployUtils 工具类包含读取 Jar 包中所有类文件的方法、判断类是否为 Spring Bean 的方法以及生成 Spring 容器中 Bean 名称的方法。

public static Set<String> readJarFile(String jarAddress) throws IOException {
    Set<String> classNameSet = new HashSet<>();
    JarFile jarFile = new JarFile(jarAddress);
    Enumeration<JarEntry> entries = jarFile.entries();
    while (entries.hasMoreElements()) {
        JarEntry jarEntry = entries.nextElement();
        String name = jarEntry.getName();
        if (name.endsWith(".class")) {
            String className = name.replace(".class", "").replaceAll("/", ".");
            classNameSet.add(className);
        }
    }
    return classNameSet;
}

public static boolean isSpringBeanClass(Class<?> clazz) {
    if (clazz == null || clazz.isInterface() || Modifier.isAbstract(clazz.getModifiers())) {
        return false;
    }
    return clazz.getAnnotation(Component.class) != null ||
           clazz.getAnnotation(Repository.class) != null ||
           clazz.getAnnotation(Service.class) != null;
}

public static String transformName(String className) {
    String tmpstr = className.substring(className.lastIndexOf(".") + 1);
    return tmpstr.substring(0, 1).toLowerCase() + tmpstr.substring(1);
}

删除 Jar 时需要同步删除 Spring 容器中的 Bean

在 Jar 包被删除或切换时，我们需要删除之前注册到 Spring 容器中的 Bean。具体代码如下：

public static void delete() throws Exception {
    Set<String> classNameSet = DeployUtils.readJarFile(jarAddress);
    URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());
    for (String className : classNameSet) {
        Class clazz = urlClassLoader.loadClass(className);
        if (DeployUtils.isSpringBeanClass(clazz)) {
            defaultListableBeanFactory.removeBeanDefinition(DeployUtils.transformName(className));
        }
    }
}

测试

可以通过一个简单的测试类来模拟用户上传 Jar 的场景，以下代码会循环检测指定目录下的 Jar 包，并尝试加载该 Jar：

ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();
while (true) {
    try {
        hotDeployWithReflect();
        // hotDeployWithSpring();
        // delete();
    } catch (Exception e) {
        e.printStackTrace();
        Thread.sleep(10000);
    }
}