自定义属性与加载

我们在使用Spring Boot的时候,通常也需要定义一些自己使用的属性,我们可以如下方式直接定义:

application-dev.yml

  1 com.didispace.blog:
2
3 name: 程序猿DD
4
5 title: Spring Boot教程
6
7 desc: ${com.didispace.blog.name}正在努力写《${com.didispace.blog.title}》
8
9 # 随机字符串
10
11 value: ${random.value}
12
13 # 随机int
14
15 number: ${random.int}
16
17 # 随机long
18
19 bignumber: ${random.long}
20
21 # 10以内的随机数
22
23 test1: ${random.int(10)}
24
25 # 10-20的随机数
26
27 test2: ${random.int[10,20]}
28
  1 package com.wls.integrateplugs.property;
2
3 import org.springframework.beans.factory.annotation.Value;
4
5 import org.springframework.stereotype.Component;
6
7 /**
8
9 * @author 程序猿DD
10
11 * @version 1.0.0
12
13 * @date 16/5/5 下午12:16.
14
15 * @blog http://blog.didispace.com
16
17 */
18
19 @Component
20
21 public class BlogProperties {
22
23 @Value("${com.didispace.blog.name}")
24
25 private String name;
26
27 @Value("${com.didispace.blog.title}")
28
29 private String title;
30
31 @Value("${com.didispace.blog.desc}")
32
33 private String desc;
34
35 @Value("${com.didispace.blog.value}")
36
37 private String value;
38
39 @Value("${com.didispace.blog.number}")
40
41 private Integer number;
42
43 @Value("${com.didispace.blog.bignumber}")
44
45 private Long bignumber;
46
47 @Value("${com.didispace.blog.test1}")
48
49 private Integer test1;
50
51 @Value("${com.didispace.blog.test2}")
52
53 private Integer test2;
54
55 public String getName() {
56
57 return name;
58
59 }
60
61 public void setName(String name) {
62
63 this.name = name;
64
65 }
66
67 public String getTitle() {
68
69 return title;
70
71 }
72
73 public void setTitle(String title) {
74
75 this.title = title;
76
77 }
78
79 public String getDesc() {
80
81 return desc;
82
83 }
84
85 public void setDesc(String desc) {
86
87 this.desc = desc;
88
89 }
90
91 public String getValue() {
92
93 return value;
94
95 }
96
97 public void setValue(String value) {
98
99 this.value = value;
100
101 }
102
103 public Integer getNumber() {
104
105 return number;
106
107 }
108
109 public void setNumber(Integer number) {
110
111 this.number = number;
112
113 }
114
115 public Long getBignumber() {
116
117 return bignumber;
118
119 }
120
121 public void setBignumber(Long bignumber) {
122
123 this.bignumber = bignumber;
124
125 }
126
127 public Integer getTest1() {
128
129 return test1;
130
131 }
132
133 public void setTest1(Integer test1) {
134
135 this.test1 = test1;
136
137 }
138
139 public Integer getTest2() {
140
141 return test2;
142
143 }
144
145 public void setTest2(Integer test2) {
146
147 this.test2 = test2;
148
149 }
150
151 }
152

按照惯例,通过单元测试来验证BlogProperties中的属性是否已经根据配置文件加载了。然后通过@Value("${属性名}")注解来加载对应的配置属性,具体如下:

单元测试

  1 package com.wls.test.integrateplugs.property;
2
3 import com.wls.integrateplugs.property.BlogProperties;
4
5 import org.apache.commons.logging.Log;
6
7 import org.apache.commons.logging.LogFactory;
8
9 import org.junit.Assert;
10
11 import org.junit.Test;
12
13 import org.junit.runner.RunWith;
14
15 import org.springframework.beans.factory.annotation.Autowired;
16
17 import org.springframework.boot.test.context.SpringBootTest;
18
19 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
20
21 /**
22
23 *
24
25 * @author 程序猿DD
26
27 * @version 1.0.0
28
29 * @blog http://blog.didispace.com
30
31 *
32
33 */
34
35 @RunWith(SpringJUnit4ClassRunner.class)
36
37 @SpringBootTest
38
39 public class BlogPropertiesTest {
40
41 private static final Log log = LogFactory.getLog(BlogPropertiesTest.class);
42
43 @Autowired
44
45 private BlogProperties blogProperties;
46
47 @Test
48
49 public void test1() throws Exception {
50
51 Assert.assertEquals("程序猿DD", blogProperties.getName());
52
53 Assert.assertEquals("Spring Boot教程", blogProperties.getTitle());
54
55 Assert.assertEquals("程序猿DD正在努力写《Spring Boot教程》", blogProperties.getDesc());
56
57 log.info("随机数测试输出:");
58
59 log.info("随机字符串 : " + blogProperties.getValue());
60
61 log.info("随机int : " + blogProperties.getNumber());
62
63 log.info("随机long : " + blogProperties.getBignumber());
64
65 log.info("随机10以下 : " + blogProperties.getTest1());
66
67 log.info("随机10-20 : " + blogProperties.getTest2());
68
69 }
70
71 }
72


