乐趣区

关于java:接了个变态需求给定一个接口要用户自定义动态实现并上传热部署怎么搞

jiezi

近期开发零碎过程中遇到的一个需要，零碎给定一个接口，用户能够自定义开发该接口的实现，并将实现打成 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) {int c = calculatorCore.add(a, b);
        return c;
    }
    /**
     * 反射形式
     */
    @Override
    public int add(int a, int b) {return new CalculatorCore().add(a, b);
    }
}

这里注入 CalculatorCore 的目标是为了验证在注解模式下，零碎能够残缺的结构出 bean 的依赖体系，并注册到以后 spring 容器中。CalculatorCore的代码如下：

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

这里举荐一个 Spring Boot 基础教程：

https://github.com/javastacks…

反射形式热部署

用户把 jar 包上传到零碎的指定目录下，这里定义上传 jar 文件门路为 jarAddress，jar 的 Url 门路为 jarPath。

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

并且能够要求用户填写 jar 包中接口实现类的残缺类名。接下来零碎要把上传的 jar 包加载到以后线程的类加载器中，而后通过残缺类名，加载失去该实现的 Class 对象。而后反射调用即可，残缺代码：

/**
 * 热加载 Calculator 接口的实现 反射形式
 */
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 的上下文，那么就须要扫描 jar 包里的所有须要注入 spring 容器的 bean，注册到以后零碎的 spring 容器中。其实，这就是一个类的热加载 + 动静注册的过程。

间接上代码：

/**
 * 退出 jar 包后 动静注册 bean 到 spring 容器，包含 bean 的依赖
 */
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());
        }
    }
}

在这个过程中，将 jar 加载到以后线程类加载器的过程和之前反射形式是一样的。而后扫描 jar 包下所有的类文件，获取到残缺类名，并应用以后线程类加载器加载出该类名对应的 class 对象。判断该 class 对象是否带有 spring 的注解，如果蕴含，则将该对象注册到零碎的 spring 容器中。

DeployUtils 蕴含读取 jar 包所有类文件的办法、判断 class 对象是否蕴含 sping 注解的办法、获取注册对象对象名的办法。代码如下：

/**
 * 读取 jar 包中所有类文件
 */
public static Set<String> readJarFile(String jarAddress) throws IOException {Set<String> classNameSet = new HashSet<>();
    JarFile jarFile = new JarFile(jarAddress);
    Enumeration<JarEntry> entries = jarFile.entries();// 遍历整个 jar 文件
    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;
}
/**
 * 办法形容 判断 class 对象是否带有 spring 的注解
 */
public static boolean isSpringBeanClass(Class<?> cla) {if (cla == null) {return false;}
    // 是否是接口
    if (cla.isInterface()) {return false;}
    // 是否是抽象类
    if (Modifier.isAbstract(cla.getModifiers())) {return false;}
    if (cla.getAnnotation(Component.class) != null) {return true;}
    if (cla.getAnnotation(Repository.class) != null) {return true;}
    if (cla.getAnnotation(Service.class) != null) {return true;}
    return false;
}
/**
 * 类名首字母小写 作为 spring 容器 beanMap 的 key
 */
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 删除。spring 容器的 bean 的删除操作和注册操作是相逆的过程，这里要留神应用同一个 spring 上下文。

代码如下：

/**
 * 删除 jar 包时 须要在 spring 容器删除注入
 */
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 会抛出异样，捕捉该异样并睡眠 10 秒。这时候能够把 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(1000 * 10);
            }
        }

看完，涨姿态了没？

原文链接：https://blog.csdn.net/zhangzh…

版权申明：本文为 CSDN 博主「zhangzhiqiang_0912」的原创文章，遵循 CC 4.0 BY-SA 版权协定，转载请附上原文出处链接及本申明。

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2022 最新版)

2. 劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4. 别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

退出移动版