mybatis?xml文件熱加載實(shí)現(xiàn)示例詳解

更新時(shí)間：2023年03月26日 16:33:46 作者：wayn

這篇文章主要為大家介紹了mybatis?xml文件熱加載實(shí)現(xiàn)示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

引言

本文博主給大家?guī)硪黄?mybatis xml 文件熱加載的實(shí)現(xiàn)教程，自博主從事開發(fā)工作使用 Mybatis 以來，如果需要修改 xml 文件的內(nèi)容，通常都需要重啟項(xiàng)目，因?yàn)椴恢貑⒌脑挘薷氖遣簧У?，Mybatis 僅僅會(huì)在項(xiàng)目初始化的時(shí)候?qū)?xml 文件加載進(jìn)內(nèi)存。

本著提升開發(fā)效率且網(wǎng)上沒有能夠直接使用的輪子初衷，博主自己開發(fā)了 mybatis-xmlreload-spring-boot-starter 這個(gè)項(xiàng)目。它能夠幫助我們在Spring Boot + Mybatis的開發(fā)環(huán)境中修改 xml 后，不需要重啟項(xiàng)目就能讓修改過后 xml 文件立即生效，實(shí)現(xiàn)熱加載功能。這里先給出項(xiàng)目地址：

一、xml 文件熱加載實(shí)現(xiàn)原理

1.1 xml 文件怎么樣解析

在Spring Boot + Mybatis的常規(guī)項(xiàng)目中，通過 org.mybatis.spring.SqlSessionFactoryBean 這個(gè)類的 buildSqlSessionFactory() 方法完成對 xml 文件的加載邏輯，這個(gè)方法只會(huì)在自動(dòng)配置類 MybatisAutoConfiguration 初始化操作時(shí)進(jìn)行調(diào)用。這里把 buildSqlSessionFactory() 方法中 xml 解析核心部分進(jìn)行展示如下：

通過遍歷 this.mapperLocations 數(shù)組（這個(gè)對象就是保存了編譯后的所有 xml 文件）完成對所有 xml 文件的解析以及加載進(jìn)內(nèi)存。this.mapperLocations 解析邏輯在 MybatisProperties 類的 resolveMapperLocations() 方法中，它會(huì)解析 mybatis.mapperLocations 屬性中的 xml 路徑，將編譯后的 xml 文件讀取進(jìn) Resource 數(shù)組中。路徑解析的核心邏輯在 PathMatchingResourcePatternResolver 類的 getResources(String locationPattern) 方法中。大家有興趣可以自己研讀一下，這里不多做介紹。

通過 xmlMapperBuilder.parse() 方法解析 xml 文件各個(gè)節(jié)點(diǎn)，解析方法如下：

到這里，我們就知道了 Mybatis 對 xml 文件解析是通過 xmlMapperBuilder.parse() 方法完成并且只會(huì)在項(xiàng)目啟動(dòng)時(shí)加載 xml 文件。

1.2 實(shí)現(xiàn)思路

通過對上述 xml 解析邏輯進(jìn)行分析，我們可以通過監(jiān)聽 xml 文件的修改，當(dāng)監(jiān)聽到修改操作時(shí)，直接調(diào)用 xmlMapperBuilder.parse() 方法，將修改過后的 xml 文件進(jìn)行重新解析，并替換內(nèi)存中的對應(yīng)屬性以此完成熱加載操作。這里也就引出了本文所講的主角：mybatis-xmlreload-spring-boot-starter

二、mybatis-xmlreload-spring-boot-starter 登場

mybatis-xmlreload-spring-boot-starter 這個(gè)項(xiàng)目完成了博主上述的實(shí)現(xiàn)思路，使用技術(shù)如下：

修改 xml 文件的加載邏輯。在原用 mybatis-spring 中，只會(huì)加載項(xiàng)目編譯過后的 xml 文件，也就是 target 目錄下的 xml 文件。但是在mybatis-xmlreload-spring-boot-starter中，我修改了這一點(diǎn)，它會(huì)加載項(xiàng)目 resources 目錄下的 xml 文件，這樣對于 xml 文件的修改操作是可以立馬觸發(fā)熱加載的。
通過 io.methvin.directory-watcher 來監(jiān)聽 xml 文件的修改操作，它底層是通過 java.nio 的WatchService 來實(shí)現(xiàn)。
兼容 Mybatis-plus3.0，核心代碼兼容了 Mybatis-plus 自定義的 com.baomidou.mybatisplus.core.MybatisConfiguration 類，任然可以使用 xml 文件熱加載功能。

2.1 核心代碼

項(xiàng)目的結(jié)構(gòu)如下：

核心代碼在 MybatisXmlReload 類中，代碼展示：

/**
 * mybatis-xml-reload核心xml熱加載邏輯
 */
