广告

扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > Python >Mybatis中mapper.xml实现热加载介绍
  • 619

0
分享到

Mybatis中mapper.xml实现热加载介绍

2024-04-02 19:04:59 619人浏览 薄情痞子

Python 官方文档：入门教程 => 点击学习

摘要

目录背景目的实现方式总结背景 有些需求可能更新sql的频率较高，但又不想频繁发布java应用程序，所以mybatis-mapper.xml热加载的需求顺势而出。 目的 只需调起加载m

背景

有些需求可能更新sql的频率较高，但又不想频繁发布java应用程序，所以mybatis-mapper.xml热加载的需求顺势而出。

目的

只需调起加载mapper.xml的程序，无需重启整个java应用，低耦合。

实现方式

mapper.xml可以指定路径。如SpringBoot工程resources目录下；亦可独立维护在某个git仓库，然后由程序加载到运行机器上去。
具体加载git仓库到运行机器代码如下：

package com.jason.git;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.eclipse.jgit.api.CloneCommand;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.PullResult;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.transport.UsernamePassWordCredentialsProvider;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Repository;

import java.io.File;
import java.io.IOException;


@Repository
public class GitConfigRepository {

	private static final long MIN_CHECKOUT_INTERVAL = 1000L * 10;
	private static final long MAX_LOCAL_LIFE_CYCLE = 2 * 86400 * 1000L;

	private Log log = LogFactory.getLog(GitConfigRepository.class);

	@Value("${git.repository:}")
	private String gitRepositoryURL;
	@Value("${git.branch:master}")
	private String gitBranch;
	@Value("${git.username:}")
	private String gitUsername;
	@Value("${git.password:}")
	private String gitPassword;
	@Value("${bi.meta.git.localRepository:}")
	private String localRepository;

	private long lastCheckoutTimestamp;
	private long localRepositoryTimestamp;
	private File gitDir;
	private Git git;

	public File getRepositoryDir() throws IOException, GitAPIException {
		long now = System.currentTimeMillis();
		if (now - lastCheckoutTimestamp > MIN_CHECKOUT_INTERVAL) {
			this.lastCheckoutTimestamp = now;

			if (StringUtils.isNotEmpty(localRepository)) {
				gitDir = new File(localRepository);
			} else {
				boolean isNewDir = false;
				if (gitDir != null && !gitDir.exists()) {
					gitDir = null;
				}

				if (gitDir != null) {
					if (now - localRepositoryTimestamp > MAX_LOCAL_LIFE_CYCLE) {
						localRepositoryTimestamp = 0;
						try {
							gitDir.delete();
						} catch (Exception e) {
							// do nothing
						}
						gitDir = null;
					}

					File keyFile = new File(gitDir, "global/config/config.yml");
					if (!(keyFile.exists() && keyFile.length() > 0)) {
						try {
							gitDir.delete();
						} catch (Exception e) {
							// do nothing
						}
						gitDir = null;
					}
				}

				if (gitDir == null) {
					gitDir = File.createTempFile("egret-meta", ".git");
					if (!gitDir.delete()) {
						throw new IOException("无法删除临时文件: " + gitDir.getAbsolutePath());
					}
					if (!gitDir.mkdir()) {
						throw new IOException("创建历史Git本地目录失败: " + gitDir.getAbsolutePath());
					}
					gitDir.deleteOnExit();
					isNewDir = true;
					localRepositoryTimestamp = now;
				}

				if (StringUtils.isNotEmpty(gitRepositoryURL)) {
					//设置远程服务器上的用户名和密码
					UsernamePasswordCredentialsProvider usernamePasswordCredentialsProvider = new
							UsernamePasswordCredentialsProvider(gitUsername, gitPassword);

					if (isNewDir) {
						//克隆代码库命令
						CloneCommand cloneCommand = Git.cloneRepository();

						git = cloneCommand.setURI(gitRepositoryURL)
								.setBranch(gitBranch)
								.setDirectory(gitDir)
								.setCredentialsProvider(usernamePasswordCredentialsProvider)
								.call();
					}

					log.info("Checkout meta configs from. [" + gitRepositoryURL + "|" + gitBranch + "]");
					PullResult call = git.pull().setRemoteBranchName(gitBranch).setCredentialsProvider(usernamePasswordCredentialsProvider).call();
					log.info("Checkout meta configs OK.");
				}
			}
		}
		return gitDir;
	}
}

