Spring Boot 支持多种外部配置方式
2017-11-06 11:58
375 查看
这些方式优先级如下:
命令行参数
来自
Java系统属性(
操作系统环境变量
通过
通过
参数用
可以使用的参数可以是我们自己定义的,也可以是Spring Boot中默认的参数。
很多人可能会关心如web端口如何配置这样的问题,这些都是Spring Boot中提供的参数,部分可用参数如下:
2
3
4
5
6
7
8
9
10
11
12
13
更多常见的应用属性请浏览这里
注意:命令行参数在
可以通过
注意Java系统属性位置
例如
配置过JAVA_HOME的应该都了解这一个。
这里需要注意的地方,有些OS可以不支持使用
具体名字如何匹配,看本文后面。
系统中用到随机数的地方,例如:
2
3
4
5
在配置文件中直接写:
2
2
3
当有前缀的情况下,使用
注意:使用
spring会从classpath下的
这个注解可以指定具体的属性配置文件,优先级比较低。
例如:
2
3
4
5
6
这种方式是最简单的,通过
Spring Boot 可以方便的将属性注入到一个配置对象中。例如:
2
3
4
对应对象:
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Spring Boot 会自动将
Spring Boot 会自动转换类型,当使用
Spring Boot 还支持嵌套属性注入,例如:
2
3
4
对应的配置类:
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
例如:
2
3
4
5
Spring Boot 会将
例如:
2
可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。
通过如
由于
Boot 已经将
如果你是引入的Spring Boot,你可以修改使用其他的分隔符
例如修改web默认端口需要使用
那么就可以使用更短的
例如有如下配置对象:
2
3
4
5
6
7
可以使用
2
3
4
5
6
7
8
9
10
以上是Spring Boot 属性配置和使用的内容,有些不全面的地方或者读者有更多疑问,可以查看Spring
Boot完整文档 或 Externalized
Configuration。
转自:http://blog.csdn.net/isea533/article/details/50281151
命令行参数
来自
java:comp/env的JNDI属性
Java系统属性(
System.getProperties())
操作系统环境变量
RandomValuePropertySource配置的
random.*属性值
jar包外部的
application-{profile}.properties或
application.yml(带
spring.profile)配置文件
jar包内部的
application-{profile}.properties或
application.yml(带
spring.profile)配置文件
jar包外部的
application.properties或
application.yml(不带
spring.profile)配置文件
jar包内部的
application.properties或
application.yml(不带
spring.profile)配置文件
@Configuration注解类上的
@PropertySource
通过
SpringApplication.setDefaultProperties指定的默认属性
命令行参数
通过java -jar app.jar --name="Spring" --server.port=9090方式来传递参数。
参数用
--xxx=xxx的形式传递。
可以使用的参数可以是我们自己定义的,也可以是Spring Boot中默认的参数。
很多人可能会关心如web端口如何配置这样的问题,这些都是Spring Boot中提供的参数,部分可用参数如下:
# LOGGING logging.path=/var/logs logging.file=myapp.log logging.config= # location of config file (default classpath:logback.xml for logback) logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) # EMBEDDED SERVER CONFIGURATION (ServerProperties) server.port=8080 server.address= # bind to a specific NIC server.session-timeout= # session timeout in seconds server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha server.context-path= # the context path, defaults to '/' server.servlet-path= # the servlet path, defaults to '/'1
2
3
4
5
6
7
8
9
10
11
12
13
更多常见的应用属性请浏览这里
注意:命令行参数在
app.jar的后面!
可以通过
SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。
Java系统属性
注意Java系统属性位置java -Dname="isea533" -jar app.jar,可以配置的属性都是一样的,优先级不同。
例如
java -Dname="isea533" -jar app.jar --name="Spring!"中
name值为
Spring!
操作系统环境变量
配置过JAVA_HOME的应该都了解这一个。这里需要注意的地方,有些OS可以不支持使用
.这种名字,如
server.port,这种情况可以使用
SERVER_PORT来配置。
具体名字如何匹配,看本文后面。
RandomValuePropertySource
系统中用到随机数的地方,例如:my.secret=${random.value} my.number=${random.int} my.bignumber=${random.long} my.number.less.than.ten=${random.int(10)} my.number.in.range=${random.int[1024,65536]}1
2
3
4
5
random.int*支持
value参数和
,max参数,当提供
max参数的时候,
value就是最小值。
应用配置文件(.properties或.yml)
在配置文件中直接写:name=Isea533 server.port=80801
2
.yml格式的配置文件如:
name: Isea533 server: port: 80801
2
3
当有前缀的情况下,使用
.yml格式的配置文件更简单。关于
.yml配置文件用法请看这里
注意:使用
.yml时,属性名的值和冒号中间必须有空格,如
name: Isea533正确,
name:Isea533就是错的。
属性配置文件的位置
spring会从classpath下的/config目录或者classpath的根目录查找
application.properties或
application.yml。
/config优先于
classpath根目录
@PropertySource
这个注解可以指定具体的属性配置文件,优先级比较低。
SpringApplication.setDefaultProperties
例如:SpringApplication application = new SpringApplication(Application.class); Map<String, Object> defaultMap = new HashMap<String, Object>(); defaultMap.put("name", "Isea-Blog"); //还可以是Properties对象 application.setDefaultProperties(defaultMap); application.run(args);1
2
3
4
5
6
应用(使用)属性
@Value(“${xxx}”)
这种方式是最简单的,通过@Value注解可以将属性值注入进来。
@ConfigurationProperties
Spring Boot 可以方便的将属性注入到一个配置对象中。例如:my.name=Isea533 my.port=8080 my.servers[0]=dev.bar.com my.servers[1]=foo.bar.com1
2
3
4
对应对象:
@ConfigurationProperties(prefix="my") public class Config { private String name; private Integer port; private List<String> servers = new ArrayList<String>(); public String geName(){ return this.name; } public Integer gePort(){ return this.port; } public List<String> getServers() { return this.servers; } }1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Spring Boot 会自动将
prefix="my"前缀为
my的属性注入进来。
Spring Boot 会自动转换类型,当使用
List的时候需要注意在配置中对
List进行初始化!
Spring Boot 还支持嵌套属性注入,例如:
name=isea533 jdbc.username=root jdbc.password=root ...1
2
3
4
对应的配置类:
@ConfigurationProperties public class Config { private String name; private Jdbc jdbc; class Jdbc { private String username; private String password; //getter... } public Integer gePort(){ return this.port; } public Jdbc getJdbc() { return this.jdbc; } }1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
jdbc开头的属性都会注入到
Jdbc对象中。
在@Bean方法上使用@ConfigurationProperties
例如:@ConfigurationProperties(prefix = "foo") @Bean public FooComponent fooComponent() { ... }1
2
3
4
5
Spring Boot 会将
foo开头的属性按照名字匹配注入到
FooComponent对象中。
属性占位符
例如:app.name=MyApp app.description=${app.name} is a Spring Boot application1
2
可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。
通过如
${app.name:默认名称}方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。
由于
${}方式会被Maven处理。如果你pom继承的
spring-boot-starter-parent,Spring
Boot 已经将
maven-resources-plugins默认的
${}方式改为了
@ @方式,例如
@name@。
如果你是引入的Spring Boot,你可以修改使用其他的分隔符
通过属性占位符还能缩短命令参数
例如修改web默认端口需要使用--server.port=9090方式,如果在配置中写上:
server.port=${port:8080}1
那么就可以使用更短的
--port=9090,当不提供该参数的时候使用默认值
8080。
属性名匹配规则
例如有如下配置对象:@Component @ConfigurationProperties(prefix="person") public class ConnectionSettings { private String firstName; }1
2
3
4
5
6
7
firstName可以使用的属性名如下:
person.firstName,标准的驼峰式命名
person.first-name,虚线(
-)分割方式,推荐在
.properties和
.yml配置文件中使用
PERSON_FIRST_NAME,大写下划线形式,建议在系统环境变量中使用
属性验证
可以使用JSR-303注解进行验证,例如:
@Component @ConfigurationProperties(prefix="connection") public class ConnectionSettings { @NotNull private InetAddress remoteAddress; // ... getters and setters }1
2
3
4
5
6
7
8
9
10
最后
以上是Spring Boot 属性配置和使用的内容,有些不全面的地方或者读者有更多疑问,可以查看SpringBoot完整文档 或 Externalized
Configuration。
转自:http://blog.csdn.net/isea533/article/details/50281151
相关文章推荐
- Spring Boot 支持多种外部配置方式
- Spring Boot 支持多种外部配置方式1
- Spring Boot 支持多种外部配置方式
- 配置Apache支持以支持多种验证方式并存
- spring boot(8) 配置外部tomcat(2) dependencyManagement的方式
- Spring Boot全局支持CORS(跨源请求)的配置方法
- asp.net生成高质量缩略图通用函数(c#代码),支持多种生成方式 作者:Jerry
- [推荐]Eclipse配色插件---Eclipse Color Theme,支持多种颜色配置
- asp.net生成高质量缩略图通用函数(c#代码),支持多种生成方式
- asp.net生成缩略图通用函数(支持多种生成方式)
- php截取中文字符串,支持多种编码方式
- 如何在spring中配置使得mybatis3.1.1中支持vendor方式的multi-db(多数据库)
- [EntLib]微软企业库5.0 学习之路——第八步、使用Configuration Setting模块等多种方式分类管理企业库配置信息
- 让一个软件系统同时支持多个多种数据库灵活配置,让客户可以任意配置各个核心数据库部分
- servlet 3.0无需配置web.xml,使用注入方式配置servlet实现登陆功能(服务器需要支持servlet3.0)
- 以支持多种浏览器的方式创建 XMLHttpRequest 对象
- 如何在spring中配置使得mybatis3.1.1中支持vendor方式的multi-db(多数据库)
- 完美Ajax类,支持事件,支持容器,支持多种操作方式,兼容ie,firefox
- Spring Boot缓存实战 Redis 设置有效时间和自动刷新缓存,时间支持在配置文件中配置
- 【Spring进阶】spring对AOP的支持-注解方式和配置方式