Mybatis实现*mapper.xml热部署-分子级更新

已于 2022-01-18 20:43:30 修改
阅读量2w 收藏 26
点赞数 11
分类专栏： ShowMeCode 文章标签： Mybatis mapper 热部署
于 2018-12-20 12:45:07 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chao_1990/article/details/85116284
版权

需求：

项目在开发阶段或是修复bug阶段，会有修改mybatis的mapper.xml的时候，修改一般情况都要重启才能生失效，如果是分布式项目重启有时会耗时很久，都是无尽的等待。如果频繁修改，那么时间都浪费到等待重启的过程。

目标：

实现mybatis的mapper.xml文件修改后热部署，而且只热更新修改了的xml，可以提高重新解析过程的效率。

要求：

尽量满足开闭原则

实现：

import com.yirun.framework.core.utils.PropertiesHolder;
import org.apache.commons.lang.StringUtils;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.builder.xml.XMLMapperEntityResolver;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.parsing.XPathParser;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.io.Resource;

import java.lang.reflect.Field;
import java.nio.file.*;
import java.util.*;
import java.util.stream.Collectors;

/**
*  mapper.xml热部署，最小单位是一个xml文件
*  @date                    ：2018/12/20
*  @author                  ：zc.ding@foxmail.com
*/
public class MapperHotDeployPlugin implements InitializingBean, ApplicationContextAware {
    private final static Logger logger = LoggerFactory.getLogger(MapperHotDeployPlugin.class);
    private final static String OPEN = "1";
    private volatile SqlSessionFactoryBean sqlSessionFactoryBean;
    private volatile Configuration configuration;
    
    @Override
    public void afterPropertiesSet() {
        String flag = PropertiesHolder.getProperty("mapper.hot.deploy");
        logger.info("Mybatis热部署标识mapper.hot.deploy={}", flag);
        // 判断是否开启了热部署
        if(StringUtils.isNotBlank(flag) && OPEN.equals(flag)){
            new WatchThread().start();
        }
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SqlSessionFactory sqlSessionFactory = (SqlSessionFactory) applicationContext.getBean("frameworkSqlSessionFactory");
        sqlSessionFactoryBean = applicationContext.getBean(SqlSessionFactoryBean.class);
        configuration = sqlSessionFactory.getConfiguration();
    }
    
    class WatchThread extends Thread{
        private final Logger logger = LoggerFactory.getLogger(WatchThread.class);
        @Override
        public void run() {
            startWatch();
        }