1、手动触发

	public void reloadSqlXml() {
		try {
			File mapperXmlDir = gitConfigRepository.getRepositoryDir();
			mapperHotDeployPlugin.reloadSqlXml(mapperXmlDir);
		} catch (Exception e) {
			log.error(e.getMessage(), e);
		}
	}

package com.jason.dao;

import cn.hutool.core.bean.BeanUtil;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.builder.xml.XMLMapperEntityResolver;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.parsing.XPathParser;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.io.File;
import java.io.FileInputStream;
import java.util.*;
import java.util.stream.Collectors;




@Slf4j
@Component
public class MapperHotDeployPlugin implements InitializingBean {

	@Autowired
	private SqlSessionFactory sqlSessionFactory;

	private volatile Configuration configuration;

	@Override
	public void afterPropertiesSet() {
		configuration = sqlSessionFactory.getConfiguration();
	}

	public void reloadSqlXml(File file) {
		if (file == null) {
			return;
		}
		List<File> fileList = new ArrayList<>();
		setFiles(file, fileList, ".xml");
		reloadXml(fileList);
	}

	private void setFiles(File file, List<File> fileList, String suffix) {
		File[] files = file.listFiles();
		if (files == null || files.length == 0) {
			return;
		}
		for (File f : files) {
			if (f.isDirectory()) {
				//递归调用
				setFiles(f, fileList, suffix);
			} else {
				//保存文件路径到集合中
				if (f.getAbsolutePath().contains(suffix)) {
					fileList.add(f);
				}
			}
		}
	}

	
	private void reloadXml(List<File> fileList) {
		log.info("需要重新加载的文件列表: {}", fileList);

		fileList.forEach(r -> {
			try {
				clearMap(getNamespace(r));
				clearSet(r.getAbsolutePath());
				XMLMapperBuilder xmlMapperBuilder =
						new XMLMapperBuilder(new FileInputStream(r), getTarConfiguration(), r.toString(),
								getTarConfiguration().getSqlFragments());
				xmlMapperBuilder.parse();
			} catch (Exception e) {
				log.info("ERROR: 重新加载[{}]失败", r.toString(), e);
				throw new RuntimeException("ERROR: 重新加载[" + r.toString() + "]失败", e);
			} finally {
				ErrorContext.instance().reset();
			}
		});
		log.info("成功热部署文件列表: {}", fileList);
	}

	private Configuration getTarConfiguration() {
		return configuration;
	}

	
	private void clearMap(String nameSpace) {
		log.info(
				"清理Mybatis的namespace={}在mappedStatements、caches、resultMaps、parameterMaps、keyGenerators、sqlFragments中的缓存");
		Arrays.asList("mappedStatements", "caches", "resultMaps", "parameterMaps", "keyGenerators", "sqlFragments")
				.forEach(fieldName -> {
					Object value = BeanUtil.getFieldValue(getTarConfiguration(), fieldName);
					if (value instanceof Map) {
						Map<?, ?> map = (Map) value;
						List<Object> list = map.keySet().stream().filter(o -> o.toString().startsWith(nameSpace + "."))
								.collect(Collectors.toList());
						log.info("需要清理的元素: {}", list);
						list.forEach(k -> map.remove((Object) k));
					}
				});
	}

	
	private void clearSet(String resource) {
		log.info("清理mybatis的资源{}在容器中的缓存", resource);
		Object value = BeanUtil.getFieldValue(getTarConfiguration(), "loadedResources");
		if (value instanceof Set) {
			Set<?> set = (Set) value;
			set.remove(resource);
			set.remove("namespace:" + resource);
		}
	}

	
	private String getNamespace(File file) {
		try {
			XPathParser parser = new XPathParser(new FileInputStream(file), true, null, new XMLMapperEntityResolver());
			return parser.evalnode("/mapper").getStringAttribute("namespace");
		} catch (Exception e) {
			log.info("ERROR: 解析xml中namespace失败", e);
			throw new RuntimeException("ERROR: 解析xml中namespace失败", e);
		}
	}
}

2、自动监控

package com.jason.replacer.config;

import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.builder.xml.XMLMapperEntityResolver;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.parsing.XPathParser;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.stereotype.Component;

import java.lang.reflect.Field;
import java.NIO.file.*;
import java.util.*;
import java.util.stream.Collectors;




@Slf4j
@Component
public class MapperHotDeployPlugin implements InitializingBean {

