Java
近期开发系统过程中遇到的一个需求,系统给定一个接口,用户可以自定义开发该接口的实现,并将实现打成jar包,上传到系统中。系统完成热部署,并切换该接口的实现。

定义简单的接口

这里以一个简单的计算器功能为例,接口定义比较简单,直接上代码。

  1. public interface Calculator {
  2. int calculate(int a, int b);
  3. int add(int a, int b);
  4. }

该接口的一个简单的实现

考虑到用户实现接口的两种方式,使用spring上下文管理的方式,或者不依赖spring管理的方式,这里称它们为注解方式和反射方式。calculate方法对应注解方式,add方法对应反射方式。计算器接口实现类的代码如下:

  1. @Service
  2. public class CalculatorImpl implements Calculator {
  3. @Autowired
  4. CalculatorCore calculatorCore;
  5. /**
  6. * 注解方式
  7. */
  8. @Override
  9. public int calculate(int a, int b) {
  10. int c = calculatorCore.add(a, b);
  11. return c;
  12. }
  13. /**
  14. * 反射方式
  15. */
  16. @Override
  17. public int add(int a, int b) {
  18. return new CalculatorCore().add(a, b);
  19. }
  20. }

这里注入CalculatorCore的目的是为了验证在注解模式下,系统可以完整的构造出bean的依赖体系,并注册到当前spring容器中。CalculatorCore的代码如下:

  1. @Service
  2. public class CalculatorCore {
  3. public int add(int a, int b) {
  4. return a+b;
  5. }
  6. }

反射方式热部署

用户把jar包上传到系统的指定目录下,这里定义上传jar文件路径为jarAddress,jar的Url路径为jarPath。

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

并且可以要求用户填写jar包中接口实现类的完整类名。接下来系统要把上传的jar包加载到当前线程的类加载器中,然后通过完整类名,加载得到该实现的Class对象。然后反射调用即可,完整代码:

  1. /**
  2. * 热加载Calculator接口的实现 反射方式
  3. */
  4. public static void hotDeployWithReflect() throws Exception {
  5. URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());
  6. Class clazz = urlClassLoader.loadClass("com.nci.cetc15.calculator.impl.CalculatorImpl");
  7. Calculator calculator = (Calculator) clazz.newInstance();
  8. int result = calculator.add(1, 2);
  9. System.out.println(result);
  10. }

注解方式热部署

如果用户上传的jar包含了spring的上下文,那么就需要扫描jar包里的所有需要注入spring容器的bean,注册到当前系统的spring容器中。其实,这就是一个类的热加载+动态注册的过程。
直接上代码:

  1. /**
  2. * 加入jar包后 动态注册bean到spring容器,包括bean的依赖
  3. */
  4. public static void hotDeployWithSpring() throws Exception {
  5. Set<String> classNameSet = DeployUtils.readJarFile(jarAddress);
  6. URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());
  7. for (String className : classNameSet) {
  8. Class clazz = urlClassLoader.loadClass(className);
  9. if (DeployUtils.isSpringBeanClass(clazz)) {
  10. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(clazz);
  11. defaultListableBeanFactory.registerBeanDefinition(DeployUtils.transformName(className), beanDefinitionBuilder.getBeanDefinition());
  12. }
  13. }
  14. }

在这个过程中,将jar加载到当前线程类加载器的过程和之前反射方式是一样的。然后扫描jar包下所有的类文件,获取到完整类名,并使用当前线程类加载器加载出该类名对应的class对象。判断该class对象是否带有spring的注解,如果包含,则将该对象注册到系统的spring容器中。
DeployUtils包含读取jar包所有类文件的方法、判断class对象是否包含sping注解的方法、获取注册对象对象名的方法。代码如下:

  1. /**
  2. * 读取jar包中所有类文件
  3. */
  4. public static Set<String> readJarFile(String jarAddress) throws IOException {
  5. Set<String> classNameSet = new HashSet<>();
  6. JarFile jarFile = new JarFile(jarAddress);
  7. Enumeration<JarEntry> entries = jarFile.entries();//遍历整个jar文件
  8. while (entries.hasMoreElements()) {
  9. JarEntry jarEntry = entries.nextElement();
  10. String name = jarEntry.getName();
  11. if (name.endsWith(".class")) {
  12. String className = name.replace(".class", "").replaceAll("/", ".");
  13. classNameSet.add(className);
  14. }
  15. }
  16. return classNameSet;
  17. }
  1. /**
  2. * 方法描述 判断class对象是否带有spring的注解
  3. */
  4. public static boolean isSpringBeanClass(Class<?> cla) {
  5. if (cla == null) {
  6. return false;
  7. }
  8. //是否是接口
  9. if (cla.isInterface()) {
  10. return false;
  11. }
  12. //是否是抽象类
  13. if (Modifier.isAbstract(cla.getModifiers())) {
  14. return false;
  15. }
  16. if (cla.getAnnotation(Component.class) != null) {
  17. return true;
  18. }
  19. if (cla.getAnnotation(Repository.class) != null) {
  20. return true;
  21. }
  22. if (cla.getAnnotation(Service.class) != null) {
  23. return true;
  24. }
  25. return false;
  26. }
  1. /**
  2. * 类名首字母小写 作为spring容器beanMap的key
  3. */
  4. public static String transformName(String className) {
  5. String tmpstr = className.substring(className.lastIndexOf(".") + 1);
  6. return tmpstr.substring(0, 1).toLowerCase() + tmpstr.substring(1);
  7. }

删除jar时,需要同时删除spring容器中注册的bean

在jar包切换或删除时,需要将之前注册到spring容器的bean删除。spring容器的bean的删除操作和注册操作是相逆的过程,这里要注意使用同一个spring上下文。
代码如下:

  1. /**
  2. * 删除jar包时 需要在spring容器删除注入
  3. */
  4. public static void delete() throws Exception {
  5. Set<String> classNameSet = DeployUtils.readJarFile(jarAddress);
  6. URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{new URL(jarPath)}, Thread.currentThread().getContextClassLoader());
  7. for (String className : classNameSet) {
  8. Class clazz = urlClassLoader.loadClass(className);
  9. if (DeployUtils.isSpringBeanClass(clazz)) {
  10. defaultListableBeanFactory.removeBeanDefinition(DeployUtils.transformName(className));
  11. }
  12. }
  13. }

测试

测试类手动模拟用户上传jar的功能。测试函数写了个死循环,一开始没有找到jar会抛出异常,捕获该异常并睡眠10秒。这时候可以把jar手动放到指定的目录下。
代码如下:

  1. ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
  2. DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();
  3. while (true) {
  4. try {
  5. hotDeployWithReflect();
  6. // hotDeployWithSpring();
  7. // delete();
  8. } catch (Exception e) {
  9. e.printStackTrace();
  10. Thread.sleep(1000 * 10);
  11. }
  12. }