        /**
         *  启动监听
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private void startWatch(){
            try{
                WatchService watcher = FileSystems.getDefault().newWatchService();
                getWatchPaths().forEach(p -> {
                    try {
                        Paths.get(p).register(watcher, StandardWatchEventKinds.ENTRY_MODIFY);
                    } catch (Exception e) {
                        logger.error("ERROR: 注册xml监听事件", e);
                        throw new RuntimeException("ERROR: 注册xml监听事件", e);
                    }
                });
                while (true) {
                    WatchKey watchKey = watcher.take();
                    Set<String> set = new HashSet<>();
                    for (WatchEvent<?> event: watchKey.pollEvents()) {
                        set.add(event.context().toString());
                    }
                    // 重新加载xml
                    reloadXml(set);
                    boolean valid = watchKey.reset();
                    if (!valid) {
                        break;
                    }
                }
            }catch(Exception e){
                System.out.println("Mybatis的xml监控失败!");
                logger.info("Mybatis的xml监控失败!", e);
            }
        }

        /**
         *  加载需要监控的文件父路径
         *  @return java.util.Set<java.lang.String>
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private Set<String> getWatchPaths(){
            Set<String> set = new HashSet<>();
            Arrays.stream(getResource()).forEach(r -> {
                try{
                    logger.info("资源路径:{}", r.toString());
                    set.add(r.getFile().getParentFile().getAbsolutePath());
                }catch(Exception e){
                    logger.info("获取资源路径失败", e);
                    throw new RuntimeException("获取资源路径失败");
                }
            });
            logger.info("需要监听的xml资源: {}", set);
            return set;
        }

        /**
         *  获取配置的mapperLocations
         *  @return org.springframework.core.io.Resource[]
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private Resource[] getResource(){
            return (Resource[]) getFieldValue(sqlSessionFactoryBean, "mapperLocations");
        }

        /**
         *  删除xml元素的节点缓存
         *  @param nameSpace xml中命名空间
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private void clearMap(String nameSpace) {
            logger.info("清理Mybatis的namespace={}在mappedStatements、caches、resultMaps、parameterMaps、keyGenerators、sqlFragments中的缓存");
            Arrays.asList("mappedStatements", "caches", "resultMaps", "parameterMaps", "keyGenerators", "sqlFragments").forEach(fieldName -> {
                Object value = getFieldValue(configuration, fieldName);
                if (value instanceof Map) {
                    Map<?, ?> map = (Map)value;
                    List<Object> list = map.keySet().stream().filter(o -> o.toString().startsWith(nameSpace + ".")).collect(Collectors.toList());
                    logger.info("需要清理的元素: {}", list);
                    list.forEach(k -> map.remove((Object)k));
                }
            });
        }

        /**
         *  清除文件记录缓存
         *  @param resource xml文件路径
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private void clearSet(String resource) {
            logger.info("清理mybatis的资源{}在容器中的缓存", resource);
            Object value = getFieldValue(configuration, "loadedResources");
            if (value instanceof Set) {
                Set<?> set = (Set)value;
                set.remove(resource);
                set.remove("namespace:" + resource);
            }
        }

        /**
         *  获取对象指定属性
         *  @param obj 对象信息
         *  @param fieldName 属性名称
         *  @return java.lang.Object
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private Object getFieldValue(Object obj, String fieldName){
            logger.info("从{}中加载{}属性", obj, fieldName);
            try{
                Field field = obj.getClass().getDeclaredField(fieldName);
                boolean accessible = field.isAccessible();
                field.setAccessible(true);
                Object value = field.get(obj);
                field.setAccessible(accessible);
                return value;
            }catch(Exception e){
                logger.info("ERROR: 加载对象中[{}]", fieldName, e);
                throw new RuntimeException("ERROR: 加载对象中[" + fieldName + "]", e);
            }
        }

        /**
         *  重新加载set中xml
         *  @param set 修改的xml资源
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private void reloadXml(Set<String> set){
            logger.info("需要重新加载的文件列表: {}", set);
            List<Resource> list = Arrays.stream(getResource())
                    .filter(p -> set.contains(p.getFilename()))
                    .collect(Collectors.toList());
            logger.info("需要处理的资源路径:{}", list);
            list.forEach(r ->{
                try{
                    clearMap(getNamespace(r));
                    clearSet(r.toString());
                    XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(r.getInputStream(), configuration,
                            r.toString(), configuration.getSqlFragments());
                    xmlMapperBuilder.parse();
                }catch(Exception e){
                    logger.info("ERROR: 重新加载[{}]失败", r.toString(), e);
                    throw new RuntimeException("ERROR: 重新加载[" + r.toString() + "]失败", e);
                }finally {
                    ErrorContext.instance().reset();
                }
            });
            logger.info("成功热部署文件列表: {}", set);
        }

        /**
         *  获取xml的namespace
         *  @param resource xml资源
         *  @return java.lang.String
         *  @date                    ：2018/12/19
         *  @author                  ：zc.ding@foxmail.com
         */
        private String getNamespace(Resource resource){
            logger.info("从{}获取namespace", resource.toString());
            try{
                XPathParser parser = new XPathParser(resource.getInputStream(), true, null, new XMLMapperEntityResolver());
                return parser.evalNode("/mapper").getStringAttribute("namespace");
            }catch(Exception e){
                logger.info("ERROR: 解析xml中namespace失败", e);
                throw new RuntimeException("ERROR: 解析xml中namespace失败", e);
            }
        }
    }
}

