实践Spring Boot之属性配置和使用

Posted on | In | Visitors

Spring Boot内置很多属性，具体可以参见common-application-properties，也可以自定义属性。

设置属性

Spring Boot支持多种方式设置属性值，优先级从高到低如下：

命令行参数

即java命令行参数，只是形式稍有区别，前面增加“--”，格式：--key[=value]，多个用空格分隔，例如：

1
$ java -jar app.jar --debug --server.port=9090

可以通过SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。

java:comp/env 里的JNDI属性

Java系统属性

格式：-Dkey=value

1
$ java -Dname="isea533" -Dgender=1 -jar app.jar

操作系统环境变量

1
2
3
export SERVER_PORT=8765
export SPRING_CLOUD_CONFIG_PROFILE=dev
export SPRING_PROFILES_ACTIVE=dev

1
$ java -jar target/readingList-0.0.1-SNAPSHOT.jar

备注：shell中有效，Eclipse中运行应用则不会读取操作系统环境变量

随机数

Spring Boot通过RandomValuePropertySource定义了随机数random供使用，例如：

1
2
3
4
5
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就是最小值。

关于配置文件

1
2
3
4
# 默认值
spring.config.name = application
# 默认值，优先级从低到高
spring.config.location = classpath:/,classpath:/config/,file:./,file:./config/

备注：

application.properties优先级高于application.yaml

同名属性文件只会读取一个，比如读取了外部的application-dev.properties就不会再读取应用程序内的application-dev.properties；无Profile作为默认配置会被先读取，但是会被有Profile的覆盖。

应用程序外基于Profile的配置文件

config目录或应用根目录下application-{profile}.properties或者appliaction-{profile}.yml文件或者application.yml(带spring.profiles)

application.yml(带spring.profiles)样例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
logging:
  level:
   root: INFO
---
spring:
  profiles: development
logging:
  level:
    root: DEBUG
---
spring:
  profiles: production
logging:
  path: /tmp/
  file: BookWorm.log
  level:
    root: WARN

应用程序内基于Profile的配置文件

classpath中config包或classpath根目录下application-{profile}.properties或者appliaction-{profile}.yml文件或者application.yml(带spring.profiles)

应用程序外的配置文件（默认）

不带profile的配置文件优先级较带profile的低

config目录或应用根目录下application.properties或者appliaction.yml文件(不带spring.profiles)

应用程序内的配置文件（默认）

classpath中config包或classpath根目录下application.properties或者appliaction.yml文件(不带spring.profiles)

通过 @PropertySource 引入的配置文件

默认属性

通过SpringApplication.setDefaultProperties设置的默认属性，例如：

1
2
3
4
5
6
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

1
2
3
4
5
6
@Value("${book.name}")
private String name;

// 当指定属性不存在时启动会报错，可以设置默认值避免这个问题
@Value("${book.price:99}")
private Integer price;

@Value除了支持属性注入外，还支持如下参数注入：

  1. 注入普通字符（@Value(“hello, world”)）
  2. 注入操作系统属性（@Value(“#systemProperties[‘os.name’]”)）
  3. 注入表达式运算结果（@Value(“#{ T(java.lang.Math).random()*100.0 }”)）
  4. 注入其他Bean的属性（@Value(“#{demoService.username}”)）
  5. 注入文件内容（@Value(“classpath:text.txt”)）
  6. 注入网址内容（@Value(“http://www.baidu.com”)）
  7. 注入属性（@Value(“${book.name}”)），带默认值（@Value(“${book.name:abc}”)）

@ConfigurationProperties

为了能够更加方便的分门别类的定义和使用属性，同时相较于@Value逐个配置，@ConfigurationProperties能够将相关属性批量自动绑定到Spring Bean上，会自动进行类型转换，还支持嵌套属性。一般有三种方式，第一种是配合@Component，第二种是配合@Bean，第三种是使用@EnableConfigurationProperties。

Note that contrary to @Value, SpEL expressions are not evaluated since property values are externalized.

Java Bean属性配置类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public class ServerProperties {
    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
my.name=Isea533
my.port=8080
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

第一种：在属性配置类上

1
2
3
4
5
@Component
@ConfigurationProperties(prefix="my")
public class ServerProperties {
// omitted for readability
}

第二种：绑定到@Bean，一般用于第三方Properties类【他们没有被@ConfigurationProperties注解】，例如：

1
2
3
4
5
6
7
@Bean
@ConfigurationProperties(prefix = "foo")
public ServerProperties createServerProperties() {
    ServerProperties serverProperties = new ServerProperties();
    ...
    return serverProperties;
}

第三种：参见@EnableConfigurationProperties

属性占位符

1
2
app.name=MyApp
app.description=${app.name:默认名称} is a Spring Boot application

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

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

自定义属性：

1
server.port=${port:8080}

属性名匹配规则

1
2
3
4
5
6
7
@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings {

    private String firstName;

}

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

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

类型

基本类型

List

my.servers

1
2
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

Map

my.map

1
2
3
my.map.[/key1]=value1
my.map.[/key2]=value2
my.map.[/key3]=value3

或者

1
2
3
4
5
my:
  map:
    "[/key1]": "value1"
    "[/key2]": "value2"
    "[/key3]": "value3"

验证

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

1
2
3
4
5
6
7
8
9
10
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {

    @NotNull
    private InetAddress remoteAddress;

    // ... getters and setters

}