Mybatis 热部署 自动更新mapper映射文件

######################  myBatis xml mapper hot swap config start  ######################
#扫描周期,默认5秒,单位秒
mybatis.mapperRefresher.periodSeconds=1
#初始化完成,延迟扫描时间,默认5秒,单位秒,
mybatis.mapperRefresher.initialDelaySeconds=30
#是否启用mybatis热部署 默认:false
mybatis.mapperRefresher.enabled=true
######################  myBatis xml mapper hot swap config end  ######################
----------------------------------------------------

package zh.persistence.utils;

import java.io.IOException;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

import com.sibu.common.util.ExceptionUtil;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.NestedIOException;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.stereotype.Component;
import org.springframework.util.ClassUtils;

/**
 * @author 陈志杭
 * @contact 279397942@qq.com
 * @date 2016-12-13 16:00
 * @description MyBatis mapper xml 配置文件热加载
 */
@Component
@Slf4j
public class MyBatisMapperRefresher implements DisposableBean, InitializingBean, ApplicationContextAware {
    /**
     * 扫描周期,单位秒
     */
    @Value("${mybatis.mapperRefresher.periodSeconds:5}")
    private int periodSeconds = 5;
    /**
     * 初始化完成,延迟扫描时间,单位秒
     */
    @Value("${mybatis.mapperRefresher.initialDelaySeconds:5}")
    private int initialDelay = 5;
    /**
     * 是否启用
     */
    @Value("${mybatis.mapperRefresher.enabled:false}")
    private boolean enabled = false;
    private ConfigurableApplicationContext context = null;
    private transient Resource[] basePackage = null;
    private HashMap<String, String> fileMapping = new HashMap<String, String>();
    private Scanner scanner = null;
    private ScheduledExecutorService service = null;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.context = (ConfigurableApplicationContext) applicationContext;

    }

    @Override
    public void afterPropertiesSet() throws Exception {
        if (enabled == false) {
            log.info("MyBatisMapperRefresher is Disabled");
            return;
        }

        try {
            service = Executors.newScheduledThreadPool(1);
            // 获取xml所在包
            SqlSessionFactoryBean config = context.getBean(SqlSessionFactoryBean.class);
            Field field = config.getClass().getDeclaredField("mapperLocations");
            field.setAccessible(true);
            basePackage = (Resource[]) field.get(config);
            // 触发文件监听事件
            scanner = new Scanner();
            scanner.scan();
            service.scheduleAtFixedRate(new Task(), MyBatisMapperRefresher.this.initialDelay, MyBatisMapperRefresher.this.periodSeconds, TimeUnit.SECONDS);

        } catch (Exception e1) {
            log.error("can not starter Mybatis xml refresher,exception:{}", ExceptionUtil.getAsString(e1));
        }

    }

    class Task implements Runnable {
        @Override
        public void run() {
            try {
                if (scanner.isChanged()) {
                    scanner.reloadXML();
                }
            } catch (Exception ex) {
                log.error("MyBatisMapperRefresher,exception:{}", ExceptionUtil.getAsString(ex));
            }
        }
    }

    @SuppressWarnings({"rawtypes"})
    class Scanner {
        private Resource[] mapperXmlFiles;

        public Scanner() {
            mapperXmlFiles = MyBatisMapperRefresher.this.basePackage;
        }

        public void reloadXML() throws Exception {
            SqlSessionFactory factory = context.getBean(SqlSessionFactory.class);
            Configuration configuration = factory.getConfiguration();
            // 移除加载项
            removeConfig(configuration);
            // 重新扫描加载

            Resource[] resources = mapperXmlFiles;
            if (resources != null) {
                for (int i = 0; i < resources.length; i++) {
                    if (resources[i] == null) {
                        continue;
                    }
                    try {
                        XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(resources[i].getInputStream(),
                                configuration, resources[i].toString(), configuration.getSqlFragments());
                        xmlMapperBuilder.parse();
                    } catch (Exception e) {
                        log.error("please fixup to repeat hot swap,failed to parse mapping resource: {},exception:{}", resources[i].getFilename(), ExceptionUtil.getAsString(e));
                        break;
                    } finally {
                        ErrorContext.instance().reset();
                    }
                }
            }
        }


        private void removeConfig(Configuration configuration) throws Exception {
            Class<?> classConfig = configuration.getClass();
            clearMap(classConfig, configuration, "mappedStatements");
            clearMap(classConfig, configuration, "caches");
            clearMap(classConfig, configuration, "resultMaps");
            clearMap(classConfig, configuration, "parameterMaps");
            clearMap(classConfig, configuration, "keyGenerators");
            clearMap(classConfig, configuration, "sqlFragments");
            clearSet(classConfig, configuration, "loadedResources");

        }

        private void clearMap(Class<?> classConfig, Configuration configuration, String fieldName) throws Exception {
            Field field = classConfig.getDeclaredField(fieldName);
            field.setAccessible(true);
            Map mapConfig = (Map) field.get(configuration);
            mapConfig.clear();
        }

        private void clearSet(Class<?> classConfig, Configuration configuration, String fieldName) throws Exception {
            Field field = classConfig.getDeclaredField(fieldName);
            field.setAccessible(true);
            Set setConfig = (Set) field.get(configuration);
            setConfig.clear();
        }

        public void scan() throws IOException {
            if (!fileMapping.isEmpty()) {
                return;
            }

            Resource[] resources = mapperXmlFiles;
            if (resources != null) {
                for (int i = 0; i < resources.length; i++) {
                    String multi_key = getValue(resources[i]);
                    String fileName = resources[i].getFilename();
                    fileMapping.put(fileName, multi_key);
                    log.info("monitor Mybatis mapper file:{}",  resources[i].getFile().getAbsolutePath());
                }
            }

        }

        private String getValue(Resource resource) throws IOException {
            String contentLength = String.valueOf((resource.contentLength()));
            String lastModified = String.valueOf((resource.lastModified()));
            return new StringBuilder(contentLength).append(lastModified).toString();
        }

        public boolean isChanged() throws IOException {
            boolean isChanged = false;

            Resource[] resources = mapperXmlFiles;
            if (resources != null) {
                for (int i = 0; i < resources.length; i++) {
                    String name = resources[i].getFilename();
                    String value = fileMapping.get(name);
                    String multi_key = getValue(resources[i]);
                    if (!multi_key.equals(value)) {
                        isChanged = true;
                        fileMapping.put(name, multi_key);
                        log.info("reload Mybatis mapper file:{}", resources[i].getFile().getAbsolutePath());
                    }
                }
            }

            return isChanged;
        }

    }

    @Override
    public void destroy() throws Exception {
        if (service != null) {
            service.shutdownNow();
        }
    }

}

