【springboot】读取外部的设置文件

一、利用场景

假设有一个生意业务商品的体系，客户盼望能机动修改首页保举商品的个数 num。
假如 num 是写在代码里的固定值，每次修改，开发职员就得重新将体系打包摆设上线，费时费力。
但假如 num 是写在 jar 包的外部设置文件中，开发职员只须要修改该外部设置文件，然后重启已经摆设上线的体系，就可以到达机动修改 num 的结果啦。
二、代码实现

（一）application.yml 的设置

设置外部文件的路径，这里是 customer.yml，和 src 文件夹同级，如图。

1. customer:
2.   path: customer.yml

复制代码

（二）编辑 customer.yml

这里设置了一个 num，值是 5

1. num: 5

复制代码

（三）自界说方法读取外部设置文件

1. package com.xxx.env;
3. import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
4. import org.springframework.boot.SpringApplication;
5. import org.springframework.boot.env.EnvironmentPostProcessor;
6. import org.springframework.core.env.ConfigurableEnvironment;
7. import org.springframework.core.env.PropertiesPropertySource;
8. import org.springframework.core.env.PropertySource;
9. import org.springframework.core.io.FileSystemResource;
10. import org.springframework.core.io.Resource;
12. import java.io.File;
13. import java.util.Properties;
15. public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor {
17.     @Override
18.     public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
19.         //自定义配置文件，对应 application.yml 里的前缀
20.         String profiles = environment.getProperty("customer.path");
21.         //加载成PropertySource对象，并添加到Environment环境中
22.         File file = new File(profiles);
23.         Resource resource = new FileSystemResource(file);
24.         environment.getPropertySources().addLast(loadProfiles(resource));
26.     }
28.     /**
29.      * 加载单个配置文件
30.      * @param resource
31.      * @return
32.      */
33.     private PropertySource<?> loadProfiles(Resource resource) {
34.         // 判断资源是否存在
35.         if (!resource.exists()) {
36.             throw new IllegalArgumentException("资源" + resource + "不存在");
37.         }
38.         // 判断后缀名，兼容 .yml 文件和 .properties 文件
39.         if (resource.getFilename().contains(".yml")) {
40.             return loadYaml(resource);
41.         } else {
42.             return loadProperty(resource);
43.         }
44.     }
46.     /**
47.      * 加载properties格式的配置文件
48.      *
49.      * @param resource
50.      * @return
51.      */
52.     private PropertySource loadProperty(Resource resource) {
53.         try {
54.             //从输入流中加载一个Properties对象
55.             Properties properties = new Properties();
56.             properties.load(resource.getInputStream());
57.             return new PropertiesPropertySource(resource.getFilename(), properties);
58.         } catch (Exception ex) {
59.             throw new IllegalStateException("加载配置文件失败" + resource, ex);
60.         }
61.     }
63.     /**
64.      * 加载yml格式的配置文件
65.      *
66.      * @param resource
67.      * @return
68.      */
69.     private PropertySource loadYaml(Resource resource) {
70.         try {
71.             YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
72.             factory.setResources(resource);
73.             //从输入流中加载一个Properties对象
74.             Properties properties = factory.getObject();
75.             return new PropertiesPropertySource(resource.getFilename(), properties);
76.         } catch (Exception ex) {
77.             throw new IllegalStateException("加载配置文件失败" + resource, ex);
78.         }
79.     }
80. }

复制代码

（四）将自界说方法注册到 Spring Boot

在 src/main/resources/META-INF/spring.factories 中注册自界说方法 MyEnvironmentPostProcessor，如下

1. # 将自定义方法的路径填进去
2. org.springframework.boot.env.EnvironmentPostProcessor=com.xxx.env.MyEnvironmentPostProcessor

复制代码

（五）利用外部设置文件的设置

1. import org.springframework.beans.factory.annotation.Autowired;
2. import org.springframework.core.env.Environment;
3. import org.springframework.web.bind.annotation.GetMapping;
4. import org.springframework.web.bind.annotation.RestController;
6. @RestController
7. public class TestController {
8.     @Autowired
9.     private Environment environment;
11.     @GetMapping("/test")
12.     public void test() {
13.         // 读取 num 配置值，不为空则输出
14.         String num = environment.getProperty("num");
15.         if (num != null && !num.equals("")) {
16.             System.out.println("num = " + num);
17.         } else {
18.             System.out.println("num is null or ''");
19.         }
20.     }
21. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！qidao123.com:ToB企服之家，中国第一个企服评测及软件市场,开放入驻,技术点评得现金