SpringBoot 教程之属性加载详解
免费java高级资料需要自己领取,涵盖了java、redis、mongodb、mysql、zookeeper、spring cloud、dubbo高并发分布式等教程,一共30g。
传送门:https://mp.weixin.qq.com/s/jzddfh-7ynudmkjt0irl8q
目录
- 加载 property 顺序
- 随机属性
- 命令行属性
- application 属性文件
- profile 特定属性
- 属性中的占位符
- yaml 属性
- 访问属性
- 多 profile 配置
- yaml 的缺点
- 属性前缀
- 属性松散绑定规则
- 属性转换
- 时间单位转换
- 数据大小转换
- 校验属性
加载 property 顺序
spring boot 加载 property 顺序如下:
-
devtools 全局配置 (当 devtools 被激活
\~/.spring-boot-devtools.properties
). - ="https://docs.spring.io/spring/docs/5.1.3.release/javadoc-api/org/springframework/test/context/testpropertysource.html">测试环境中的 @testpropertysource 注解配置
- 测试环境中的属性
properties
:@springboottest
和 测试注解. - 命令行参数
-
spring_application_json
属性 -
servletconfig
初始化参数 -
servletcontext
初始化参数 - jndi attributes from 通过
java:comp/env
配置的 jndi 属性 - java 系统属性 (
system.getproperties()
) - 操作系统环境比那里
-
randomvaluepropertysource
加载random.*
形式的属性 - jar 包外的
application-{profile}.properties
或application-{profile}.yml
配置 - jar 包内的
application-{profile}.properties
或application-{profile}.yml
配置 - jar 包外的
application.properties
或application.yml
配置 - jar 包内的
application.properties
或application.yml
配置 -
@propertysource
绑定的配置 - 默认属性 (通过
springapplication.setdefaultproperties
指定)
随机属性
randomvaluepropertysource
类用于配置随机值。
示例:
my.secret=${random.value} my.number=${random.int} my.bignumber=${random.long} my.uuid=${random.uuid} my.number.less.than.ten=${random.int(10)} my.number.in.range=${random.int[1024,65536]}
命令行属性
默认情况下, springapplication
会获取 --
参数(例如 --server.port=9000
),并将这个 property
添加到 spring 的 environment
中。
如果不想加载命令行属性,可以通过 springapplication.setaddcommandlineproperties(false)
禁用。
application 属性文件
springapplication
会自动加载以下路径下的 application.properties
配置文件,将其中的属性读到 spring 的 environment
中。
- 当前目录的
/config
子目录 - 当前目录
- classpath 路径下的
/config
package - classpath 根路径
注:
以上列表的配置文件会根据顺序,后序的配置会覆盖前序的配置。
你可以选择 yaml(yml) 配置文件替换 properties 配置文件。
如果不喜欢 application.properties
作为配置文件名,可以使用 spring.config.name
环境变量替换:
$ java -jar myproject.jar --spring.config.name=myproject
可以使用 spring.config.location
环境变量指定配置文件路径:
$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties
profile 特定属性
如果定义 application-{profile}.properties
形式的配置文件,将被视为 profile
环境下的特定配置。
可以通过 spring.profiles.active
参数来激活 profile,如果没有激活的 profile,默认会加载 application-default.properties
中的配置。
属性中的占位符
application.properties
中的值会被 environment
过滤,所以,可以引用之前定义的属性。
app.name=myapp
app.description=${app.name} is a spring boot application
注:你可以使用此技术来创建 spring boot 属性变量。请参考: section 77.4, “use ‘short’ command line arguments
yaml 属性
spring framework provides two convenient classes that can be used to load yaml documents. the yamlpropertiesfactorybean
loads yaml as properties
and the yamlmapfactorybean
loads yaml as a map
.
spring 框架有两个类支持加载 yaml 文件。
-
yamlpropertiesfactorybean
将 yaml 文件的配置加载为properties
。 -
yamlmapfactorybean
将 yaml 文件的配置加载为map
。
示例 1
environments: dev: url: http://dev.example.com name: developer setup prod: url: http://another.example.com name: my cool app
等价于:
environments.dev.url=http://dev.example.com environments.dev.name=developer setup environments.prod.url=http://another.example.com environments.prod.name=my cool app
yaml 支持列表形式,等价于 property 中的 [index]
:
my: servers: - dev.example.com - another.example.com
等价于
my.servers[0]=dev.example.com my.servers[1]=another.example.com
访问属性
yamlpropertysourceloader
类会将 yaml 配置转化为 spring environment
类中的 propertysource
。然后,你可以如同 properties 文件中的属性一样,使用 @value
注解来访问 yaml 中配置的属性。
多 profile 配置
server: address: 192.168.1.100 --- spring: profiles: development server: address: 127.0.0.1 --- spring: profiles: production & eu-central server: address: 192.168.1.120
yaml 的缺点
注:yaml 注解中的属性不能通过 @propertysource
注解来访问。所以,如果你的项目中使用了一些自定义属性文件,建议不要用 yaml。
属性前缀
package com.example; import java.net.inetaddress; import java.util.arraylist; import java.util.collections; import java.util.list; import org.springframework.boot.context.properties.configurationproperties; @configurationproperties(prefix="acme") public class acmeproperties { private boolean enabled; private inetaddress remoteaddress; private final security security = new security(); public boolean isenabled() { ... } public void setenabled(boolean enabled) { ... } public inetaddress getremoteaddress() { ... } public void setremoteaddress(inetaddress remoteaddress) { ... } public security getsecurity() { ... } public static class security { private string username; private string password; private list<string> roles = new arraylist<>(collections.singleton("user")); public string getusername() { ... } public void setusername(string username) { ... } public string getpassword() { ... } public void setpassword(string password) { ... } public list<string> getroles() { ... } public void setroles(list<string> roles) { ... } } }
相当于支持配置以下属性:
acme.enabled
acme.remote-address
acme.security.username
acme.security.password
acme.security.roles
然后,你需要使用 @enableconfigurationproperties
注解将属性类注入配置类中。
@configuration @enableconfigurationproperties(acmeproperties.class) public class myconfiguration { }
属性松散绑定规则
spring boot 属性名绑定比较松散。
以下属性 key 都是等价的:
propertynoteacme.my-project.person.first-name-
分隔acme.myproject.person.firstname
驼峰命名acme.my_project.person.first_name_
分隔acme_myproject_person_firstname
大写字母
属性转换
如果需要类型转换,你可以提供一个 conversionservice
bean (一个名叫 conversionservice
的 bean) 或自定义属性配置 (一个 customeditorconfigurer
bean) 或自定义的 converters
(被 @configurationpropertiesbinding
注解修饰的 bena)。
时间单位转换
spring 使用 java.time.duration
类代表时间大小,以下场景适用:
- 除非指定
@durationunit
,否则一个 long 代表的时间为毫秒。 - iso-8601 标准格式(
java.time.duration
的实现就是参照此标准) - 你也可以使用以下支持的单位:
-
ns
- 纳秒 -
us
- 微秒 -
ms
- 毫秒 -
s
- 秒 -
m
- 分 -
h
- 时 -
d
- 天
示例:
@configurationproperties("app.system") public class appsystemproperties { @durationunit(chronounit.seconds) private duration sessiontimeout = duration.ofseconds(30); private duration readtimeout = duration.ofmillis(1000); public duration getsessiontimeout() { return this.sessiontimeout; } public void setsessiontimeout(duration sessiontimeout) { this.sessiontimeout = sessiontimeout; } public duration getreadtimeout() { return this.readtimeout; } public void setreadtimeout(duration readtimeout) { this.readtimeout = readtimeout; } }
数据大小转换
spring 使用 datasize
类代表数据大小,以下场景适用:
- long 值(默认视为 byte)
- 你也可以使用以下支持的单位:
b
kb
mb
gb
tb
示例:
@configurationproperties("app.io") public class appioproperties { @datasizeunit(dataunit.megabytes) private datasize buffersize = datasize.ofmegabytes(2); private datasize sizethreshold = datasize.ofbytes(512); public datasize getbuffersize() { return this.buffersize; } public void setbuffersize(datasize buffersize) { this.buffersize = buffersize; } public datasize getsizethreshold() { return this.sizethreshold; } public void setsizethreshold(datasize sizethreshold) { this.sizethreshold = sizethreshold; } }
校验属性
@configurationproperties(prefix="acme") @validated public class acmeproperties { @notnull private inetaddress remoteaddress; @valid private final security security = new security(); // ... getters and setters public static class security { @notempty public string username; // ... getters and setters } }
你也可以自定义一个名为 configurationpropertiesvalidator
的校验器 bean。获取这个 @bean
的方法必须声明为 static
。
使用方法:
mvn clean package cd target java -jar sbe-core-property.jar
上一篇: 类型转换函数