乐趣区

关于springboot:分享一个修改了xml文件再也不用重启的项目mybatisxmlrealod

jiezi

自我 18 年应用 Mybaits 以来，开发环境中如果批改了 xml 文件后，只有重启我的项目能力失效，如果小我的项目重启还好，然而对于一个重启须要十几分钟的大型项目来说，这就十分耗时了。开发人员因为批改了 xml 文件大量内容，比方增加一个逗号、查问减少一个字段或者批改一个 bug 等，就须要重启整个我的项目，这就十分苦楚了。

所以在这里给大家举荐一个实现了 Mybatis xml 文件热加载的我的项目，mybatis-xmlreload-spring-boot-starter。它可能帮忙咱们在 Spring Boot + Mybatis 的开发环境中批改 xml 后，不须要重启我的项目就能让批改过后 xml 文件立刻失效，实现热加载性能。这里给出我的项目地址：

  • https://github.com/wayn111/mybatis-xmlreload-spring-boot-starter 欢送大家关注，点个 star

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 类中，执行逻辑：

  1. 通过我的项目初始化时传入 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;
}

  2. 解析配置文件指定的 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();

  3. 依据 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);
 }
}

  4. 对 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));

  5. 对多个数据源进行遍历，判断批改过的 xml 文件属于那个数据源

    // 对多个数据源进行遍历，判断批改过的 xml 文件属于那个数据源
for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) {...}

  6. 依据 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");

  7. 遍历 resources 目录下 xml 文件列表

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

  8. 判断是否是被批改过的 xml 文件，否则跳过

    // 判断是否是被批改过的 xml 文件，否则跳过
if (!absolutePath.equals(mapperLocation.getFile().getAbsolutePath())) {continue;}

  9. 解析 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);
}

  10. 从新加载和解析被批改的 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-spring-boot-starter，这个我的项目我开源的的，应用中遇到问题能够提交 issue。提交的问题我都会一一查看并回复。再附我的项目地址：

  • https://github.com/wayn111/mybatis-xmlreload-spring-boot-starter

最初再说一句，感兴趣的敌人能够点赞加关注，你的反对将是我更新能源😘。

退出移动版