• 欢迎访问搞代码网站,推荐使用最新版火狐浏览器和Chrome浏览器访问本网站!
  • 如果您觉得本站非常有看点,那么赶紧使用Ctrl+D 收藏搞代码吧

springboot运行时新增/更新外部接口的实现方法

springboot 搞代码 4年前 (2022-01-09) 26次浏览 已收录 0个评论

最近有个需求:需要让现有springboot项目可以加载外部的jar包实现新增、更新接口逻辑。本着拿来主义的思维网上找了半天没有找到类似的东西,唯一有点相似的还是spring-loaded但是这个东西据我网上了解有如下缺点:

1、使用java agent启动,个人倾向于直接使用pom依赖的方式

2、不支持新增字段,新增方法,估计也不支持mybatis的xml加载那些吧,没了解过

3、只适合在开发环境IDE中使用,没法生产使用

无奈之下,我只能自己实现一个了,我需要实现的功能如下

1、加载外部扩展jar包中的新接口,多次加载需要能完全更新

2、应该能加载mybatis、mybatis-plus中放sql的xml文件

3、应该能加载@Mapper修饰的mybatis的接口资源

4、需要能加载其它被spring管理的Bean资源

5、需要能在加载完成后更新swagger文档

总而言之就是要实现一个能够扩展完整接口的容器,其实类似于热加载也不同于热加载,热部署是监控本地的class文件的改变,然后使用自动重启或者重载,热部署领域比较火的就是devtools和jrebel,前者使用自动重启的方式,监控你的classes改变了,然后使用反射调用你的main方法重启一下,后者使用重载的方式,因为收费,具体原理也没了解过,估计就是不重启,只加载变过的class吧。而本文实现的是加载外部的jar包,这个jar包只要是个可访问的URL资源就可以了。虽然和热部署不一样,但是从方案上可以借鉴,本文就是使用重载的方式,也就是只会更新扩展包里的资源。

先来一个自定义的模块类加载器

package com.rdpaas.dynamic.core;


import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URL;
import java.net.URLClassLoader;
import java.security.AccessController;
import java.security.PrivilegedExceptionAction;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;


/**
 * 动态加载外部jar包的自定义类加载器
 * @author rongdi
 * @date 2021-03-06
 * @blog https://www.cnblogs.com/rongdi
 */
public class ModuleClassLoader extends URLClassLoader {

  private Logger logger = LoggerFactory.getLogger(ModuleClassLoader.class);

  private final static String CLASS_SUFFIX = ".class";

  private final static String XML_SUFFIX = ".xml";

  private final static String MAPPER_SUFFIX = "mapper/";

  //属于本类加载器加载的jar包
  private JarFile jarFile;

  private Map<String, byte[]> classBytesMap = new HashMap<>();

  private Map<String, Class<?>> classesMap = new HashMap<>();

  private Map<String, byte[]> xmlBytesMap = new HashMap<>();