使用方式：

<bean id="mapperHotDeploy" class="com.xxxxx.plugins.MapperHotDeployPlugin"/>

通过mapper.hot.deploy属性配置启停

待优化：

支持单数据源，使用开发环境

结语：

使用简单、无入侵、满足开闭原则。good luck!

冥王 • 雷利
关注
专栏目录
MyBatis-Plus XML热加载：实时修改XML映射文件，无需重启应用程序
奇妙的Bug之旅
01-02 1523
MyBatis-Plus是基于MyBatis框架的增强工具包，提供了许多便捷的功能以简化开发过程。其中一个重要功能是XML热加载，它允许我们在运行时动态修改MyBatis的XML映射文件，无需重新部署应用程序。在本文中，我们将详细讨论MyBatis-Plus XML热加载的实现原理，并给出相关的代码示例。通过以上步骤的演示，我们可以看到MyBatis-Plus XML热加载功能的强大之处。在修改XML映射文件后，无需重启应用程序，就能够立即生效。
mybatis中***Mapper.xml映射文件的配置细节
回家养老
11-22 3023
mapper映射文件9大元素 映射文件是以&lt;mapper&gt;作为根节点，在根节点中支持9个元素，分别为 insert、update、delete、select（增删改查）; cache、cache-ref、resultMap、parameterMap、sql。 例子： &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!DOCT...
mybatis修改了mapper xml不用重启tomcat，热发布热更新.zip_mybatis的xml模糊查询
01-07
mybatis修改了mapper xml不用重启tomcat，热发布热更新.zip
Mybatis的XxMapper.xml详解
最新发布
小鸡腿儿的博客
08-19 920
Mapper XML 文件用法详解 #{} ${} 区别，常用标签等用法，参数用法，支持的jdbc类型，关联关系如何构造夺标sql等，一篇文章就足够了
mybatis动态更新xml文件后热部署,不重启应用的方法
杨航的专栏
08-12 7243
mybatis应用程序，由于是半自动化的sql, 有大量的sql是在xml文件中配置的，而在开发程序的过程中，通常需要边写sql变调试应用。但在默认情况下，xml文件里配置的sql语句是被放入到缓存中去了，每次更改有sql语句的xml文件，需要重新启动应用，这样工作效率很低，于是很希望有一个动态加载xml文件的功能，自动加载新的sql语句，并重新写入到缓存中，在网上参考了很多资料，最终弄了一个简单...
实现项目启动之后，修改Mapper XML内容不用重启即可生效（mapper文件热部署）
热门推荐
种一棵树最好的时间是十年前，其次是现在。
12-30 2万+
在日常开发中，如果启动项目后，再次修改Mapper XML文件，必须重启服务才能生效，这样就大大影响了我们的开发效率。在近期接触到的项目里面，有个这个功能，趁着假期，查了些资料，将里面的用法拿出来，记录一下： 具体的源码还没来得及研究，水平有限，也看不懂源码。。。。。。。。。。 实际就是重写了mybatis的加载xml文件的方法 这里重建一个完整的maven-demo，顺便记录一下maven搭建w...
IntelliJ IDEA修改了mybatis mapper xml后不用重启tomcat,自动热发布 热更新 热部署.zip
01-07
IntelliJ IDEA修改了mybatis mapper xml后自动热发布 热更新 热部署.zip Mybatis xml文件使用热加载检测不更新怎么办?看我的
mybatis热部署mapper增量更新.
01-12
通常项目中如果修改mapper.xml文件 就要重启服务器才生效.本资源直接换包即用.实现热部署
mybatis-3-config.dtd mybatis-3-mapper.dtd
06-04
MyBatis是一个强大的Java持久层框架，它简化了数据库与Java应用程序之间的交互，提供了一种灵活的映射机制，使得开发者能够将SQL语句直接写在XML或注解中。在MyBatis的配置和使用过程中，有两个核心的DTD（Document ...
详解mybatis-plus的 mapper.xml 路径配置的坑
09-07
例如，如果XML文件位于`src/main/resources/myfolder/mapper`，可以通过添加`mybatis-plus.mapper-locations`属性来设置，如下： ```java @Configuration @MapperScan("com.husy.mapper") public class Mybatis...
mybatis-3-mapper.rar
08-06
MyBatis是一个流行的Java持久层框架，它简化了数据库操作，通过XML或注解的方式将SQL与Java代码绑定，使得开发者能够更专注于SQL本身。在处理`mybatis-3-mapper.dtd`这个问题时，我们需要深入理解MyBatis的Mapper...
mybatis-3-config/mapper.dtd 解决mybatis头文件报错
04-10
然后打开eclipse ->Window->prefenrence->XML->XML Catalog->User Specifiled Entreis->Add->Location(此处是你放dtd文件的位置例如：‪D:\mybatis\mybatis-3-config.dtd)->Key(如果更改config，此处应该是：-//...
mybatis.xml热部署
qq_25881443的博客
08-06 371
mybatis.xml热部署
mybatis热部署加载*Mapper.xml文件
CS568591377的专栏
07-18 1万+
文章内容下周整理
JRebel热部署SpringBoot+MyBatis+MyBatis-Plus实现不重启更新修改后MyBatis的XML文件
Meta39的博客
04-23 1613
JRebel热部署SpringBoot+MyBatis+MyBatis-Plus实现不重启更新修改后MyBatis的XML文件
IDEA的热部署【MyBatis XML热部署 】
今天又是充满希望的一天
03-29 4308
IDEA开发热部署，MyBatis热部署
热加载 MyBatis 中修改过的 Mapper.xml
zz153417230的博客
03-30 975
项目中使用的是 MyBatis, 在开发过程中, 每次修改完 SQL 都需要重新启动一遍项目, 非常耗时, 影响开发效率. 所以非常有必要热加载 修改过的 Mapper.xml 文件.如果没有使用 Lombok, 直接删掉日志输出或者使用。过几秒钟, 控制台即可看到更新的文件.修改完 SQL 以后, 更新一下资源。
SpringBoot热部署和整合Mybatis
qq_53317005的博客
10-16 4050
热部署，就是在应用正在运行的时候升级软件，却不需要重新启动应用。即修改完代码后不需要重启项目即可生效。在SpringBoot中，可以使用DevTools工具实现热部署。
【mybatis】支持xml热加载
掘金者说
05-13 579
mybatis-xml-reload 支持xml文件热更新功能。
mybatis的*mapper.xml配置
04-03
MyBatis的mapper.xml配置文件主要用于定义SQL映射关系和参数映射关系，以下是一个示例： ```xml <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.example.mapper.UserMapper"> <select id="getUserById" resultType="com.example.model.User"> SELECT * FROM user WHERE id=#{id} </select> <insert id="insertUser" parameterType="com.example.model.User"> INSERT INTO user (name, age) VALUES (#{name}, #{age}) </insert> <update id="updateUser" parameterType="com.example.model.User"> UPDATE user SET name=#{name}, age=#{age} WHERE id=#{id} </update> <delete id="deleteUserById" parameterType="int"> DELETE FROM user WHERE id=#{id} </delete> </mapper> ``` 其中，`namespace`属性指定了映射器接口的完全限定名，`select`、`insert`、`update`和`delete`标签分别对应SQL的查询、插入、更新和删除操作，`id`属性为SQL语句的唯一标识符，`parameterType`属性指定输入参数的类型，`resultType`属性指定输出结果的类型。SQL语句中的`#{}`表示占位符，MyBatis会根据参数映射关系将占位符替换成实际的参数值。
评论 19
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值