0
0

Java-springboot动态加载jar包，动态配置

一、概述

1、背景

​ 目前数据治理服务中有众多治理任务，当其中任一治理任务有改动需要升级或新增一个治理任务时，都需要将数据治理服务重启，会影响其他治理任务的正常运行。

2、目标

  1. 能够动态启动、停止任一治理任务
  2. 能够动态升级、添加治理任务
  3. 启动、停止治理任务或升级、添加治理任务不能影响其他任务

3、方案

  1. 为了支持业务代码尽量的解耦，把部分业务功能通过动态加载的方式加载到主程序中，以满足可插拔式的加载、组合式的部署。
  2. 配合xxl-job任务调度框架，将数据治理任务做成xxl-job任务的方式注册到xxl-job中，方便统一管理。

二、动态加载

1、自定义类加载器

URLClassLoader 是一种特殊的类加载器，可以从指定的 URL 中加载类和资源。它的主要作用是动态加载外部的 JAR 包或者类文件，从而实现动态扩展应用程序的功。为了便于管理动态加载的jar包，自定义类加载器继承URLClassloader。

packagecn.jy.sjzl.util;importjava.lang.reflect.Method;importjava.net.URL;importjava.net.URLClassLoader;importjava.util.Map;importjava.util.concurrent.ConcurrentHashMap;/**
 * 自定义类加载器
 *
 * @author lijianyu
 * @date 2023/04/03 17:54
 **/publicclassMyClassLoaderextendsURLClassLoader{privateMap<String,Class<?>> loadedClasses =newConcurrentHashMap<>();publicMap<String,Class<?>>getLoadedClasses(){return loadedClasses;}publicMyClassLoader(URL[] urls,ClassLoader parent){super(urls, parent);}@OverrideprotectedClass<?>findClass(String name)throwsClassNotFoundException{// 从已加载的类集合中获取指定名称的类Class<?> clazz = loadedClasses.get(name);if(clazz !=null){return clazz;}try{// 调用父类的findClass方法加载指定名称的类
            clazz =super.findClass(name);// 将加载的类添加到已加载的类集合中
            loadedClasses.put(name, clazz);return clazz;}catch(ClassNotFoundException e){
            e.printStackTrace();returnnull;}}publicvoidunload(){try{for(Map.Entry<String,Class<?>> entry : loadedClasses.entrySet()){// 从已加载的类集合中移除该类String className = entry.getKey();
                loadedClasses.remove(className);try{// 调用该类的destory方法，回收资源Class<?> clazz = entry.getValue();Method destory = clazz.getDeclaredMethod("destory");
                    destory.invoke(clazz);}catch(Exception e ){// 表明该类没有destory方法}}// 从其父类加载器的加载器层次结构中移除该类加载器close();}catch(Exception e){
            e.printStackTrace();}}}
  • 自定义类加载器中，为了方便类的卸载，定义一个map保存已加载的类信息。key为这个类的ClassName，value为这个类的类信息。
  • 同时定义了类加载器的卸载方法，卸载方法中，将已加载的类的集合中移除该类。由于此类可能使用系统资源或调用线程，为了避免资源未回收引起的内存溢出，通过反射调用这个类中的destroy方法，回收资源。
  • 最后调用close方法。

2、动态加载

由于此项目使用spring框架，以及xxl-job任务的机制调用动态加载的代码，因此要完成以下内容

  • 将动态加载的jar包读到内存中
  • 将有spring注解的类，通过注解扫描的方式，扫描并手动添加到spring容器中。
  • 将@XxlJob注解的方法，通过注解扫描的方式，手动添加到xxljob执行器中。
packagecom.jy.dynamicLoad;importcom.jy.annotation.XxlJobCron;importcom.jy.classLoader.MyClassLoader;importcom.xxl.job.core.executor.impl.XxlJobSpringExecutor;importcom.xxl.job.core.handler.annotation.XxlJob;importcom.xxl.job.core.handler.impl.MethodJobHandler;importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.beans.factory.support.AbstractBeanDefinition;importorg.springframework.beans.factory.support.BeanDefinitionBuilder;importorg.springframework.beans.factory.support.DefaultListableBeanFactory;importorg.springframework.context.ApplicationContext;importorg.springframework.core.MethodIntrospector;importorg.springframework.core.annotation.AnnotatedElementUtils;importorg.springframework.stereotype.Component;importjava.io.File;importjava.io.IOException;importjava.lang.reflect.Method;importjava.net.JarURLConnection;importjava.net.URL;importjava.net.URLConnection;importjava.util.Enumeration;importjava.util.Map;importjava.util.concurrent.ConcurrentHashMap;importjava.util.jar.JarEntry;importjava.util.jar.JarFile;/**
 * @author lijianyu
 * @date 2023/04/29 13:18
 **/@ComponentpublicclassDynamicLoad{privatestaticLogger logger =LoggerFactory.getLogger(DynamicLoad.class);@AutowiredprivateApplicationContext applicationContext;privateMap<String,MyClassLoader> myClassLoaderCenter =newConcurrentHashMap<>();@Value("${dynamicLoad.path}")privateString path;/**
     * 动态加载指定路径下指定jar包
     * @param path
     * @param fileName
     * @param isRegistXxlJob  是否需要注册xxljob执行器，项目首次启动不需要注册执行器
     * @return map<jobHander, Cron> 创建xxljob任务时需要的参数配置
     */publicvoidloadJar(String path,String fileName,Boolean isRegistXxlJob)throwsClassNotFoundException,InstantiationException,IllegalAccessException{File file =newFile(path +"/"+ fileName);Map<String,String> jobPar =newHashMap<>();// 获取beanFactoryDefaultListableBeanFactory beanFactory =(DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();// 获取当前项目的执行器try{// URLClassloader加载jar包规范必须这么写URL url =newURL("jar:file:"+ file.getAbsolutePath()+"!/");URLConnection urlConnection = url.openConnection();JarURLConnection jarURLConnection =(JarURLConnection)urlConnection;// 获取jar文件JarFile jarFile = jarURLConnection.getJarFile();Enumeration<JarEntry> entries = jarFile.entries();// 创建自定义类加载器，并加到map中方便管理MyClassLoader myClassloader =newMyClassLoader(new URL[]{ url },ClassLoader.getSystemClassLoader());
            myClassLoaderCenter.put(fileName, myClassloader);Set<Class> initBeanClass =newHashSet<>(jarFile.size());// 遍历文件while(entries.hasMoreElements()){JarEntry jarEntry = entries.nextElement();if(jarEntry.getName().endsWith(".class")){// 1. 加载类到jvm中// 获取类的全路径名String className = jarEntry.getName().replace('/','.').substring(0, jarEntry.getName().length()-6);// 1.1进行反射获取
                    myClassloader.loadClass(className);}}Map<String,Class<?>> loadedClasses = myClassloader.getLoadedClasses();XxlJobSpringExecutor xxlJobExecutor =newXxlJobSpringExecutor();for(Map.Entry<String,Class<?>> entry : loadedClasses.entrySet()){String className = entry.getKey();Class<?> clazz = entry.getValue();// 2. 将有@spring注解的类交给spring管理// 2.1 判断是否注入springBoolean flag =SpringAnnotationUtils.hasSpringAnnotation(clazz);if(flag){// 2.2交给spring管理BeanDefinitionBuilder builder =BeanDefinitionBuilder.genericBeanDefinition(clazz);AbstractBeanDefinition beanDefinition = builder.getBeanDefinition();// 此处beanName使用全路径名是为了防止beanName重复String packageName = className.substring(0, className.lastIndexOf(".")+1);String beanName = className.substring(className.lastIndexOf(".")+1);
                    beanName = packageName + beanName.substring(0,1).toLowerCase()+ beanName.substring(1);// 2.3注册到spring的beanFactory中
                    beanFactory.registerBeanDefinition(beanName, beanDefinition);// 2.4允许注入和反向注入
                    beanFactory.autowireBean(clazz);
                    beanFactory.initializeBean(clazz, beanName);/*if(Arrays.stream(clazz.getInterfaces()).collect(Collectors.toSet()).contains(InitializingBean.class)){
                        initBeanClass.add(clazz);
                    }*/
                    initBeanClass.add(clazz);}// 3. 带有XxlJob注解的方法注册任务// 3.1 过滤方法Map<Method,XxlJob> annotatedMethods =null;try{
                    annotatedMethods =MethodIntrospector.selectMethods(clazz,newMethodIntrospector.MetadataLookup<XxlJob>(){@OverridepublicXxlJobinspect(Method method){returnAnnotatedElementUtils.findMergedAnnotation(method,XxlJob.class);}});}catch(Throwable ex){}// 3.2 生成并注册方法的JobHanderfor(Map.Entry<Method,XxlJob> methodXxlJobEntry : annotatedMethods.entrySet()){Method executeMethod = methodXxlJobEntry.getKey();// 获取jobHander和CronXxlJobCron xxlJobCron = executeMethod.getAnnotation(XxlJobCron.class);if(xxlJobCron ==null){thrownewCustomException("500", executeMethod.getName()+"()，没有添加@XxlJobCron注解配置定时策略");}if(!CronExpression.isValidExpression(xxlJobCron.value())){thrownewCustomException("500", executeMethod.getName()+"(),@XxlJobCron参数内容错误");}XxlJob xxlJob = methodXxlJobEntry.getValue();
                    jobPar.put(xxlJob.value(), xxlJobCron.value());if(isRegistXxlJob){
                        executeMethod.setAccessible(true);// registMethod initMethod =null;Method destroyMethod =null;
                        xxlJobExecutor.registJobHandler(xxlJob.value(),newCustomerMethodJobHandler(clazz, executeMethod, initMethod, destroyMethod));}}}// spring bean实际注册
            initBeanClass.forEach(beanFactory::getBean);}catch(IOException e){
            logger.error("读取{} 文件异常", fileName);
            e.printStackTrace();thrownewRuntimeException("读取jar文件异常: "+ fileName);}}}