  public ModuleClassLoader(ClassLoader classLoader, URL... urls) {
    super(urls, classLoader);
    URL url = urls[0];
    String path = url.getPath();
    try {
      jarFile = new JarFile(path);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

  @Override
  protected Class<?> findClass(String name) throws ClassNotFoundException {
    byte[] buf = classBytesMap.get(name);
    if (buf == null) {
      return super.findClass(name);
    }
    if(classesMap.containsKey(name)) {
      return classesMap.get(name);
    }
    /**
     * 这里应该算是骚操作了,我不知道市面上有没有人这么做过,反正我是想了好久,遇到各种因为spring要生成代理对象
     * 在他自己的AppClassLoader找不到原对象导致的报错,注意如果你限制你的扩展包你不会有AOP触碰到的类或者@Transactional这种
     * 会产生代理的类,那么其实你不用这么骚,直接在这里调用defineClass把字节码装载进去就行了,不会有什么问题,最多也就是
     * 在加载mybatis的xml那里前后加三句话,
     * 1、获取并使用一个变量保存当前线程类加载器
     * 2、将自定义类加载器设置到当前线程类加载器
     * 3、还原当前线程类加载器为第一步保存的类加载器
     * 这样之后mybatis那些xml里resultType,resultMap之类的需要访问扩展包的Class的就不会报错了。
     * 不过直接用现在这种骚操作,更加一劳永逸,不会有mybatis的问题了
     */
    return loadClass(name,buf);
  }

  /**
   * 使用反射强行将类装载的归属给当前类加载器的父类加载器也就是AppClassLoader,如果报ClassNotFoundException
   * 则递归装载
   * @param name
   * @param bytes
   * @return
   */
  private Class<?> loadClass(String name, byte[] bytes) throws ClassNotFoundException {

    Object[] args = new Object[]{name, bytes, 0, bytes.length};
    try {
      /**
       * 拿到当前类加载器的parent加载器AppClassLoader
       */
      ClassLoader parent = this.getParent();
      /**
       * 首先要明确反射是万能的,仿造org.springframework.cglib.core.ReflectUtils的写法,强行获取被保护
       * 的方法defineClass的对象,然后调用指定类加载器的加载字节码方法,强行将加载归属塞给它,避免被spring的AOP或者@Transactional
       * 触碰到的类需要生成代理对象,而在AppClassLoader下加载不到外部的扩展类而报错,所以这里强行将加载外部扩展包的类的归属给
       * AppClassLoader,让spring的cglib生成代理对象时可以加载到原对象
       */
      Method classLoaderDefineClass = (Method) AccessController.doPrivileged(new PrivilegedExceptionAction() {
        @Override
        public Object run() throws Exception {
          return ClassLoader.class.getDeclaredMethod("defineClass",
              String.class, byte[].class, Integer.TYPE, Integer.TYPE);
        }
      });
      if(!classLoaderDefineClass.isAccessible()) {
        classLoaderDefineClass.setAccessible(true);
      }
      return (Class<?>)classLoaderDefineClass.invoke(parent,args);
    } catch (Exception e) {
      if(e instanceof InvocationTargetException) {
        String message<b>本文来源gao@dai!ma.com搞$代^码!网7</b> = ((InvocationTargetException) e).getTargetException().getCause().toString();
        /**
         * 无奈,明明ClassNotFoundException是个异常,非要抛个InvocationTargetException,导致
         * 我这里一个不太优雅的判断
         */
        if(message.startsWith("java.lang.ClassNotFoundException")) {
          String notClassName = message.split(":")[1];
          if(StringUtils.isEmpty(notClassName)) {
            throw new ClassNotFoundException(message);
          }
          notClassName = notClassName.trim();
          byte[] bytes1 = classBytesMap.get(notClassName);
          if(bytes1 == null) {
            throw new ClassNotFoundException(message);
          }
          /**
           * 递归装载未找到的类
           */
          Class<?> notClass = loadClass(notClassName, bytes1);
          if(notClass == null) {
            throw new ClassNotFoundException(message);
          }
          classesMap.put(notClassName,notClass);
          return loadClass(name,bytes);
        }
      } else {
        logger.error("",e);
      }
    }
    return null;
  }

  public Map<String,byte[]> getXmlBytesMap() {
    return xmlBytesMap;
  }


  /**
   * 方法描述 初始化类加载器,保存字节码
   */
  public Map<String, Class> load() {

    Map<String, Class> cacheClassMap = new HashMap<>();

    //解析jar包每一项
    Enumeration<JarEntry> en = jarFile.entries();
    InputStream input = null;
    try {
      while (en.hasMoreElements()) {
        JarEntry je = en.nextElement();
        String name = je.getName();
        //这里添加了路径扫描限制
        if (name.endsWith(CLASS_SUFFIX)) {
          String className = name.replace(CLASS_SUFFIX, "").replaceAll("/", ".");
          input = jarFile.getInputStream(je);
          ByteArrayOutputStream baos = new ByteArrayOutputStream();
          int bufferSize = 4096;
          byte[] buffer = new byte[bufferSize];
          int bytesNumRead = 0;
          while ((bytesNumRead = input.read(buffer)) != -1) {
            baos.write(buffer, 0, bytesNumRead);
          }
          byte[] classBytes = baos.toByteArray();
          classBytesMap.put(className, classBytes);
        } else if(name.endsWith(XML_SUFFIX) && name.startsWith(MAPPER_SUFFIX)) {
          input = jarFile.getInputStream(je);
          ByteArrayOutputStream baos = new ByteArrayOutputStream();
          int bufferSize = 4096;
          byte[] buffer = new byte[bufferSize];
          int bytesNumRead = 0;
          while ((bytesNumRead = input.read(buffer)) != -1) {
            baos.write(buffer, 0, bytesNumRead);
          }
          byte[] xmlBytes = baos.toByteArray();
          xmlBytesMap.put(name, xmlBytes);
        }
      }
    } catch (IOException e) {
      logger.error("",e);
    } finally {
      if (input != null) {
        try {
          input.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
    }

    //将jar中的每一个class字节码进行Class载入
    for (Map.Entry<String, byte[]> entry : classBytesMap.entrySet()) {
      String key = entry.getKey();
      Class<?> aClass = null;
      try {
        aClass = loadClass(key);
      } catch (ClassNotFoundException e) {
        logger.error("",e);
      }
      cacheClassMap.put(key, aClass);
    }
    return cacheClassMap;

  }

  public Map<String, byte[]> getClassBytesMap() {
    return classBytesMap;
  }
}

搞代码网(gaodaima.com)提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected],我们会在看到邮件的第一时间内为您处理,或直接联系QQ:872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:springboot运行时新增/更新外部接口的实现方法

喜欢 (0)
[搞代码]
分享 (0)
发表我的评论
取消评论

表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址