SpringBoot动态更新yml文件
作者:code2roc 发布时间:2022-02-23 00:34:23
前言
在系统运行过程中,可能由于一些配置项的简单变动需要重新打包启停项目,这对于在运行中的项目会造成数据丢失,客户操作无响应等情况发生,针对这类情况对开发框架进行升级提供yml文件实时修改更新功能
项目依赖
项目基于的是2.0.0.RELEASE版本,所以snakeyaml需要单独引入,高版本已包含在内
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.23</version>
</dependency>
网上大多数方法是引入spring-cloud-context配置组件调用ContextRefresher的refresh方法达到同样的效果,考虑以下两点未使用
开发框架使用了logback日志,引入spring-cloud-context会造成日志配置读取错误
引入spring-cloud-context会同时引入spring-boot-starter-actuator组件,会开放一些健康检查路由及端口,需要对框架安全方面进行额外控制
YML文件内容获取
读取resource文件下的文件需要使用ClassPathResource获取InputStream
public String getTotalYamlFileContent() throws Exception {
String fileName = "application.yml";
return getYamlFileContent(fileName);
}
public String getYamlFileContent(String fileName) throws Exception {
ClassPathResource classPathResource = new ClassPathResource(fileName);
return onvertStreamToString(classPathResource.getInputStream());
}
public static String convertStreamToString(InputStream inputStream) throws Exception{
return IOUtils.toString(inputStream, "utf-8");
}
YML文件内容更新
我们获取到yml文件内容后可视化显示到前台进行展示修改,将修改后的内容通过yaml.load方法转换成Map结构,再使用yaml.dumpAsMap转换为流写入到文件
public void updateTotalYamlFileContent(String content) throws Exception {
String fileName = "application.yml";
updateYamlFileContent(fileName, content);
}
public void updateYamlFileContent(String fileName, String content) throws Exception {
Yaml template = new Yaml();
Map<String, Object> yamlMap = template.load(content);
ClassPathResource classPathResource = new ClassPathResource(fileName);
Yaml yaml = new Yaml();
//字符输出
FileWriter fileWriter = new FileWriter(classPathResource.getFile());
//用yaml方法把map结构格式化为yaml文件结构
fileWriter.write(yaml.dumpAsMap(yamlMap));
//刷新
fileWriter.flush();
//关闭流
fileWriter.close();
}
YML属性刷新
yml属性在程序中读取使用一般有三种
使用Value注解
@Value("${system.systemName}")
private String systemName;
通过enviroment注入读取
@Autowired
private Environment environment;
environment.getProperty("system.systemName")
使用ConfigurationProperties注解读取
@Component
@ConfigurationProperties(prefix = "system")
public class SystemConfig {
private String systemName;
}
Property刷新
我们通过environment.getProperty方法读取的配置集合实际是存储在PropertySources中的,我们只需要把键值对全部取出存储在propertyMap中,将更新后的yml文件内容转换成相同格式的ymlMap,两个Map进行合并,调用PropertySources的replace方法进行整体替换即可
但是yaml.load后的ymlMap和PropertySources取出的propertyMap两者数据解构是不同的,需要进行手动转换
propertyMap集合就是单纯的key,value键值对,key是properties形式的名称,例如system.systemName=>xxxxx集团管理系统
ymlMap集合是key,LinkedHashMap的嵌套层次结构,例如system=>(systemName=>xxxxx集团管理系统)
转换方法如下
public HashMap<String, Object> convertYmlMapToPropertyMap(Map<String, Object> yamlMap) {
HashMap<String, Object> propertyMap = new HashMap<String, Object>();
for (String key : yamlMap.keySet()) {
String keyName = key;
Object value = yamlMap.get(key);
if (value != null && value.getClass() == LinkedHashMap.class) {
convertYmlMapToPropertyMapSub(keyName, ((LinkedHashMap<String, Object>) value), propertyMap);
} else {
propertyMap.put(keyName, value);
}
}
return propertyMap;
}
private void convertYmlMapToPropertyMapSub(String keyName, LinkedHashMap<String, Object> submMap, Map<String, Object> propertyMap) {
for (String key : submMap.keySet()) {
String newKey = keyName + "." + key;
Object value = submMap.get(key);
if (value != null && value.getClass() == LinkedHashMap.class) {
convertYmlMapToPropertyMapSub(newKey, ((LinkedHashMap<String, Object>) value), propertyMap);
} else {
propertyMap.put(newKey, value);
}
}
}
刷新方法如下
String name = "applicationConfig: [classpath:/" + fileName + "]";
MapPropertySource propertySource = (MapPropertySource) environment.getPropertySources().get(name);
Map<String, Object> source = propertySource.getSource();
Map<String, Object> map = new HashMap<>(source.size());
map.putAll(source);
Map<String, Object> propertyMap = convertYmlMapToPropertyMap(yamlMap);
for (String key : propertyMap.keySet()) {
Object value = propertyMap.get(key);
map.put(key, value);
}
environment.getPropertySources().replace(name, new MapPropertySource(name, map));
注解刷新
不论是Value注解还是ConfigurationProperties注解,实际都是通过注入Bean对象的属性方法使用的,我们先自定注解RefreshValue来修饰属性所在Bean的class
通过实现InstantiationAwareBeanPostProcessorAdapter接口在系统启动时过滤筛选对应的Bean存储下来,在更新yml文件时通过spring的event通知更新对应
bean的属性即可
注册事件使用EventListener注解
@EventListener
public void updateConfig(ConfigUpdateEvent configUpdateEvent) {
if(mapper.containsKey(configUpdateEvent.key)){
List<FieldPair> fieldPairList = mapper.get(configUpdateEvent.key);
if(fieldPairList.size()>0){
for (FieldPair fieldPair:fieldPairList) {
fieldPair.updateValue(environment);
}
}
}
}
通知触发事件使用ApplicationContext的publishEvent方法
@Autowired
private ApplicationContext applicationContext;
for (String key : propertyMap.keySet()) {
applicationContext.publishEvent(new YamlConfigRefreshPostProcessor.ConfigUpdateEvent(this, key));
}
YamlConfigRefreshPostProcessor的完整代码如下
@Component
public class YamlConfigRefreshPostProcessor extends InstantiationAwareBeanPostProcessorAdapter implements EnvironmentAware {
private Map<String, List<FieldPair>> mapper = new HashMap<>();
private Environment environment;
@Override
public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
processMetaValue(bean);
return super.postProcessAfterInstantiation(bean, beanName);
}
@Override
public void setEnvironment(Environment environment) {
this.environment = environment;
}
private void processMetaValue(Object bean) {
Class clz = bean.getClass();
if (!clz.isAnnotationPresent(RefreshValue.class)) {
return;
}
if (clz.isAnnotationPresent(ConfigurationProperties.class)) {
//@ConfigurationProperties注解
ConfigurationProperties config = (ConfigurationProperties) clz.getAnnotation(ConfigurationProperties.class);
for (Field field : clz.getDeclaredFields()) {
String key = config.prefix() + "." + field.getName();
if(mapper.containsKey(key)){
mapper.get(key).add(new FieldPair(bean, field, key));
}else{
List<FieldPair> fieldPairList = new ArrayList<>();
fieldPairList.add(new FieldPair(bean, field, key));
mapper.put(key, fieldPairList);
}
}
} else {
//@Valuez注解
try {
for (Field field : clz.getDeclaredFields()) {
if (field.isAnnotationPresent(Value.class)) {
Value val = field.getAnnotation(Value.class);
String key = val.value().replace("${", "").replace("}", "");
if(mapper.containsKey(key)){
mapper.get(key).add(new FieldPair(bean, field, key));
}else{
List<FieldPair> fieldPairList = new ArrayList<>();
fieldPairList.add(new FieldPair(bean, field, key));
mapper.put(key, fieldPairList);
}
}
}
} catch (Exception e) {
e.printStackTrace();
System.exit(-1);
}
}
}
public static class FieldPair {
private static PropertyPlaceholderHelper propertyPlaceholderHelper = new PropertyPlaceholderHelper("${", "}",
":", true);
private Object bean;
private Field field;
private String value;
public FieldPair(Object bean, Field field, String value) {
this.bean = bean;
this.field = field;
this.value = value;
}
public void updateValue(Environment environment) {
boolean access = field.isAccessible();
if (!access) {
field.setAccessible(true);
}
try {
if (field.getType() == String.class) {
String updateVal = environment.getProperty(value);
field.set(bean, updateVal);
}
else if (field.getType() == Integer.class) {
Integer updateVal = environment.getProperty(value,Integer.class);
field.set(bean, updateVal);
}
else if (field.getType() == int.class) {
int updateVal = environment.getProperty(value,int.class);
field.set(bean, updateVal);
}
else if (field.getType() == Boolean.class) {
Boolean updateVal = environment.getProperty(value,Boolean.class);
field.set(bean, updateVal);
}
else if (field.getType() == boolean.class) {
boolean updateVal = environment.getProperty(value,boolean.class);
field.set(bean, updateVal);
}
else {
String updateVal = environment.getProperty(value);
field.set(bean, JSONObject.parseObject(updateVal, field.getType()));
}
} catch (IllegalAccessException e) {
e.printStackTrace();
}
field.setAccessible(access);
}
public Object getBean() {
return bean;
}
public void setBean(Object bean) {
this.bean = bean;
}
public Field getField() {
return field;
}
public void setField(Field field) {
this.field = field;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
}
public static class ConfigUpdateEvent extends ApplicationEvent {
String key;
public ConfigUpdateEvent(Object source, String key) {
super(source);
this.key = key;
}
}
@EventListener
public void updateConfig(ConfigUpdateEvent configUpdateEvent) {
if(mapper.containsKey(configUpdateEvent.key)){
List<FieldPair> fieldPairList = mapper.get(configUpdateEvent.key);
if(fieldPairList.size()>0){
for (FieldPair fieldPair:fieldPairList) {
fieldPair.updateValue(environment);
}
}
}
}
}
来源:https://blog.csdn.net/u013407099/article/details/128507905
猜你喜欢
- 前言Groovy 是一种基于 JVM 的动态语言,与 Java 语言紧密集成,可以很方便地在 Java 项目中使用。Groovy 有着简洁的
- 本文实例为大家分享了unity3D实现摄像机抖动的具体代码,供大家参考,具体内容如下摄像机抖动特效 在需要的地方调用CameraShake.
- 昨天实现一个功能,根据文章的id或者别名查找文章。起初采用mybatis的Example进行查询,对参数artName进行判断,如果是纯数字
- 本文实例讲述了Java正则验证电话,手机,邮箱,日期,金额的方法。分享给大家供大家参考,具体如下:package com.hooypay.t
- 这几天在弄后端管理系统向指定的Android
- Spring的主要特性包括IOC和DI,其中DI是IOC的基础。在以前的Spring使用过程中大部分都是使用XML配置文件显式配置sprin
- 一.理论准备KMP算法为什么比传统的字符串匹配算法快?KMP算法是通过分析模式串,预先计算每个位置发生不匹配的时候,可以省去重新匹配的的字符
- 引言Netty作为高性能的网络通信框架,它是IO模型演变过程中的产物。Netty以Java NIO为基础,是一种基于异步事件驱动的网络通信应
- 前言小伙伴们在使用C#开发时,可能需要将一些信息写入到txt,这里就给大家介绍几种常用的方法。方法:1.将由字符串组成的数组写入txt此种方
- 最近一段时间在研究OAuth2的使用,想整个单点登录,从网上找了很多demo都没有实施成功,也许是因为压根就不懂OAuth2的原理导致。有那
- 本文实例为大家分享了SpringMVC使用MultipartFile实现文件上传的具体代码,供大家参考,具体内容如下一、配置文件Spring
- 背景项目中我们经常会用搜索功能,普通的搜索我们可以用一个SQL的like也能实现匹配,但是搜索的核心需求是全文匹配,对于全文匹配,数据库的索
- 在常见场景下:返回数据建议使用map,不建议使用实体对象 /** * 1. 名字包含雨并且年龄小于40  
- springboot部署项目在linux的两种方式 可以选择 war包方式或者jar包方式(个人推荐使用jar方式)1.springboot
- 本文实例为大家分享了Springboot POI导出Excel的具体代码,供大家参考,具体内容如下需求:页面根据查询条件导出(浏览器)由于本
- 最近在做一个项目,遇到了项目打成 war 包的一个问题,项目创建时选择的时 jar 包方式,后因项目部署要求,需要打成 war 包部署,遇到
- 今天跟大家分享一个利用外部Jar包来实现Java操作CSV文件一.资源下载1.直接下载Jar包:javacsv-2.0.jar2.利用Mav
- Java连接SQL Server数据库的详细操作流程一.明确JDK版本和下载驱动1.1 JDK版本查看win + r输入cmd,命令窗口输入
- 记录一下使用IDEA创建servlet并使用Tomcat本地部署的过程。需要安装好的软件首先IDEA社区版不支持Java EE,因此要使用U
- AndroidStudio升级后, 新建类变成了下面这个样子, 并且默认还没有修饰符, 一堆大写的英文看的我一脸懵逼, 后来在stackov