以下是判断该类是否有spring注解的工具类

apublic classSpringAnnotationUtils{privatestaticLogger logger =LoggerFactory.getLogger(SpringAnnotationUtils.class);/**
     * 判断一个类是否有 Spring 核心注解
     *
     * @param clazz 要检查的类
     * @return true 如果该类上添加了相应的 Spring 注解；否则返回 false
     */publicstaticbooleanhasSpringAnnotation(Class<?> clazz){if(clazz ==null){returnfalse;}//是否是接口if(clazz.isInterface()){returnfalse;}//是否是抽象类if(Modifier.isAbstract(clazz.getModifiers())){returnfalse;}try{if(clazz.getAnnotation(Component.class)!=null||
            clazz.getAnnotation(Repository.class)!=null||
            clazz.getAnnotation(Service.class)!=null||
            clazz.getAnnotation(Controller.class)!=null||
            clazz.getAnnotation(Configuration.class)!=null){returntrue;}}catch(Exception e){
            logger.error("出现异常：{}",e.getMessage());}returnfalse;}}

注册xxljob执行器的操作是仿照的xxljob中的XxlJobSpringExecutor的注册方法。

3、动态卸载

动态卸载的过程，就是将动态加载的代码，从内存，spring以及xxljob中移除。

代码如下：

