首页 > 软件编程 > Java > 修改xml文件再也不用重启项目mybatis-xmlreload方法

修改xml文件再也不用重启项目mybatis-xmlreload方法

福牛 3月 27, 2023 39 0

正文

 

自博主18年使用 Mybaits 以来，开发环境中如果修改了 xml 文件后，只有重启项目才能生效，如果小项目重启还好，但是对于一个重启需要十几分钟的大型项目来说，这就非常耗时了。开发人员因为修改了xml 文件少量内容，比如添加一个逗号、查询增加一个字段或者修改一个 bug 等，就需要重启整个项目，这就非常痛苦了。

所以在这里给大家推荐一个实现了 Mybatis xml文件热加载的项目，mybatis-xmlreload-spring-boot-starter。它能够帮助我们在Spring Boot + Mybatis的开发环境中修改 xml 后，不需要重启项目就能让修改过后 xml 文件立即生效，实现热加载功能。这里给出项目地址：

  • github.com/wayn111/myb… 欢迎大家关注，点个star
  • 博主github：github.com/wayn111

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代码结构如下：

-1

核心代码在MybatisXmlReload类中，执行逻辑：

  • 通过项目初始化时传入 MybatisXmlReloadProperties prop, List<SqlSessionFactory> sqlSessionFactories 参数，获取mybatis-xmlreload-spring-boot-starter的配置信息，以及项目中的数据源配置
  1.      /**
  2.          * 是否启动以及xml路径的配置类
  3.          */
  4.      private MybatisXmlReloadProperties prop;
  5.      /**
  6.          * 获取项目中初始化完成的SqlSessionFactory列表，对多数据源进行处理
  7.          */
  8.      private List<SqlSessionFactory> sqlSessionFactories;
  9.      public MybatisXmlReload(MybatisXmlReloadProperties prop,
  10.              List<SqlSessionFactory> sqlSessionFactories) {
  11.          this.prop = prop;
  12.          this.sqlSessionFactories = sqlSessionFactories;
  13.      }
  • 解析配置文件指定的 xml 路径，获取 xml 文件在 target 目录下的位置
  1.      // 解析项目所有xml路径，获取xml文件在target目录中的位置
  2.      List<Resource> mapperlocationsTmp = Stream.of(Optional.of(prop.getMapperLocations())
  3.      .orElse(new String[0]))
  4.      .flatMap(location -> Stream.of(getResources(patternResolver, location)))
  5.      .toList();
  • 根据 xml 文件在 target 目录下的位置，进行路径替换找到 xml 文件所在 resources 目录下的位置
  1.      // 根据xml文件在target目录下的位置，进行路径替换找到该xml文件在resources目录下的位置
  2.      for (Resource mapperLocation : mapperLocationsTmp) {
  3.          mapperLocations.add(mapperLocation);
  4.          String absolutePath = mapperLocation.getFile().getAbsolutePath();
  5.          File tmpFile = new File(absolutePath.replace(CLASS_PATH_TARGET, MAVEN_RESOURCES));
  6.          if (tmpFile.exists()) {
  7.              locationPatternSet.add(Path.of(tmpFile.getParent()));
  8.              FileSystemResource fileSystemResource = new FileSystemResource(tmpFile);
  9.              mapperLocations.add(fileSystemResource);
  10.          }
  11.      }
  • 对 resources 目录的 xml 文件的修改操作进行监听
  1.      // 对resources目录的xml文件修改进行监听
  2.      List<Path> rootPaths = new ArrayList<>();
  3.      rootPaths.addAll(locationPatternSet);
  4.      DirectoryWatcher watcher = DirectoryWatcher.builder()
  5.              .paths(rootPaths) // or use paths(directoriesToWatch)
  6.              .listener(event -> {
  7.                  switch (event.eventType()) {
  8.                      case CREATE: /* file created */
  9.                      break;
  10.                      case MODIFY: /* file modified */
  11.                      Path modifyPath = event.path();
  12.                      String absolutePath = modifyPath.toFile().getAbsolutePath();
  13.                      logger.info(“mybatis xml file has changed:” + modifyPath);
  14.                      // 执行热加载逻辑…
  15.                      break;
  16.                      case DELETE: /* file deleted */
  17.                      break;
  18.                  }
  19.              })
  20.              .build();
  21.      ThreadFactory threadFactory = r -> {
  22.          Thread thread = new Thread(r);
  23.          thread.setName(“xml-reload”);
  24.          thread.setDaemon(true);
  25.          return thread;
  26.      };
  27.      watcher.watchAsync(new ScheduledThreadPoolExecutor(1, threadFactory));
  • 对多个数据源进行遍历，判断修改过的 xml 文件属于那个数据源
  1.      // 对多个数据源进行遍历，判断修改过的xml文件属于那个数据源
  2.      for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) {
  3.          …
  4.      }
  • 根据 Configuration 对象获取对应的标签属性
  1.      // 根据 Configuration 对象获取对应的标签属性
  2.      Configuration targetConfiguration = sqlSessionFactory.getConfiguration();
  3.      Class<?> tClass = targetConfiguration.getClass(), aClass = targetConfiguration.getClass();
  4.      if (targetConfiguration.getClass().getSimpleName().equals(“MybatisConfiguration”)) {
  5.          aClass = Configuration.class;
  6.      }
  7.      Set<String> loadedResources = (Set<String>) getFieldValue(
  8.          targetConfiguration, aClass, “loadedResources”);
  9.      loadedResources.clear();
  10.      Map<String, ResultMap> resultMaps = (Map<String, ResultMap>) getFieldValue(
  11.          targetConfiguration, tClass, “resultMaps”);
  12.      Map<String, XNode> sqlFragmentsMaps = (Map<String, XNode>) getFieldValue(
  13.          targetConfiguration, tClass, “sqlFragments”);
  14.      Map<String, MappedStatement> mappedStatementMaps =
  15.          (Map<String, MappedStatement>) getFieldValue(
  16.              targetConfiguration, tClass, “mappedStatements”);
  • 遍历 resources 目录下 xml 文件列表
  1.      // 遍历 resources 目录下 xml 文件列表
  2.      for (Resource mapperLocation : mapperLocations) {
  3.          …
  4.      }
  • 判断是否是被修改过的 xml 文件，否则跳过
  1.      // 判断是否是被修改过的xml文件，否则跳过
  2.      if (!absolutePath.equals(mapperLocation.getFile().getAbsolutePath())) {
  3.          continue;
  4.      }
  • 解析xml文件，获取修改后的xml文件标签对应的 resultMaps|sqlFragmentsMaps|mappedStatementMaps 的属性并执行替换逻辑，并且兼容 mybatis-plus 的替换逻辑
  1.      // 重新解析xml文件，替换Configuration对象的相对应属性
  2.      XPathParser parser = new XPathParser(mapperLocation.getInputStream(), true,
  3.          targetConfiguration.getVariables(),
  4.          new XMLMapperEntityResolver());
  5.      XNode mapperXnode = parser.evalNode(“/mapper”);
  6.      String namespace = mapperXnode.getStringAttribute(“namespace”);
  7.      List<XNode> resultMapNodes = mapperXnode.evalNodes(“/mapper/resultMap”);
  8.      for (XNode xNode : resultMapNodes) {
  9.          String id = xNode.getStringAttribute(“id”, xNode.getValueBasedIdentifier());
  10.          resultMaps.remove(namespace + “.” + id);
  11.      }
  12.      List<XNode> sqlNodes = mapperXnode.evalNodes(“/mapper/sql”);
  13.      for (XNode sqlNode : sqlNodes) {
  14.          String id = sqlNode.getStringAttribute(“id”, sqlNode.getValueBasedIdentifier());
  15.          sqlFragmentsMaps.remove(namespace + “.” + id);
  16.      }
  17.      List<XNode> msNodes = mapperXnode.evalNodes(“select|insert|update|delete”);
  18.      for (XNode msNode : msNodes) {
  19.          String id = msNode.getStringAttribute(“id”, msNode.getValueBasedIdentifier());
  20.          mappedStatementMaps.remove(namespace + “.” + id);
  21.      }
  • 重新加载和解析被修改的 xml 文件
  1.      // 9. 重新加载和解析被修改的 xml 文件
  2.      try {
  3.          XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(
  4.              mapperLocation.getInputStream(),
  5.              targetConfiguration,
  6.              mapperLocation.toString(),
  7.              targetConfiguration.getSqlFragments());
  8.          xmlMapperBuilder.parse();
  9.      } catch (Exception e) {
  10.          logger.error(e.getMessage(), e);
  11.      }

 

