Spring boot中yml配置文件的缩进是按前面字母的,不是以后面":"为参照物的
注解是javaSE5中的重要的语言变化之一。
它们可以提供用来完整地描述程序所需的信息,而这些信息是无法用java来表达的。
因此注解可以用来生成描述文件,甚至或是新的类定义,并且有助于减轻编写”样板“代码的负担。
通过使用注解,可以将这些元素数据保存在Java源代码中,并利用annotation API为自己的注解构造处理工具,
同时,注解的优点还包括:更加干净易读的代码以及编译期类型检查等。
注解中定义了名为value的元素,并且在应用该注解的时候,如果该元素是唯一需要赋值的一个元素,那么无需使用名-值对的这种语法,而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素。
当然了,这也限制了程序员必须将此元素命名为value
Spring Boot 属性配置和使用
Spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置。
Spring Boot 入门 请看:http://blog.csdn.net/isea533/article/details/50278205
Spring Boot 支持多种外部配置方式
这些方式优先级如下:
- 命令行参数
- 来自
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中提供的参数,部分可用参数如下:
1 # LOGGING 2 logging.path=/var/logs 3 logging.file=myapp.log 4 logging.config= # location of config file (default classpath:logback.xml for logback) 5 logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) 6 7 # EMBEDDED SERVER CONFIGURATION (ServerProperties) 8 server.port=8080 9 server.address= # bind to a specific NIC 10 server.session-timeout= # session timeout in seconds 11 server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha 12 server.context-path= # the context path, defaults to '/' 13 server.servlet-path= # the servlet path, defaults to '/'
更多常见的应用属性请浏览这里
注意:命令行参数在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
系统中用到随机数的地方,例如:
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]}
random.int*
支持value
参数和,max
参数,当提供max
参数的时候,value
就是最小值。
应用配置文件(.properties或.yml)
在配置文件中直接写:
1 name=Isea533 2 3 server.port=8080
.yml
格式的配置文件如:
1 name: Isea533 2 server: 3 port: 8080
当有前缀的情况下,使用.yml
格式的配置文件更简单。关于.yml
配置文件用法请看这里
注意:使用.yml
时,属性名的值和冒号中间必须有空格,如name: Isea533
正确,name:Isea533
就是错的。
属性配置文件的位置
spring会从classpath下的/config
目录或者classpath的根目录查找application.properties
或application.yml
。
/config
优先于classpath根目录
@PropertySource
这个注解可以指定具体的属性配置文件,优先级比较低。
SpringApplication.setDefaultProperties
例如:
1 SpringApplication application = new SpringApplication(Application.class); 2 Map<String, Object> defaultMap = new HashMap<String, Object>(); 3 defaultMap.put("name", "Isea-Blog"); 4 //还可以是Properties对象 5 application.setDefaultProperties(defaultMap); 6 application.run(args);
应用(使用)属性
@Value(“${xxx}”)
这种方式是最简单的,通过@Value
注解可以将属性值注入进来。
@ConfigurationProperties
Spring Boot 可以方便的将属性注入到一个配置对象中。例如:
1 my.name=Isea533 2 my.port=8080 3 my.servers[0]=dev.bar.com 4 my.servers[1]=foo.bar.com
对应对象:
1 @ConfigurationProperties(prefix="my") 2 public class Config { 3 private String name; 4 private Integer port; 5 private List<String> servers = new ArrayList<String>(); 6 7 public String geName(){ 8 return this.name; 9 } 10 11 public Integer gePort(){ 12 return this.port; 13 } 14 public List<String> getServers() { 15 return this.servers; 16 } 17 }
Spring Boot 会自动将prefix="my"
前缀为my
的属性注入进来。
Spring Boot 会自动转换类型,当使用List
的时候需要注意在配置中对List
进行初始化!
Spring Boot 还支持嵌套属性注入,例如:
1 name=isea533 2 jdbc.username=root 3 jdbc.password=root 4 ...
对应的配置类:
1 @ConfigurationProperties 2 public class Config { 3 private String name; 4 private Jdbc jdbc; 5 class Jdbc { 6 private String username; 7 private String password; 8 //getter... 9 } 10 11 public Integer gePort(){ 12 return this.port; 13 } 14 public Jdbc getJdbc() { 15 return this.jdbc; 16 } 17 }
jdbc
开头的属性都会注入到Jdbc
对象中。
在@Bean方法上使用@ConfigurationProperties
例如:
1 @ConfigurationProperties(prefix = "foo") 2 @Bean 3 public FooComponent fooComponent() { 4 ... 5 }
Spring Boot 会将foo
开头的属性按照名字匹配注入到FooComponent
对象中。
属性占位符
例如:
1 app.name=MyApp 2 app.description=${app.name} is a Spring Boot applicati
可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。
通过如${app.name:默认名称}
方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。
由于${}
方式会被Maven处理。如果你pom继承的spring-boot-starter-parent
,Spring Boot 已经将maven-resources-plugins
默认的${}
方式改为了@ @
方式,例如@name@
。
所以,在当在配置文件application.yml或者application.properties文件中,调取pom.xml文件中的信息时,需要使用@@引用配置信息,例如:
pom.xml文件的基本信息如下:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4 <modelVersion>4.0.0</modelVersion> 5 6 <groupId>test.dd</groupId> 7 <artifactId>ddd</artifactId> 8 <version>1.0.1</version> 9 <packaging>jar</packaging> 10 11 <name>DD</name> 12 <description>测试专用</description> 13 ....... 14 15 </project>
application.yml配置文件的信息如下:
1 test: 2 name: @project.name@ 3 description: @project.description@ 4 version: @project.version@
获取编译后的application.yml文件信息如下:
1 test: 2 name: DD 3 description: 测试专用 4 version: 1.0.1
如果你是引入的Spring Boot,你可以修改使用其他的分隔符
通过属性占位符还能缩短命令参数
例如修改web默认端口需要使用--server.port=9090
方式,如果在配置中写上:
1 server.port=${port:8080}
那么就可以使用更短的--port=9090
,当不提供该参数的时候使用默认值8080
。
属性名匹配规则
例如有如下配置对象:
1 @Component 2 @ConfigurationProperties(prefix="person") 3 public class ConnectionSettings { 4 5 private String firstName; 6 7 }
firstName
可以使用的属性名如下:
person.firstName
,标准的驼峰式命名person.first-name
,虚线(-
)分割方式,推荐在.properties
和.yml
配置文件中使用PERSON_FIRST_NAME
,大写下划线形式,建议在系统环境变量中使用
属性验证
可以使用JSR-303
注解进行验证,例如:
1 @Component 2 @ConfigurationProperties(prefix="connection") 3 public class ConnectionSettings { 4 5 @NotNull 6 private InetAddress remoteAddress; 7 8 // ... getters and setters 9 10 }
最后
以上是Spring Boot 属性配置和使用的内容,有些不全面的地方或者读者有更多疑问,可以查看Spring Boot完整文档 或 Externalized Configuration。
关于Spring Boot更多的内容可以继续关注本博客。