Spring boot使用application.properties进行外部配置

雨点打透心脏的1/2处 2022-04-22 12:22 236阅读 0赞

原文地址：http://blog.csdn.net/yingxiake/article/details/51260302

application.properties大家都不陌生，我们在开发的时候，经常使用它来配置一些可以手动修改而且不用编译的变量，这样的作用在于，打成war包或者jar用于生产环境时，我们可以手动修改环境变量而不用再重新编译。

spring boo默认已经配置了很多环境变量，例如，tomcat的默认端口是8080，项目的contextpath是“/”等等，可以在这里看spring boot默认的配置信息[http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/\#boot-features-external-config][http_docs.spring.io_spring-boot_docs_current-SNAPSHOT_reference_htmlsingle_boot-features-external-config]

spring boot允许你自定义一个application.properties文件，然后放在以下的地方，来重写spring boot的环境变量或者定义你自己环境变量

1.  当前目录的 “/config”的子目录下
2.  当前目录下
3.  classpath根目录的“/config”包下
4.  classpath的根目录下

1点和2点适合在生产环境下，例如，打包成可执行的jar包

![这里写图片描述][20160427151104455]

这里要注意，“当前目录”是指demo.jar包的目录下，要使配置文件生效，在使用java -jar demo.jar的命令时，必须先路由到demo.jar包的路径下，再使用其命名，

![这里写图片描述][20160427151652306]

3点和4点适合在开发环境下

![这里写图片描述][20160427151008985]

如果同时在四个地方都有配置文件，配置文件的优先级是从1到4。

使用配置文件之后，spring boo启动时，会自动把配置信息读取到spring容器中，并覆盖spring boot的默认配置，那么，我们怎么来读取和设置这些配置信息呢

1.通过命令行来重写和配置环境变量，优先级最高，例如可以通过下面的命令来重写spring boot 内嵌tomcat的服务端口，注意“=”俩边不要有空格

java -jar demo.jar --server.port=9000

*  1

如果想要设置多个变量怎么办，可以已json的格式字符串来设置

java -jar demo.jar --spring.application.json='{"foo":"bar"}'

*  1

2.通过@value注解来读取

1.  `@RestController`
2.  `@RequestMapping("/task")`
3.  `public class TaskController {`
4.   
5.  `@Value("${connection.remoteAddress}") private String address;`
6.   
7.  `@RequestMapping(value = {"/",""})`
8.  `public String hellTask(@Value("${connection.username}")String name){`
9.   
10. `return "hello task !!";`
11. `}`
12.  
13. `}`

3.通过Environment接口来获取，只需要把接口注进去即可

1.  `@RestController`
2.  `@RequestMapping("/task")`
3.  `public class TaskController {`
4.   
5.  `@Autowired Environment ev ;`
6.   
7.  `@Value("${connection.remoteAddress}") private String address;`
8.   
9.  `@RequestMapping(value = {"/",""})`
10. `public String hellTask(@Value("${connection.username}")String name){`
11.  
12. `String password = ev.getProperty("connection.password");`
13. `return "hello task !!";`
14. `}`
15.  
16. `}`

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16

4.可以自定义一个工具类，来获取，这种方式关键在于读取配置文件信息，适合自定义的配置信息，spring 容器默认的配置信息会读不到

1.  `@Component`
2.  `public class SystemConfig {`
3.   
4.  `private static Properties props ;`
5.   
6.  `public SystemConfig(){`
7.   
8.  `try {`
9.  `Resource resource = new ClassPathResource("/application.properties");//`
10. `props = PropertiesLoaderUtils.loadProperties(resource);`
11. `} catch (IOException e) {`
12. `e.printStackTrace();`
13. `}`
14. `}`
15.  
16.  
17. `/**`
18. `* 获取属性`
19. `* @param key`
20. `* @return`
21. `*/`
22. `public static String getProperty(String key){`
23.  
24. `return props == null ? null : props.getProperty(key);`
25.  
26. `}`
27.  
28. `/**`
29. `* 获取属性`
30. `* @param key 属性key`
31. `* @param defaultValue 属性value`
32. `* @return`
33. `*/`
34. `public static String getProperty(String key,String defaultValue){`
35.  
36. `return props == null ? null : props.getProperty(key, defaultValue);`
37.  
38. `}`
39.  
40. `/**`
41. `* 获取properyies属性`
42. `* @return`
43. `*/`
44. `public static Properties getProperties(){`
45. `return props;`
46. `}`
47.  
48. `}`
49.  
50. `//用的话，就直接这样子`
51. `String value = SystemConfig.getProperty("key");`

5.可以利用$\{…\}在application.properties引用变量

1.  `myapp.name=spring`
2.  `myapp.desc=${myapp.name} nice`

*  1
 *  2

6.可以在application.properties配置随机变量,利用的是RandomValuePropertySource类

1.  `my.secret=${random.value}`
2.  `my.number=${random.int}`
3.  `my.bignumber=${random.long}`
4.  `my.number.less.than.ten=${random.int(10)}`
5.  `my.number.in.range=${random.int[1024,65536]}`

*  1
 *  2
 *  3
 *  4
 *  5

简单的配置文件的使用就先写到这里，再看看其他高级用法，如Profiles还有@ConfigurationProperties

[http_docs.spring.io_spring-boot_docs_current-SNAPSHOT_reference_htmlsingle_boot-features-external-config]: http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#boot-features-external-config
[20160427151104455]: /images/20220422/c42ecab622ef4e17b565942378149d59.png
[20160427151652306]: /images/20220422/969e47dbc4d4465db4e4585eb7e0632b.png
[20160427151008985]: /images/20220422/43c721a84b86495fab2785feb81a84dd.png