详解Spring Boot 属性配置和使用

spring boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码，简单说就是可以通过配置文件来注入属性或者修改默认的配置。

spring boot 支持多种外部配置方式

这些方式优先级如下：

1. 命令行参数
2. 来自java:comp/env的jndi属性
3. java系统属性（system.getproperties()）
4. 操作系统环境变量
5. randomvaluepropertysource配置的random.*属性值
6. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
8. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9. jar包内部的application.properties或application.yml(不带spring.profile)配置文件
10. @configuration注解类上的@propertysource
11. 通过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 '/'

更多常见的应用属性请浏览这里

注意：命令行参数在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]}

random.int*支持value参数和,max参数，当提供max参数的时候，value就是最小值。

应用配置文件（.properties或.yml）

在配置文件中直接写：

name=isea533
server.port=8080

.yml格式的配置文件如：

name: isea533
server:
  port: 8080

当有前缀的情况下，使用.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);

应用（使用）属性

@value(“${xxx}”)

这种方式是最简单的，通过@value注解可以将属性值注入进来。

@configurationproperties

spring boot 可以方便的将属性注入到一个配置对象中。例如：

my.name=isea533
my.port=8080
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

对应对象：

@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;
  }
}

spring boot 会自动将prefix="my"前缀为my的属性注入进来。

spring boot 会自动转换类型，当使用list的时候需要注意在配置中对list进行初始化！

spring boot 还支持嵌套属性注入，例如：

name=isea533
jdbc.username=root
jdbc.password=root
...

对应的配置类：

@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;
  }
}

jdbc开头的属性都会注入到jdbc对象中。

在@bean方法上使用@configurationproperties

例如：

@configurationproperties(prefix = "foo")
@bean
public foocomponent foocomponent() {
  ...
}

spring boot 会将foo开头的属性按照名字匹配注入到foocomponent对象中。

属性占位符

例如：

app.name=myapp
app.description=${app.name} is a spring boot application

可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。

通过如${app.name:默认名称}方法还可以设置默认值，当找不到引用的属性时，会使用默认的属性。

由于${}方式会被maven处理。如果你pom继承的spring-boot-starter-parent，spring boot 已经将maven-resources-plugins默认的${}方式改为了@ @方式，例如@name@。

如果你是引入的spring boot，你可以修改使用其他的分隔符

通过属性占位符还能缩短命令参数

例如修改web默认端口需要使用--server.port=9090方式，如果在配置中写上：

server.port=${port:8080}

那么就可以使用更短的--port=9090，当不提供该参数的时候使用默认值8080。

属性名匹配规则

例如有如下配置对象：

@component
@configurationproperties(prefix="person")
public class connectionsettings {

  private string firstname;

}

firstname可以使用的属性名如下：

1. person.firstname，标准的驼峰式命名
2. person.first-name，虚线（-）分割方式，推荐在.properties和.yml配置文件中使用
3. person_first_name，大写下划线形式，建议在系统环境变量中使用

属性验证

可以使用jsr-303注解进行验证，例如：

@component
@configurationproperties(prefix="connection")
public class connectionsettings {

  @notnull
  private inetaddress remoteaddress;

  // ... getters and setters

}

最后

以上是spring boot 属性配置和使用的内容，有些不全面的地方或者读者有更多疑问，可以查看spring boot完整文档 或 externalized configuration。希望对大家的学习有所帮助，也希望大家多多支持。