/**
     * 动态卸载指定路径下指定jar包
     * @param fileName
     * @return map<jobHander, Cron> 创建xxljob任务时需要的参数配置
     */publicvoidunloadJar(String fileName)throwsIllegalAccessException,NoSuchFieldException{// 获取加载当前jar的类加载器MyClassLoader myClassLoader = myClassLoaderCenter.get(fileName);// 获取jobHandlerRepository私有属性,为了卸载xxljob任务Field privateField =XxlJobExecutor.class.getDeclaredField("jobHandlerRepository");// 设置私有属性可访问
        privateField.setAccessible(true);// 获取私有属性的值jobHandlerRepositoryXxlJobExecutor xxlJobSpringExecutor =newXxlJobSpringExecutor();Map<String,IJobHandler> jobHandlerRepository =(ConcurrentHashMap<String,IJobHandler>) privateField.get(xxlJobSpringExecutor);// 获取beanFactory，准备从spring中卸载DefaultListableBeanFactory beanFactory =(DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();Map<String,Class<?>> loadedClasses = myClassLoader.getLoadedClasses();Set<String> beanNames =newHashSet<>();for(Map.Entry<String,Class<?>> entry: loadedClasses.entrySet()){// 1. 将xxljob任务从xxljob执行器中移除// 1.1 截取beanNameString key = entry.getKey();String packageName = key.substring(0, key.lastIndexOf(".")+1);String beanName = key.substring(key.lastIndexOf(".")+1);
            beanName = packageName + beanName.substring(0,1).toLowerCase()+ beanName.substring(1);// 获取bean，如果获取失败，表名这个类没有加到spring容器中，则跳出本次循环Object bean =null;try{
                bean = applicationContext.getBean(beanName);}catch(Exception e){// 异常说明spring中没有这个beancontinue;}// 1.2 过滤方法Map<Method,XxlJob> annotatedMethods =null;try{
                annotatedMethods =MethodIntrospector.selectMethods(bean.getClass(),newMethodIntrospector.MetadataLookup<XxlJob>(){@OverridepublicXxlJobinspect(Method method){returnAnnotatedElementUtils.findMergedAnnotation(method,XxlJob.class);}});}catch(Throwable ex){}// 1.3 将job从执行器中移除for(Map.Entry<Method,XxlJob> methodXxlJobEntry : annotatedMethods.entrySet()){XxlJob xxlJob = methodXxlJobEntry.getValue();
                jobHandlerRepository.remove(xxlJob.value());}// 2.0从spring中移除，这里的移除是仅仅移除的bean，并未移除bean定义
            beanNames.add(beanName);
            beanFactory.destroyBean(beanName, bean);}// 移除bean定义Field mergedBeanDefinitions = beanFactory.getClass().getSuperclass().getSuperclass().getDeclaredField("mergedBeanDefinitions");
        mergedBeanDefinitions.setAccessible(true);Map<String,RootBeanDefinition> rootBeanDefinitionMap =((Map<String,RootBeanDefinition>) mergedBeanDefinitions.get(beanFactory));for(String beanName : beanNames){
            beanFactory.removeBeanDefinition(beanName);// 父类bean定义去除
            rootBeanDefinitionMap.remove(beanName);}// 卸载父任务，子任务已经在循环中卸载
        jobHandlerRepository.remove(fileName);// 3.2 从类加载中移除try{// 从类加载器底层的classes中移除连接Field field =ClassLoader.class.getDeclaredField("classes");
            field.setAccessible(true);Vector<Class<?>> classes =(Vector<Class<?>>) field.get(myClassLoader);
            classes.removeAllElements();// 移除类加载器的引用
            myClassLoaderCenter.remove(fileName);// 卸载类加载器
            myClassLoader.unload();}catch(NoSuchFieldException e){
            logger.error("动态卸载的类，从类加载器中卸载失败");
            e.printStackTrace();}catch(IllegalAccessException e){
            logger.error("动态卸载的类，从类加载器中卸载失败");
            e.printStackTrace();}
        logger.error("{} 动态卸载成功", fileName);}