转载于:https://my.oschina.net/u/3138683/blog/805520

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
MyBatis 是一款使用 XML 或注解配置的持久层框架,它可以自动化地将数据库中的数据映射Java 对象中。在 MyBatis 中,mappermapper.xml 是配对使用的,其中 mapper 是接口,而 mapper.xml 是映射配置文件mapper 接口中定义了数据库操作的方法,而 mapper.xml 中则定义了这些方法的 SQL 语句以及参数映射规则、结果集映射规则等。 下面是一个简单的例子: 1. 定义 mapper 接口 ```java public interface UserMapper { User selectUserById(Integer id); } ``` 2. 定义 mapper.xml 映射配置文件 ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.example.UserMapper"> <resultMap id="userResultMap" type="com.example.User"> <id column="id" property="id"/> <result column="username" property="username"/> <result column="password" property="password"/> </resultMap> <select id="selectUserById" resultMap="userResultMap"> SELECT * FROM user WHERE id = #{id} </select> </mapper> ``` 上述代码中,namespace 属性指定了 mapper 接口的全限定名,resultMap 标签定义了一个结果集映射规则,select 标签定义了一个查询操作,其中 id 属性指定了 mapper 接口中的方法名,resultMap 属性指定了结果集映射规则的 id。 3. 在 MyBatis 配置文件中引入 mapper.xml ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <mappers> <mapper resource="com/example/UserMapper.xml"/> </mappers> </configuration> ``` 上述代码中,mapper 标签指定了映射配置文件的位置。 这样就完成了 mappermapper.xml 的配置。在代码中调用 selectUserById 方法时,MyBatis 会根据 mapper.xml 中的配置自动生成 SQL 语句,并将查询结果映射到 User 对象中。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值