public class MybatisXmlReload {
    private static final Logger logger = LoggerFactory.getLogger(MybatisXmlReload.class);
    /**
     * 是否啟動(dòng)以及xml路徑的配置類
     */
    private MybatisXmlReloadProperties prop;
    /**
     * 獲取項(xiàng)目中初始化完成的SqlSessionFactory列表，對多數(shù)據(jù)源進(jìn)行處理
     */
    private List<SqlSessionFactory> sqlSessionFactories;
    public MybatisXmlReload(MybatisXmlReloadProperties prop, List<SqlSessionFactory> sqlSessionFactories) {
        this.prop = prop;
        this.sqlSessionFactories = sqlSessionFactories;
    }
    public void xmlReload() throws IOException {
        PathMatchingResourcePatternResolver patternResolver = new PathMatchingResourcePatternResolver();
        String CLASS_PATH_TARGET = File.separator + "target" + File.separator + "classes";
        String MAVEN_RESOURCES = "/src/main/resources";
        // 1. 解析項(xiàng)目所有xml路徑，獲取xml文件在target目錄中的位置
        List<Resource> mapperLocationsTmp = Stream.of(Optional.of(prop.getMapperLocations()).orElse(new String[0]))
                .flatMap(location -> Stream.of(getResources(patternResolver, location))).toList();
        List<Resource> mapperLocations = new ArrayList<>(mapperLocationsTmp.size() * 2);
        Set<Path> locationPatternSet = new HashSet<>();
        // 2. 根據(jù)xml文件在target目錄下的位置，進(jìn)行路徑替換找到該xml文件在resources目錄下的位置
        for (Resource mapperLocation : mapperLocationsTmp) {
            mapperLocations.add(mapperLocation);
            String absolutePath = mapperLocation.getFile().getAbsolutePath();
            File tmpFile = new File(absolutePath.replace(CLASS_PATH_TARGET, MAVEN_RESOURCES));
            if (tmpFile.exists()) {
                locationPatternSet.add(Path.of(tmpFile.getParent()));
                FileSystemResource fileSystemResource = new FileSystemResource(tmpFile);
                mapperLocations.add(fileSystemResource);
            }
        }
        // 3. 對resources目錄的xml文件修改進(jìn)行監(jiān)聽
        List<Path> rootPaths = new ArrayList<>();
        rootPaths.addAll(locationPatternSet);
        DirectoryWatcher watcher = DirectoryWatcher.builder()
                .paths(rootPaths) // or use paths(directoriesToWatch)
                .listener(event -> {
                    switch (event.eventType()) {
                        case CREATE: /* file created */
                            break;
                        case MODIFY: /* file modified */
                            Path modifyPath = event.path();
                            String absolutePath = modifyPath.toFile().getAbsolutePath();
                            logger.info("mybatis xml file has changed:" + modifyPath);
                            // 4. 對多個(gè)數(shù)據(jù)源進(jìn)行遍歷，判斷修改過的xml文件屬于那個(gè)數(shù)據(jù)源
                            for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) {
                                try {
                                    // 5. 獲取Configuration對象
                                    Configuration targetConfiguration = sqlSessionFactory.getConfiguration();
                                    Class<?> tClass = targetConfiguration.getClass(), aClass = targetConfiguration.getClass();
                                    if (targetConfiguration.getClass().getSimpleName().equals("MybatisConfiguration")) {
                                        aClass = Configuration.class;
                                    }
                                    Set<String> loadedResources = (Set<String>) getFieldValue(targetConfiguration, aClass, "loadedResources");
                                    loadedResources.clear();
                                    Map<String, ResultMap> resultMaps = (Map<String, ResultMap>) getFieldValue(targetConfiguration, tClass, "resultMaps");
                                    Map<String, XNode> sqlFragmentsMaps = (Map<String, XNode>) getFieldValue(targetConfiguration, tClass, "sqlFragments");
                                    Map<String, MappedStatement> mappedStatementMaps = (Map<String, MappedStatement>) getFieldValue(targetConfiguration, tClass, "mappedStatements");
                                    // 6. 遍歷xml文件
                                    for (Resource mapperLocation : mapperLocations) {
                                        // 7. 判斷是否是被修改過的xml文件，否則跳過
                                        if (!absolutePath.equals(mapperLocation.getFile().getAbsolutePath())) {
                                            continue;
                                        }
                                        // 8. 重新解析xml文件，替換Configuration對象的相對應(yīng)屬性
                                        XPathParser parser = new XPathParser(mapperLocation.getInputStream(), true, targetConfiguration.getVariables(), new XMLMapperEntityResolver());
                                        XNode mapperXnode = parser.evalNode("/mapper");
                                        List<XNode> resultMapNodes = mapperXnode.evalNodes("/mapper/resultMap");
                                        String namespace = mapperXnode.getStringAttribute("namespace");
                                        for (XNode xNode : resultMapNodes) {
                                            String id = xNode.getStringAttribute("id", xNode.getValueBasedIdentifier());
                                            resultMaps.remove(namespace + "." + id);
                                        }
                                        List<XNode> sqlNodes = mapperXnode.evalNodes("/mapper/sql");
                                        for (XNode sqlNode : sqlNodes) {
                                            String id = sqlNode.getStringAttribute("id", sqlNode.getValueBasedIdentifier());
                                            sqlFragmentsMaps.remove(namespace + "." + id);
                                        }
                                        List<XNode> msNodes = mapperXnode.evalNodes("select|insert|update|delete");
                                        for (XNode msNode : msNodes) {
                                            String id = msNode.getStringAttribute("id", msNode.getValueBasedIdentifier());
                                            mappedStatementMaps.remove(namespace + "." + id);
                                        }
                                        try {
                                            // 9. 重新加載和解析被修改的 xml 文件
                                            XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
                                                    targetConfiguration, mapperLocation.toString(), targetConfiguration.getSqlFragments());
                                            xmlMapperBuilder.parse();
                                        } catch (Exception e) {
                                            logger.error(e.getMessage(), e);
                                        }
                                        logger.info("Parsed mapper file: '" + mapperLocation + "'");
                                    }
                                } catch (Exception e) {
                                    logger.error(e.getMessage(), e);
                                }
                            }
                            break;
                        case DELETE: /* file deleted */
                            break;
                    }
                })
                .build();
        ThreadFactory threadFactory = r -> {
            Thread thread = new Thread(r);
            thread.setName("xml-reload");
            thread.setDaemon(true);
            return thread;
        };
        watcher.watchAsync(new ScheduledThreadPoolExecutor(1, threadFactory));
    }
    /**
     * 根據(jù)xml路徑獲取對應(yīng)實(shí)際文件
     *
     * @param location 文件位置
     * @return Resource[]
     */
    private Resource[] getResources(PathMatchingResourcePatternResolver patternResolver, String location) {
        try {
            return patternResolver.getResources(location);
        } catch (IOException e) {
            return new Resource[0];
        }
    }
    /**
     * 根據(jù)反射獲取 Configuration 對象中屬性
     */
    private static Object getFieldValue(Configuration targetConfiguration, Class<?> aClass,
                                        String filed) throws NoSuchFieldException, IllegalAccessException {
        Field resultMapsField = aClass.getDeclaredField(filed);
        resultMapsField.setAccessible(true);
        return resultMapsField.get(targetConfiguration);
    }
}