	@Autowired
	private SqlSessionFactory sqlSessionFactory;

	private volatile Configuration configuration;

	@Value("${mybatis.mapper-locations}")
	private String mybatisPath;

	@Override
	public void afterPropertiesSet() {
		configuration = sqlSessionFactory.getConfiguration();
		new WatchThread().start();

	}

	class WatchThread extends Thread {

		@Override
		public void run() {
			startWatch();
		}

		
		private void startWatch() {
			try {
				WatchService watcher = FileSystems.getDefault().newWatchService();
				getWatchPaths().forEach(p -> {
					try {
						Paths.get(p).reGISter(watcher, StandardWatchEventKinds.ENTRY_CREATE,
								StandardWatchEventKinds.ENTRY_DELETE, StandardWatchEventKinds.ENTRY_MODIFY);
					} catch (Exception e) {
						log.error("ERROR: 注册xml监听事件", e);
						throw new RuntimeException("ERROR: 注册xml监听事件", e);
					}
				});
				while (true) {
					WatchKey watchKey = watcher.take();
					Set<String> set = new HashSet<>();
					for (WatchEvent<?> event : watchKey.pollEvents()) {
						set.add(event.context().toString());
					}
					// 重新加载xml
					reloadXml(set);
					boolean valid = watchKey.reset();
					if (!valid) {
						break;
					}
				}
			} catch (Exception e) {
				System.out.println("Mybatis的xml监控失败!");
				log.info("Mybatis的xml监控失败!", e);
			}
		}

		
		private Set<String> getWatchPaths() {
			Set<String> set = new HashSet<>();
			Arrays.stream(getResource()).forEach(r -> {
				try {
					log.info("资源路径:{}", r.toString());
					set.add(r.getFile().getParentFile().getAbsolutePath());
				} catch (Exception e) {
					log.info("获取资源路径失败", e);
					throw new RuntimeException("获取资源路径失败");
				}
			});
			log.info("需要监听的xml资源: {}", set);
			return set;
		}

		
		@SneakyThrows
		private Resource[] getResource() {
			return new PathMatchingResourcePatternResolver().getResources(mybatisPath);
		}

		
		private void clearMap(String nameSpace) {
			log.info(
					"清理Mybatis的namespace={}在mappedStatements、caches、resultMaps、parameterMaps、keyGenerators、sqlFragments中的缓存");
			Arrays.asList("mappedStatements", "caches", "resultMaps", "parameterMaps", "keyGenerators", "sqlFragments")
					.forEach(fieldName -> {
						Object value = getFieldValue(configuration, fieldName);
						if (value instanceof Map) {
							Map<?, ?> map = (Map) value;
							List<Object> list =
									map.keySet().stream().filter(o -> o.toString().startsWith(nameSpace + "."))
											.collect(Collectors.toList());
							log.info("需要清理的元素: {}", list);
							list.forEach(k -> map.remove((Object) k));
						}
					});
		}

		
		private void clearSet(String resource) {
			log.info("清理mybatis的资源{}在容器中的缓存", resource);
			Object value = getFieldValue(configuration, "loadedResources");
			if (value instanceof Set) {
				Set<?> set = (Set) value;
				set.remove(resource);
				set.remove("namespace:" + resource);
			}
		}

		
		private Object getFieldValue(Object obj, String fieldName) {
			log.info("从{}中加载{}属性", obj, fieldName);
			try {
				Field field = obj.getClass().getDeclaredField(fieldName);
				boolean accessible = field.isAccessible();
				field.setAccessible(true);
				Object value = field.get(obj);
				field.setAccessible(accessible);
				return value;
			} catch (Exception e) {
				log.info("ERROR: 加载对象中[{}]", fieldName, e);
				throw new RuntimeException("ERROR: 加载对象中[" + fieldName + "]", e);
			}
		}

		
		private void reloadXml(Set<String> set) {
			log.info("需要重新加载的文件列表: {}", set);
			List<Resource> list = Arrays.stream(getResource()).filter(p -> set.contains(p.getFilename()))
					.collect(Collectors.toList());
			log.info("需要处理的资源路径:{}", list);
			list.forEach(r -> {
				try {
					clearMap(getNamespace(r));
					clearSet(r.toString());
					XMLMapperBuilder xmlMapperBuilder =
							new XMLMapperBuilder(r.getInputStream(), configuration, r.toString(),
									configuration.getSqlFragments());
					xmlMapperBuilder.parse();
				} catch (Exception e) {
					log.info("ERROR: 重新加载[{}]失败", r.toString(), e);
					throw new RuntimeException("ERROR: 重新加载[" + r.toString() + "]失败", e);
				} finally {
					ErrorContext.instance().reset();
				}
			});
			log.info("成功热部署文件列表: {}", set);
		}

		
		private String getNamespace(Resource resource) {
			log.info("从{}获取namespace", resource.toString());
			try {
				XPathParser parser =
						new XPathParser(resource.getInputStream(), true, null, new XMLMapperEntityResolver());
				return parser.evalNode("/mapper").getStringAttribute("namespace");
			} catch (Exception e) {
				log.info("ERROR: 解析xml中namespace失败", e);
				throw new RuntimeException("ERROR: 解析xml中namespace失败", e);
			}
		}
	}
}