参数间的引用

application.properties中的各个参数之间也可以直接引用来使用,就像下面的设置:

  1 com.didispace.blog.name=程序猿DD
2
3 com.didispace.blog.title=Spring Boot教程
4
5 com.didispace.blog.desc=${com.didispace.blog.name}正在努力写《${com.didispace.blog.title}》
6
7 com.didispace.blog.desc参数引用了上文中定义的name和title属性,最后该属性的值就是程序猿DD正在努力写《Spring Boot教程》。
8

使用随机数

在一些情况下,有些参数我们需要希望它不是一个固定的值,比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过${random}来产生int值、long值或者string字符串,来支持属性的随机值。

  1 # 随机字符串
2
3 com.didispace.blog.value=${random.value}
4
5 # 随机int
6
7 com.didispace.blog.number=${random.int}
8
9 # 随机long
10
11 com.didispace.blog.bignumber=${random.long}
12
13 # 10以内的随机数
14
15 com.didispace.blog.test1=${random.int(10)}
16
17 # 10-20的随机数
18
19 com.didispace.blog.test2=${random.int[10,20]}
20

通过命令行设置属性值

相信使用过一段时间Spring Boot的用户,一定知道这条命令:java -jar xxx.jar --server.port=8888,通过使用–server.port属性来设置xxx.jar应用的端口为8888。

在命令行运行时,连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以,java -jar xxx.jar --server.port=8888命令,等价于我们在application.properties中添加属性server.port=8888,该设置在样例工程中可见,读者可通过删除该值或使用命令行来设置该值来验证。

通过命令行来修改属性值固然提供了不错的便利性,但是通过命令行就能更改应用运行的参数,那岂不是很不安全?是的,所以Spring Boot也贴心的提供了屏蔽命令行访问属性的设置,只需要这句设置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)

多环境配置

我们在开发Spring Boot应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同,如果在为不同环境打包时都要频繁修改配置文件的话,那必将是个非常繁琐且容易发生错误的事。

对于多环境的配置,各种项目构建工具或是框架的基本思路是一致的,通过配置多份不同环境的配置文件,再通过打包命令指定需要打包的内容之后进行区分打包,Spring Boot也不例外,或者说更加简单。

在Spring Boot中多环境配置文件名需要满足application-{profile}.properties的格式,其中{profile}对应你的环境标识,比如:

  • application-dev.properties:开发环境

  • application-test.properties:测试环境
  • application-prod.properties:生产环境

至于哪个具体的配置文件会被加载,需要在application.properties文件中通过spring.profiles.active属性来设置,其值对应{profile}值。

如:spring.profiles.active=test就会加载application-test.properties配置文件内容

下面,以不同环境配置不同的服务端口为例,进行样例实验。

  • 针对各环境新建不同的配置文件application-dev.propertiesapplication-test.propertiesapplication-prod.properties

  • 在这三个文件均都设置不同的server.port属性,如:dev环境设置为1111,test环境设置为2222,prod环境设置为3333

  • application.properties中设置spring.profiles.active=dev,就是说默认以dev环境设置

  • 测试不同配置的加载

    • 执行java -jar xxx.jar,可以观察到服务端口被设置为1111,也就是默认的开发环境(dev)

    • 执行java -jar xxx.jar --spring.profiles.active=test,可以观察到服务端口被设置为2222,也就是测试环境的配置(test)
    • 执行java -jar xxx.jar --spring.profiles.active=prod,可以观察到服务端口被设置为3333,也就是生产环境的配置(prod)

按照上面的实验,可以如下总结多环境的配置思路:

  • application.properties中配置通用内容,并设置spring.profiles.active=dev,以开发环境为默认配置

  • application-{profile}.properties中配置各个环境不同的内容
  • 通过命令行方式去激活不同环境的配置

引用:air_balloon