4、动态配置

使用动态加载时，为了避免服务重新启动后丢失已加载的任务包，使用动态配置的方式，加载后动态更新初始化加载配置。

以下提供了两种自己实际操作过的配置方式。

4.1 动态修改本地yml

动态修改本地yml配置文件，需要添加snakeyaml的依赖

4.1.1 依赖引入
<dependency><groupId>org.yaml</groupId><artifactId>snakeyaml</artifactId><version>1.29</version></dependency>
4.1.2 工具类

读取指定路径下的配置文件，并进行修改。

packagecom.jy.util;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.core.env.Environment;importorg.springframework.stereotype.Component;importorg.yaml.snakeyaml.DumperOptions;importorg.yaml.snakeyaml.Yaml;importjava.io.*;importjava.util.ArrayList;importjava.util.List;importjava.util.Map;importjava.util.stream.Collectors;/**
 * 用于动态修改bootstrap.yml配置文件
 * @author lijianyu
 * @date 2023/04/18 17:57
 **/@ComponentpublicclassConfigUpdater{publicvoidupdateLoadJars(List<String> jarNames)throwsIOException{// 读取bootstrap.ymlYaml yaml =newYaml();InputStream inputStream =newFileInputStream(newFile("src/main/resources/bootstrap.yml"));Map<String,Object> obj = yaml.load(inputStream);
        inputStream.close();

        obj.put("loadjars", jarNames);// 修改FileWriter writer =newFileWriter(newFile("src/main/resources/bootstrap.yml"));DumperOptions options =newDumperOptions();
        options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
        options.setPrettyFlow(true);Yaml yamlWriter =newYaml(options);
        yamlWriter.dump(obj, writer);}}