注

上面提供了加载mapper.xml文件的两种方式

读取文件绝对路径

	public static List<File> getFiles(String dirPath) {
		List<File> fileList = new ArrayList<>();
		File file = new File(dirPath);
		return getFiles(file, fileList, ".xml");
	}
	
	public static List<File> getFiles(File file, List<File> fileList, String suffix) {
		File[] files = file.listFiles();
		if (files == null || files.length == 0) {
			return Collections.emptyList();
		}
		for (File f : files) {
			if (f.isDirectory()) {
				//递归调用
				getFiles(f, fileList, suffix);
			} else {
				//保存文件路径到集合中
				if (f.getAbsolutePath().contains(suffix)) {
					fileList.add(f);
				}
			}
		}
		return fileList;
	}

读取classpath下的资源路径

		@SneakyThrows
		private Resource[] getResource() {
			return new PathMatchingResourcePatternResolver().getResources("classpath:mappers*.xml");
		}

总结

到此这篇关于Mybatis中mapper.xml实现热加载介绍的文章就介绍到这了,更多相关Mybatis mapper.xml热加载内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

您可能感兴趣的文档:
点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: Mybatis中mapper.xml实现热加载介绍

本文链接: https://www.lsjlt.com/news/163272.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档
去做题
猜你喜欢
  • Mybatis中mapper.xml实现热加载介绍
    目录背景目的实现方式总结背景 有些需求可能更新sql的频率较高，但又不想频繁发布java应用程序，所以mybatis-mapper.xml热加载的需求顺势而出。 目的 只需调起加载m...
    99+
    2022-11-13
  • mybatis xml文件热加载怎么实现
    这篇文章主要介绍了mybatis xml文件热加载怎么实现的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇mybatis xml文件热加载怎么实现文章都会有所收获，下面我们一起来看看吧。一、x...
    99+
    2023-07-05
  • mybatis中如何实现executor包懒加载功能 
    这篇文章主要为大家展示了“mybatis中如何实现executor包懒加载功能 ”，内容简而易懂，条理清晰，希望能够帮助大家解决疑惑，下面让小编带领大家一起研究并学习一下“mybatis中如何实现executor包懒加载功能&nb...
    99+
    2023-06-29
  • 网络安全中流量加密实现工具冰蝎4.0介绍
    前几天写完了蚁剑，今天就研究下冰蝎吧， 冰蝎最主要的是可以流量加密，由于其密钥是可随机变化而无法深度了解特征 在最新的冰蝎 4.0 中，有多种加密方式，比如 异或 ，基于 Base6...
    99+
    2022-11-13
  • JS中如何使用gulp实现压缩文件及浏览器热加载功能
    小编给大家分享一下JS中如何使用gulp实现压缩文件及浏览器热加载功能，相信大部分人都还不怎么了解，因此分享这篇文章给大家参考一下，希望大家阅读完这篇文章后大有收获，下面让我们一起去了解一下吧！gulp类似...
    99+
    2022-10-19
  • Windows系统中出现无法加载这个硬件的设备驱动程序(代码39)的解决方法介绍
    近日不知何故，光驱和虚拟光驱盘符都不见了，查看系统发现硬件前面有黄色感叹号,无法使用，在网上搜索，发现有很多人出现同样的问题，只是解决的方法都不对，找了两天，终于找到了解决的方法： 修复“光驱图标不见&rdq...
    99+
    2023-05-31
    Windows 无法加载 硬件 设备驱动 驱动程序 设备 代码 解决
软考高级职称资格查询
软考职称历年真题下载
软考职称资料下载
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作