前言
在系统运行过程中,可能由于一些配置项的简单变动需要重新打包启停项目,这对于在运行中的项目会造成数据丢失,客户操作无响应等情况发生,针对这类情况对开发框架进行升级提供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);