修改xml文件再也不用重啟項(xiàng)目mybatis-xmlreload方法
正文
自博主18年使用 Mybaits 以來(lái),開(kāi)發(fā)環(huán)境中如果修改了 xml 文件后,只有重啟項(xiàng)目才能生效,如果小項(xiàng)目重啟還好,但是對(duì)于一個(gè)重啟需要十幾分鐘的大型項(xiàng)目來(lái)說(shuō),這就非常耗時(shí)了。開(kāi)發(fā)人員因?yàn)樾薷牧藊ml 文件少量?jī)?nèi)容,比如添加一個(gè)逗號(hào)、查詢(xún)?cè)黾右粋€(gè)字段或者修改一個(gè) bug 等,就需要重啟整個(gè)項(xiàng)目,這就非常痛苦了。
所以在這里給大家推薦一個(gè)實(shí)現(xiàn)了 Mybatis xml文件熱加載的項(xiàng)目,mybatis-xmlreload-spring-boot-starter。它能夠幫助我們?cè)赟pring Boot + Mybatis的開(kāi)發(fā)環(huán)境中修改 xml 后,不需要重啟項(xiàng)目就能讓修改過(guò)后 xml 文件立即生效,實(shí)現(xiàn)熱加載功能。這里給出項(xiàng)目地址:
- github.com/wayn111/myb… 歡迎大家關(guān)注,點(diǎn)個(gè)star
- 博主github:github.com/wayn111
ps:mybatis-xmlreload-spring-boot-starter目前 3.0.3.m1 版本實(shí)現(xiàn)了 xml 文件修改已有內(nèi)容,比如修改 sql 語(yǔ)句、添加查詢(xún)字段、添加查詢(xún)條件等,可以實(shí)現(xiàn)熱加載功能。但是對(duì)于 xml 文件添加 insert|update|delete|select
標(biāo)簽等內(nèi)容后,是無(wú)法實(shí)現(xiàn)熱加載的。眾所周知,在 Idea 環(huán)境進(jìn)行 Java 開(kāi)發(fā),在方法內(nèi)修改方法內(nèi)容是可以熱加載的。但是添加新方法、添加方法參數(shù),修改方法參數(shù),修改方法返回值等都是無(wú)法直接熱加載的。
一、mybatis-xmlreload-spring-boot-starter使用
mybatis-xmlreload-spring-boot-starter原理:
- 修改 xml 文件的加載邏輯。在普通的
mybatis-spring
項(xiàng)目中,默認(rèn)只會(huì)加載項(xiàng)目編譯過(guò)后的 xml 文件,也就是 target 目錄下的 xml 文件。但是在mybatis-xmlreload-spring-boot-starter中,修改了這一點(diǎn),它會(huì)加載項(xiàng)目 resources 目錄下的 xml 文件,這樣用戶(hù)對(duì)于 resources 目錄下 xml 文件的修改操作是可以立即觸發(fā)熱加載的。 - 通過(guò)
io.methvin.directory-watcher
項(xiàng)目來(lái)監(jiān)聽(tīng) xml 文件的修改操作,它底層是通過(guò) java.nio 的WatchService
來(lái)實(shí)現(xiàn),當(dāng)我們監(jiān)聽(tīng)了整個(gè) resources 目錄后,xml 文件的修改會(huì)立馬觸發(fā) MODIFY 事件。 - 通過(guò)
mybatis-spring
項(xiàng)目原生的xmlMapperBuilder.parse()
方法重新加載解析修改過(guò)后的 xml 文件來(lái)保證項(xiàng)目對(duì)于 Mybatis 的兼容性處理。
二、技術(shù)原理
mybatis-xmlreload-spring-boot-starter代碼結(jié)構(gòu)如下:
核心代碼在MybatisXmlReload類(lèi)中,執(zhí)行邏輯:
- 通過(guò)項(xiàng)目初始化時(shí)傳入
MybatisXmlReloadProperties prop, List<SqlSessionFactory> sqlSessionFactories
參數(shù),獲取mybatis-xmlreload-spring-boot-starter的配置信息,以及項(xiàng)目中的數(shù)據(jù)源配置
/** * 是否啟動(dòng)以及xml路徑的配置類(lèi) */ private MybatisXmlReloadProperties prop; /** * 獲取項(xiàng)目中初始化完成的SqlSessionFactory列表,對(duì)多數(shù)據(jù)源進(jìn)行處理 */ private List<SqlSessionFactory> sqlSessionFactories; public MybatisXmlReload(MybatisXmlReloadProperties prop, List<SqlSessionFactory> sqlSessionFactories) { this.prop = prop; this.sqlSessionFactories = sqlSessionFactories; }
- 解析配置文件指定的 xml 路徑,獲取 xml 文件在 target 目錄下的位置
// 解析項(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();
- 根據(jù) xml 文件在 target 目錄下的位置,進(jìn)行路徑替換找到 xml 文件所在 resources 目錄下的位置
// 根據(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); } }
- 對(duì) resources 目錄的 xml 文件的修改操作進(jìn)行監(jiān)聽(tīng)
// 對(duì)resources目錄的xml文件修改進(jìn)行監(jiān)聽(tīng) 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); // 執(zhí)行熱加載邏輯... 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));
- 對(duì)多個(gè)數(shù)據(jù)源進(jìn)行遍歷,判斷修改過(guò)的 xml 文件屬于那個(gè)數(shù)據(jù)源
// 對(duì)多個(gè)數(shù)據(jù)源進(jìn)行遍歷,判斷修改過(guò)的xml文件屬于那個(gè)數(shù)據(jù)源 for (SqlSessionFactory sqlSessionFactory : sqlSessionFactories) { ... }
- 根據(jù) Configuration 對(duì)象獲取對(duì)應(yīng)的標(biāo)簽屬性
// 根據(jù) Configuration 對(duì)象獲取對(duì)應(yīng)的標(biāo)簽屬性 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) { ... }
- 判斷是否是被修改過(guò)的 xml 文件,否則跳過(guò)
// 判斷是否是被修改過(guò)的xml文件,否則跳過(guò) if (!absolutePath.equals(mapperLocation.getFile().getAbsolutePath())) { continue; }
- 解析xml文件,獲取修改后的xml文件標(biāo)簽對(duì)應(yīng)的
resultMaps|sqlFragmentsMaps|mappedStatementMaps
的屬性并執(zhí)行替換邏輯,并且兼容mybatis-plus
的替換邏輯
// 重新解析xml文件,替換Configuration對(duì)象的相對(duì)應(yīng)屬性 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 項(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>
四、使用配置
mybatis-xmlreload-spring-boot-starter 目前只有兩個(gè)配置屬性。mybatis-xml-reload.enabled
默認(rèn)是 false, 也就是不啟用 xml 文件的熱加載功能,想要開(kāi)啟的話(huà)通過(guò)在項(xiàng)目配置文件中設(shè)置 mybatis-xml-reload.enabled
為 true。還有一個(gè)配置屬性是 mybatis-xml-reload.mapper-locations
,執(zhí)行熱加載的 xml 文件路徑,這個(gè)屬性需要手動(dòng)填寫(xiě),跟項(xiàng)目中的 mybatis.mapper-locations
保持一直即可。具體配置如下:
# mybatis xml文件熱加載配置 mybatis-xml-reload: # 是否開(kāi)啟 xml 熱更新,true開(kāi)啟,false不開(kāi)啟,默認(rèn)為false enabled: true # xml文件路徑,可以填寫(xiě)多個(gè),逗號(hào)分隔。 # eg: `classpath*:mapper/**/*Mapper.xml,classpath*:other/**/*Mapper.xml` mapper-locations: classpath:mapper/*Mapper.xml
五、最后
歡迎大家使用mybatis-xmlreload-spring-boot-starter,這個(gè)項(xiàng)目我開(kāi)源的的,使用中遇到問(wèn)題可以提交 issue。提交的問(wèn)題我都會(huì)一一查看并回復(fù)。再附項(xiàng)目地址:
以上就是修改xml文件再也不用重啟項(xiàng)目mybatis-xmlreload的詳細(xì)內(nèi)容,更多關(guān)于mybatis-xmlreload的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
java web開(kāi)發(fā)中獲取tomcat上properties文件內(nèi)容的方法
java web開(kāi)發(fā)中如何獲取tomcat上properties文件內(nèi)容的方法,方便文件存儲(chǔ)位置的修改,解耦和,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-07-07springboot項(xiàng)目配置多數(shù)據(jù)庫(kù)連接的示例詳解
這篇文章主要介紹了springboot項(xiàng)目配置多數(shù)據(jù)庫(kù)連接的示例,本文通過(guò)示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友參考下吧2023-12-12mybatis執(zhí)行錯(cuò)誤但sql執(zhí)行正常問(wèn)題
這篇文章主要介紹了mybatis執(zhí)行錯(cuò)誤但sql執(zhí)行正常問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-01-01mybatisplus?@Select注解中拼寫(xiě)動(dòng)態(tài)sql異常問(wèn)題的解決
這篇文章主要介紹了mybatisplus?@Select注解中拼寫(xiě)動(dòng)態(tài)sql異常問(wèn)題的解決,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12詳解SpringMVC組件之HandlerMapping(二)
這篇文章主要介紹了詳解SpringMVC組件之HandlerMapping(二),HandlerMapping組件是Spring?MVC核心組件,用來(lái)根據(jù)請(qǐng)求的request查找對(duì)應(yīng)的Handler,在Spring?MVC中,有各式各樣的Web請(qǐng)求,每個(gè)請(qǐng)求都需要一個(gè)對(duì)應(yīng)的Handler來(lái)處理,需要的朋友可以參考下2023-08-08