4.2 动态修改nacos配置

Spring Cloud Alibaba Nacos组件完全支持在运行时通过代码动态修改配置，还提供了一些API供开发者在代码里面实现动态修改配置。在每次动态加载或卸载数据治理任务jar包时，执行成功后都会进行动态更新nacos配置。

packagecn.jy.sjzl.config;importcom.alibaba.nacos.api.NacosFactory;importcom.alibaba.nacos.api.config.ConfigService;importcom.alibaba.nacos.api.exception.NacosException;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.Configuration;importjava.util.Properties;@ConfigurationpublicclassNacosConfig{@Value("${spring.cloud.nacos.server-addr}")privateString serverAddr;@Value("${spring.cloud.nacos.config.namespace}")privateString namespace;publicConfigServiceconfigService()throwsNacosException{Properties properties =newProperties();
        properties.put("serverAddr", serverAddr);
        properties.put("namespace", namespace);returnNacosFactory.createConfigService(properties);}}

packagecn.jy.sjzl.util;importcn.jy.sjzl.config.NacosConfig;importcom.alibaba.fastjson.JSONObject;importcom.alibaba.nacos.api.config.ConfigService;importcom.fasterxml.jackson.databind.ObjectMapper;importcom.fasterxml.jackson.dataformat.yaml.YAMLMapper;importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.stereotype.Component;importjava.util.ArrayList;importjava.util.List;importjava.util.stream.Collectors;/**
 * nacos配置中，修改sjzl-loadjars.yml
 *
 * @author lijianyu
 * @date 2023/04/19 17:59
 **/@ComponentpublicclassNacosConfigUtil{privatestaticLogger logger =LoggerFactory.getLogger(NacosConfigUtil.class);@AutowiredprivateNacosConfig nacosConfig;privateString dataId ="sjzl-loadjars.yml";@Value("${spring.cloud.nacos.config.group}")privateString group;/**
     * 从nacos配置文件中，添加初始化jar包配置
     * @param jarName 要移除的jar包名
     * @throws Exception
     */publicvoidaddJarName(String jarName)throwsException{ConfigService configService = nacosConfig.configService();String content = configService.getConfig(dataId, group,5000);// 修改配置文件内容YAMLMapper yamlMapper =newYAMLMapper();ObjectMapper jsonMapper =newObjectMapper();Object yamlObject = yamlMapper.readValue(content,Object.class);String jsonString = jsonMapper.writeValueAsString(yamlObject);JSONObject jsonObject =JSONObject.parseObject(jsonString);List<String> loadjars;if(jsonObject.containsKey("loadjars")){
            loadjars =(List<String>) jsonObject.get("loadjars");}else{
            loadjars =newArrayList<>();}if(!loadjars.contains(jarName)){
            loadjars.add(jarName);}
        jsonObject.put("loadjars", loadjars);Object yaml = yamlMapper.readValue(jsonMapper.writeValueAsString(jsonObject),Object.class);String newYamlString = yamlMapper.writeValueAsString(yaml);boolean b = configService.publishConfig(dataId, group, newYamlString);if(b){
            logger.info("nacos配置更新成功");}else{
            logger.info("nacos配置更新失败");}}}

三、分离打包

分离打包时，根据实际情况在pom.xml中修改以下配置

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.2.4</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><filters><filter><artifact>*:*</artifact><includes><include>com/jy/job/demo/**</include></includes></filter></filters><finalName>demoJob</finalName></configuration></execution></executions></plugin></plugins></build>
标签： spring boot jar java
本文转载自: https://blog.csdn.net/qq_45584746/article/details/130501254
版权归原作者 　小白 所有， 如有侵权，请联系我们删除。
登录后发布评论

“Java-springboot动态加载jar包，动态配置”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

盘点10款顶级加密软件，让你的数据更安全

2024ICPC网络赛第一场

cmake应用：集成gtest进行单元测试_cmake 使用 gtest

ubuntu20.04 安装vscode 并且配置环境

Windows下如何查看一个dll依赖的其他dll库

【C++】—— list 模拟实现

离线 VisualStudio2022 安装包在无互联网的环境下安装

文章导航