怎么使用mybatis-xmlreload實現修改xml文件再也不用重啟項目

今天小編給大家分享一下怎么使用mybatis-xmlreload實現修改xml文件再也不用重啟項目的相關知識點，內容詳細，邏輯清晰，相信大部分人都還太了解這方面的知識，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來了解一下吧。

ps：mybatis-xmlreload-spring-boot-starter目前 3.0.3.m1 版本實現了 xml 文件修改已有內容，比如修改 sql 語句、添加查詢字段、添加查詢條件等，可以實現熱加載功能。但是對于 xml 文件添加 insert|update|delete|select 標簽等內容后，是無法實現熱加載的。眾所周知，在 Idea 環境進行 Java 開發，在方法內修改方法內容是可以熱加載的。但是添加新方法、添加方法參數，修改方法參數，修改方法返回值等都是無法直接熱加載的。

一、mybatis-xmlreload-spring-boot-starter使用

mybatis-xmlreload-spring-boot-starter原理：

• 修改 xml 文件的加載邏輯。在普通的 mybatis-spring 項目中，默認只會加載項目編譯過后的 xml 文件，也就是 target 目錄下的 xml 文件。但是在mybatis-xmlreload-spring-boot-starter中，修改了這一點，它會加載項目 resources 目錄下的 xml 文件，這樣用戶對于 resources 目錄下 xml 文件的修改操作是可以立即觸發熱加載的。

• 通過 io.methvin.directory-watcher 項目來監聽 xml 文件的修改操作，它底層是通過 java.nio 的WatchService 來實現，當我們監聽了整個 resources 目錄后，xml 文件的修改會立馬觸發 MODIFY 事件。

• 通過 mybatis-spring 項目原生的 xmlMapperBuilder.parse() 方法重新加載解析修改過后的 xml 文件來保證項目對于 Mybatis 的兼容性處理。

二、技術原理

mybatis-xmlreload-spring-boot-starter代碼結構如下：

核心代碼在MybatisXmlReload類中，執行邏輯：

• 通過項目初始化時傳入 MybatisXmlReloadProperties prop, List<SqlSessionFactory> sqlSessionFactories 參數，獲取mybatis-xmlreload-spring-boot-starter的配置信息，以及項目中的數據源配置

    /**
     * 是否啟動以及xml路徑的配置類
     */
    private MybatisXmlReloadProperties prop;
    /**
     * 獲取項目中初始化完成的SqlSessionFactory列表，對多數據源進行處理
     */
    private List<SqlSessionFactory> sqlSessionFactories;
    public MybatisXmlReload(MybatisXmlReloadProperties prop, 
            List<SqlSessionFactory> sqlSessionFactories) {
        this.prop = prop;
        this.sqlSessionFactories = sqlSessionFactories;
    }

• 解析配置文件指定的 xml 路徑，獲取 xml 文件在 target 目錄下的位置

    // 解析項目所有xml路徑，獲取xml文件在target目錄中的位置
    List<Resource> mapperLocationsTmp = Stream.of(Optional.of(prop.getMapperLocations())
    .orElse(new String[0]))
    .flatMap(location -> Stream.of(getResources(patternResolver, location)))
    .toList();

• 根據 xml 文件在 target 目錄下的位置，進行路徑替換找到 xml 文件所在 resources 目錄下的位置

    // 根據xml文件在target目錄下的位置，進行路徑替換找到該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);
        }
    }

• 對 resources 目錄的 xml 文件的修改操作進行監聽

    // 對resources目錄的xml文件修改進行監聽
    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);
                        // 執行熱加載邏輯...
                        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));

• 對多個數據源進行遍歷，判斷修改過的 xml 文件屬于那個數據源

  // 對多個數據源進行遍歷，判斷修改過的xml文件屬于那個數據源
  for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) {
      ...
  }

• 根據 Configuration 對象獲取對應的標簽屬性

    // 根據 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");

• 遍歷 resources 目錄下 xml 文件列表

    // 遍歷 resources 目錄下 xml 文件列表
    for (Resource mapperLocation : mapperLocations) {
        ...
    }

• 判斷是否是被修改過的 xml 文件，否則跳過

    // 判斷是否是被修改過的xml文件，否則跳過
    if (!absolutePath.equals(mapperLocation.getFile().getAbsolutePath())) {
        continue;
    }

• 解析xml文件，獲取修改后的xml文件標簽對應的 resultMaps|sqlFragmentsMaps|mappedStatementMaps 的屬性并執行替換邏輯，并且兼容 mybatis-plus 的替換邏輯

    // 重新解析xml文件，替換Configuration對象的相對應屬性
    XPathParser parser = new XPathParser(mapperLocation.getInputStream(), true, 
        targetConfiguration.getVariables(), 
        new XMLMapperEntityResolver());
    XNode mapperXnode = parser.evalNode("/mapper");
    String namespace = mapperXnode.getStringAttribute("namespace");
    List<XNode> resultMapNodes = mapperXnode.evalNodes("/mapper/resultMap");
    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);
    }

• 重新加載和解析被修改的 xml 文件

    // 9. 重新加載和解析被修改的 xml 文件
    try {
        XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(
            mapperLocation.getInputStream(),
            targetConfiguration,
            mapperLocation.toString(), 
            targetConfiguration.getSqlFragments());
        xmlMapperBuilder.parse();
    } catch (Exception e) {
        logger.error(e.getMessage(), e);
    }

三、安裝方式

• 在 Spring Boot3.0 中，mybatis-xmlreload-spring-boot-starter在 Maven 項目提供坐標地址如下：

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

• 在 Spring Boot2.0 Maven 項目提供坐標地址如下：

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

四、使用配置

mybatis-xmlreload-spring-boot-starter 目前只有兩個配置屬性。mybatis-xml-reload.enabled 默認是 false， 也就是不啟用 xml 文件的熱加載功能，想要開啟的話通過在項目配置文件中設置 mybatis-xml-reload.enabled 為 true。還有一個配置屬性是 mybatis-xml-reload.mapper-locations，執行熱加載的 xml 文件路徑，這個屬性需要手動填寫，跟項目中的 mybatis.mapper-locations 保持一直即可。具體配置如下：

# mybatis xml文件熱加載配置
mybatis-xml-reload:
  # 是否開啟 xml 熱更新，true開啟，false不開啟，默認為false
  enabled: true 
  # xml文件路徑，可以填寫多個，逗號分隔。
  # eg: `classpath*:mapper/**/*Mapper.xml,classpath*:other/**/*Mapper.xml`
  mapper-locations: classpath:mapper/*Mapper.xml

以上就是“怎么使用mybatis-xmlreload實現修改xml文件再也不用重啟項目”這篇文章的所有內容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會為大家更新不同的知識，如果還想學習更多的知識，請關注億速云行業資訊頻道。