三、安装方式

  • 在 Spring Boot3.0 中，mybatis-xmlreload-spring-boot-starter在 Maven 项目提供坐标地址如下：
  1. <dependency>
  2.      <groupId>com.wayn</groupId>
  3.      <artifactId>mybatis-xmlreload-spring-boot-starter</artifactId>
  4.      <version>3.0.3.m1</version>
  5. </dependency>
  • 在 Spring Boot2.0 Maven 项目提供坐标地址如下：
  1. <dependency>
  2.      <groupId>com.wayn</groupId>
  3.      <artifactId>mybatis-xmlreload-spring-boot-starter</artifactId&gt;
  4.      <version>2.0.1.m1</version>
  5. </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 保持一直即可。具体配置如下：

  1. # mybatis xml文件热加载配置
  2. mybatis–xml–reload:
  3.      # 是否开启 xml 热更新，true开启，false不开启，默认为false
  4.      enabled: true
  5.      # xml文件路径，可以填写多个，逗号分隔。
  6.      # eg: `classpath*:mapper/**/*Mapper.xml,classpath*:other/**/*Mapper.xml`
  7.      mapper–locations: classpath:mapper/*Mapper.xml

 

五、最后

欢迎大家使用mybatis-xmlreload-spring-boot-starter，这个项目我开源的的，使用中遇到问题可以提交 issue。提交的问题我都会一一查看并回复。再附项目地址：

  • github.com/wayn111/myb…

以上就是修改xml文件再也不用重启项目mybatis-xmlreload的详细内容，更多关于mybatis-xmlreload的资料请关注我们其它相关文章！

标签

相关推荐

发表评论