Spring Boot配置文件详解:自定义属性、随机数、多环境配置的更多相关文章

  1. Spring Boot 配置文件详解

    Spring Boot配置文件详解 Spring Boot提供了两种常用的配置文件,分别是properties文件和yml文件.他们的作用都是修改Spring Boot自动配置的默认值.相对于prop ...

  2. Spring Boot☞ 配置文件详解:自定义属性、随机数、多环境配置等

    自定义属性与加载 我们在使用Spring Boot的时候,通常也需要定义一些自己使用的属性,我们可以如下方式直接定义: application-dev.yml com.didispace.blog: ...

  3. (转) SpringBoot非官方教程 | 第二篇:Spring Boot配置文件详解

    springboot采纳了建立生产就绪spring应用程序的观点. Spring Boot优先于配置的惯例,旨在让您尽快启动和运行.在一般情况下,我们不需要做太多的配置就能够让spring boot正 ...

  4. SpringBoot非官方教程 | 第二篇:Spring Boot配置文件详解

    转载请标明出处: 原文首发于:https://www.fangzhipeng.com/springboot/2017/07/11/springboot2-config-file/ 本文出自方志朋的博客 ...

  5. 史上最全的Spring Boot配置文件详解

    Spring Boot在工作中是用到的越来越广泛了,简单方便,有了它,效率提高不知道多少倍.Spring Boot配置文件对Spring Boot来说就是入门和基础,经常会用到,所以写下做个总结以便日 ...

  6. Spring Boot配置文件详解-ConfigurationProperties和Value优缺点-(转)好文

    文章转自 http://www.cnblogs.com/itdragon/p/8686554.html Spring Boot提供了两种常用的配置文件,分别是properties文件和yml文件.他们 ...

  7. Spring boot 配置文件详解 (properties 和yml )

    从其他框架来看 我们都有自己的配置文件, hibernate有hbm,mybatis 有properties, 同样, Spring boot 也有全局配置文件. Springboot使用一个全局的配 ...

  8. Spring boot 入门二:Spring Boot配置文件详解

    一.自定义属性 当我们创建一个springboot项目的时候,系统默认会为我们在src/main/java/resources目录下创建一个application.properties.同时也支持ym ...

  9. Spring Boot 配置文件详解:Properties和YAML

    一.配置文件的生效顺序,会对值进行覆盖: 1. @TestPropertySource 注解 2. 命令行参数 3. Java系统属性(System.getProperties()) 4. 操作系统环 ...

随机推荐

  1. SQL SERVER临时表的使用

    SQL SERVER临时表的使用 drop table #Tmp   --删除临时表#Tmpcreate table #Tmp --创建临时表#Tmp(    ID   int IDENTITY (1 ...

  2. MySQL版本升级5.6到5.7版本

    从5.6升级到5.7版本,5.7的版本为5.7.17 升级的过程还是比较简单,需要注意几个点 1.下载对应的包 2.备份整个数据库 3.使用升级参数 1.下载 # wget "https:/ ...

  3. python 使用pip install 手动安装本地包的方法

    Installing pystan manually fixed the issue (otherwise it would just hang forever). ~/GitHub $ git cl ...

  4. corethink功能模块探索开发(四)让这个模块跑起来

    让这个模块跑起来,太费劲了,多半原因是自己太粗心,opencmf.php中“uid”写成了“pid”,de了好几天的bug也没有搞出来,又加上最近发生了些事(brokenhearted)... 上报错 ...

  5. 【python】获取列表中最长连续数字

    最近开发遇到一个功能需求,目的是要获取一个AI分析结果中最长连续帧,比如一个视频中连续3帧有人,那么我认为这个视频就是有人,我就要判断这个视频帧列表中是否有连续的三帧有人.本质就是获取列表中的最长连续 ...

  6. 软件工作考核项(zcl)——

    注意:这里没有对代码风格做要求,因为要代码走查! 考核项 考核标准 分数等级   需求规格说明书编写 主要用例图缺失 -1   主要软件界面设计图缺失 -1   主要功能清单项目缺失 -1   主要复 ...

  7. Android:日常学习笔记(9)———探究广播机制

    Android:日常学习笔记(9)———探究广播机制 引入广播机制 Andorid广播机制 广播是任何应用均可接收的消息.系统将针对系统事件(例如:系统启动或设备开始充电时)传递各种广播.通过将 In ...

  8. paramiko 模块安装和使用

    一.Centos安装Paramiko 1.安装组件 yum install openssl openssl-devel python-dev pycrypto -y yum install zlib- ...

  9. $Android中日期和时间选择器的实现

    创建日期或时间选择窗口需要弹出Dialog的时候,Activity类的showDialog方法已经弃用了,而推荐使用的是DialogFragment,本文总结一下其具体用法. (一)日期选择器 1.创 ...

  10. hadoop01

    RPC:异步系统的调用,webservice是RPC的一种.webservice用于不在同一个公司的系统调用,同一个公司用socket调用.就是RPC. Dubbo淘宝的RPC框架. Hadoop r ...