代碼執(zhí)行邏輯：

解析配置文件指定的 xml 路徑，獲取 xml 文件在 target 目錄下的位置
根據(jù) xml 文件在 target 目錄下的位置，進(jìn)行路徑替換找到 xml 文件所在 resources 目錄下的位置
對 resources 目錄的 xml 文件的修改操作進(jìn)行監(jiān)聽
對多個(gè)數(shù)據(jù)源進(jìn)行遍歷，判斷修改過的 xml 文件屬于那個(gè)數(shù)據(jù)源
根據(jù) Configuration 對象獲取對應(yīng)的標(biāo)簽屬性
遍歷 resources 目錄下 xml 文件列表
判斷是否是被修改過的 xml 文件，否則跳過
解析被修改的 xml 文件，替換 Configuration 對象中的相對應(yīng)屬性
重新加載和解析被修改的 xml 文件

2.2 安裝方式

在 Spring Boot3.0 中，當(dāng)前博主提供了mybatis-xmlreload-spring-boot-starter在 Maven 項(xiàng)目中的坐標(biāo)地址如下

<dependency>
    <groupId>com.wayn</groupId>
    <artifactId>mybatis-xmlreload-spring-boot-starter</artifactId>
    <version>3.0.3.m1</version>
</dependency>

在 Spring Boot2.0 Maven 項(xiàng)目中的坐標(biāo)地址如下

<dependency>
    <groupId>com.wayn</groupId>
    <artifactId>mybatis-xmlreload-spring-boot-starter</artifactId>
    <version>2.0.1.m1</version>
</dependency>

2.3 使用配置

Maven 項(xiàng)目寫入mybatis-xmlreload-spring-boot-starter坐標(biāo)后即可使用本項(xiàng)目功能，默認(rèn)是不啟用 xml 文件的熱加載功能，想要開啟的話通過在項(xiàng)目配置文件中設(shè)置 mybatis-xml-reload.enabled 為 true，并指定 mybatis-xml-reload.mapper-locations 屬性，也就是 xml 文件位置即可啟動(dòng)。具體配置如下：

# mybatis xml文件熱加載配置
mybatis-xml-reload:
  # 是否開啟 xml 熱更新，true開啟，false不開啟，默認(rèn)為false
  enabled: true 
  # xml文件位置，eg: `classpath*:mapper/**/*Mapper.xml,classpath*:other/**/*Mapper.xml`
  mapper-locations: classpath:mapper/*Mapper.xml