Spring Boot配置绑定

所谓“配置绑定”就是把配置文件中的值与 JavaBean 中对应的属性进行绑定。通常，我们会把一些配置信息（例如，数据库配置）放在配置文件中，然后通过 Java 代码去读取该配置文件，并且把配置文件中指定的配置封装到 JavaBean（实体类） 中。

SpringBoot 提供了以下 2 种方式进行配置绑定：

• 使用 @ConfigurationProperties 注解
• 使用 @Value 注解

@ConfigurationProperties

通过 Spring Boot 提供的 @ConfigurationProperties 注解，可以将全局配置文件中的配置数据绑定到 JavaBean 中。下面我们以 Spring Boot 项目 helloworld 为例，演示如何通过 @ConfigurationProperties 注解进行配置绑定。

1. 在 helloworld 的全局配置文件 appilcation.yml 中添加以下自定义属性。

1. person:
2. lastName: 张三
3. age: 18
4. boss: false
5. birth: 1990/12/12
6. maps: { k1: v1,k2: 12 }
7. lists:
8. ‐ lisi
9. ‐ zhaoliu
10. dog:
11. name: 迪迪
12. age: 5

2.  在 helloworld 项目的 net.biancheng.www.bean 中创建一个名为 Person 的实体类，并将配置文件中的属性映射到这个实体类上，代码如下。

1. package net.biancheng.www.bean;
3. import org.springframework.boot.context.properties.ConfigurationProperties;
4. import org.springframework.stereotype.Component;
6. import java.util.Date;
7. import java.util.List;
8. import java.util.Map;
10. /**
11. * 将配置文件中配置的每一个属性的值，映射到这个组件中
12. *
13. * @ConfigurationProperties：告诉 SpringBoot 将本类中的所有属性和配置文件中相关的配置进行绑定；
14. * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
15. *
16. * 只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能；
17. */
18. @Component
19. @ConfigurationProperties(prefix = "person")
20. public class Person {
21. private String lastName;
22. private Integer age;
23. private Boolean boss;
24. private Date birth;
25. private Map<String, Object> maps;
26. private List<Object> lists;
27. private Dog dog;
29. public Person() {
30. }
32. public String getLastName() {
33. return lastName;
34. }
36. public void setLastName(String lastName) {
37. this.lastName = lastName;
38. }
40. public Integer getAge() {
41. return age;
42. }
44. public void setAge(Integer age) {
45. this.age = age;
46. }
48. public Boolean getBoss() {
49. return boss;
50. }
52. public void setBoss(Boolean boss) {
53. this.boss = boss;
54. }
56. public Date getBirth() {
57. return birth;
58. }
60. public void setBirth(Date birth) {
61. this.birth = birth;
62. }
64. public Map<String, Object> getMaps() {
65. return maps;
66. }
68. public void setMaps(Map<String, Object> maps) {
69. this.maps = maps;
70. }
72. public List<Object> getLists() {
73. return lists;
74. }
76. public void setLists(List<Object> lists) {
77. this.lists = lists;
78. }
80. public Dog getDog() {
81. return dog;
82. }
84. public void setDog(Dog dog) {
85. this.dog = dog;
86. }
88. public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
89. this.lastName = lastName;
90. this.age = age;
91. this.boss = boss;
92. this.birth = birth;
93. this.maps = maps;
94. this.lists = lists;
95. this.dog = dog;
96. }
98. @Override
99. public String toString() {
100. return "Person{" +
101. "lastName='" + lastName + '\'' +
102. ", age=" + age +
103. ", boss=" + boss +
104. ", birth=" + birth +
105. ", maps=" + maps +
106. ", lists=" + lists +
107. ", dog=" + dog +
108. '}';
109. }
110. }

注意：

• 只有在容器中的组件，才会拥有 SpringBoot 提供的强大功能。如果我们想要使用 @ConfigurationProperties 注解进行配置绑定，那么首先就要保证该对 JavaBean 对象在 IoC 容器中，所以需要用到 @Component 注解来添加组件到容器中。
• JavaBean 上使用了注解 @ConfigurationProperties(prefix = "person") ，它表示将这个 JavaBean 中的所有属性与配置文件中以“person”为前缀的配置进行绑定。

2. 在 net.biancheng.www.bean 中，创建一个名为 Dog 的 JavaBean，代码如下。

1. package net.biancheng.www.bean;
3. public class Dog {
4. private String name;
5. private String age;
7. public Dog() {
8. }
10. public Dog(String name, String age) {
11. this.name = name;
12. this.age = age;
13. }
15. public void setName(String name) {
16. this.name = name;
17. }
19. public void setAge(String age) {
20. this.age = age;
21. }
23. public String getName() {
24. return name;
25. }
27. public String getAge() {
28. return age;
29. }
30. }

3. 修改 HelloController 的代码，在浏览器中展示配置文件中各个属性值，代码如下。

1. package net.biancheng.www.controller;
3. import net.biancheng.www.bean.Person;
4. import org.springframework.beans.factory.annotation.Autowired;
5. import org.springframework.stereotype.Controller;
6. import org.springframework.web.bind.annotation.RequestMapping;
7. import org.springframework.web.bind.annotation.ResponseBody;
9. @Controller
10. public class HelloController {
11. @Autowired
12. private Person person;
14. @ResponseBody
15. @RequestMapping("/hello")
16. public Person hello() {
17. return person;
18. }
19. }

4. 重启项目，使用浏览器访问 “http://localhost:8081/hello”，结果如下图。
 

图3：Spring Boot 读取自定义配置

@Value

当我们只需要读取配置文件中的某一个配置时，可以通过 @Value 注解获取。

1. 以 Spring Boot 项目 helloworld 为例，修改实体类 Person 中的代码，使用 @Value 注解进行配置绑定，代码如下。

1. package net.biancheng.www.bean;
3. import org.springframework.beans.factory.annotation.Value;
4. import org.springframework.boot.context.properties.ConfigurationProperties;
5. import org.springframework.stereotype.Component;
7. import java.util.Date;
8. import java.util.List;
9. import java.util.Map;
11. @Component
12. public class Person {
13. @Value("${person.lastName}")
14. private String lastName;
15. @Value("${person.age}")
16. private Integer age;
17. @Value("${person.boss}")
18. private Boolean boss;
19. @Value("${person.birth}")
20. private Date birth;
22. private Map<String, Object> maps;
23. private List<Object> lists;
24. private Dog dog;
26. public Person() {
28. }
30. public String getLastName() {
31. return lastName;
32. }
34. public void setLastName(String lastName) {
35. this.lastName = lastName;
36. }
38. public Integer getAge() {
39. return age;
40. }
42. public void setAge(Integer age) {
43. this.age = age;
44. }
46. public Boolean getBoss() {
47. return boss;
48. }
50. public void setBoss(Boolean boss) {
51. this.boss = boss;
52. }
54. public Date getBirth() {
55. return birth;
56. }
58. public void setBirth(Date birth) {
59. this.birth = birth;
60. }
62. public Map<String, Object> getMaps() {
63. return maps;
64. }
66. public void setMaps(Map<String, Object> maps) {
67. this.maps = maps;
68. }
70. public List<Object> getLists() {
71. return lists;
72. }
74. public void setLists(List<Object> lists) {
75. this.lists = lists;
76. }
78. public Dog getDog() {
79. return dog;
80. }
82. public void setDog(Dog dog) {
83. this.dog = dog;
84. }
86. public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
87. this.lastName = lastName;
88. this.age = age;
89. this.boss = boss;
90. this.birth = birth;
91. this.maps = maps;
92. this.lists = lists;
93. this.dog = dog;
94. }
96. @Override
97. public String toString() {
98. return "Person{" +
99. "lastName='" + lastName + '\'' +
100. ", age=" + age +
101. ", boss=" + boss +
102. ", birth=" + birth +
103. ", maps=" + maps +
104. ", lists=" + lists +
105. ", dog=" + dog +
106. '}';
107. }
108. }

2. 重启项目，使用浏览器访问 “http://localhost:8081/hello”，结果如下图。
 

图4：Spring Boot @Value 注解读取配置文件值

@Value 与 @ConfigurationProperties 对比

@Value 和 @ConfigurationProperties 注解都能读取配置文件中的属性值并绑定到 JavaBean 中，但两者存在以下不同。

1. 使用位置不同

• @ConfigurationProperties：标注在 JavaBean 的类名上；
• @Value：标注在 JavaBean 的属性上。

2. 功能不同

• @ConfigurationProperties：用于批量绑定配置文件中的配置；
• @Value：只能一个一个的指定需要绑定的配置。

3. 松散绑定支持不同

@ConfigurationProperties：支持松散绑定（松散语法），例如实体类 Person 中有一个属性为 lastName，那么配置文件中的属性名支持以下写法：

• person.firstName
• person.first-name
• person.first_name
• PERSON_FIRST_NAME

 
@Vaule：不支持松散绑定。

4. SpEL 支持不同

• @ConfigurationProperties：不支持 SpEL 表达式;
• @Value：支持 SpEL 表达式。

5. 复杂类型封装

• @ConfigurationProperties：支持所有类型数据的封装，例如 Map、List、Set、以及对象等；
• @Value：只支持基本数据类型的封装，例如字符串、布尔值、整数等类型。

6. 应用场景不同

@Value 和 @ConfigurationProperties 两个注解之间，并没有明显的优劣之分，它们只是适合的应用场景不同而已。

• 若只是获取配置文件中的某项值，则推荐使用 @Value 注解；
• 若专门编写了一个 JavaBean 来和配置文件进行映射，则建议使用 @ConfigurationProperties 注解。

我们在选用时，根据实际应用场景选择合适的注解能达到事半功倍的效果。

@PropertySource 

如果将所有的配置都集中到 application.properties 或 application.yml 中，那么这个配置文件会十分的臃肿且难以维护，因此我们通常会将与 Spring Boot 无关的配置（例如自定义配置）提取出来，写在一个单独的配置文件中，并在对应的 JavaBean 上使用 @PropertySource 注解指向该配置文件。

1. 以 helloworld 为例，将与 person 相关的自定义配置移动到 src/main/resources 下的 person.properties 中（注意，必须把 application.properties 或 application.yml 中的相关配置删除），如下图。
 

图5：person.properties 

person.properties 的配置如下。

1. person.last-name=李四
2. person.age=12
3. person.birth=2000/12/15
4. person.boss=false
5. person.maps.k1=v1
6. person.maps.k2=14
7. person.lists=a,b,c
8. person.dog.name=dog
9. person.dog.age=2

2. 在 Person 使用 @PropertySource 注解指向 person.properties，代码如下。

1. package net.biancheng.www.bean;
3. import org.springframework.beans.factory.annotation.Value;
4. import org.springframework.boot.context.properties.ConfigurationProperties;
5. import org.springframework.context.annotation.PropertySource;
6. import org.springframework.stereotype.Component;
8. import java.util.Date;
9. import java.util.List;
10. import java.util.Map;
12. @PropertySource(value = "classpath:person.properties")//指向对应的配置文件
13. @Component
14. @ConfigurationProperties(prefix = "person")
15. public class Person {
17. private String lastName;
19. private Integer age;
21. private Boolean boss;
23. private Date birth;
25. private Map<String, Object> maps;
27. private List<Object> lists;
29. private Dog dog;
31. public Person() {
33. }
35. public String getLastName() {
36. return lastName;
37. }
39. public void setLastName(String lastName) {
40. this.lastName = lastName;
41. }
43. public Integer getAge() {
44. return age;
45. }
47. public void setAge(Integer age) {
48. this.age = age;
49. }
51. public Boolean getBoss() {
52. return boss;
53. }
55. public void setBoss(Boolean boss) {
56. this.boss = boss;
57. }
59. public Date getBirth() {
60. return birth;
61. }
63. public void setBirth(Date birth) {
64. this.birth = birth;
65. }
67. public Map<String, Object> getMaps() {
68. return maps;
69. }
71. public void setMaps(Map<String, Object> maps) {
72. this.maps = maps;
73. }
75. public List<Object> getLists() {
76. return lists;
77. }
79. public void setLists(List<Object> lists) {
80. this.lists = lists;
81. }
83. public Dog getDog() {
84. return dog;
85. }
87. public void setDog(Dog dog) {
88. this.dog = dog;
89. }
91. public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
92. this.lastName = lastName;
93. this.age = age;
94. this.boss = boss;
95. this.birth = birth;
96. this.maps = maps;
97. this.lists = lists;
98. this.dog = dog;
99. }
101. @Override
102. public String toString() {
103. return "Person{" +
104. "lastName='" + lastName + '\'' +
105. ", age=" + age +
106. ", boss=" + boss +
107. ", birth=" + birth +
108. ", maps=" + maps +
109. ", lists=" + lists +
110. ", dog=" + dog +
111. '}';
112. }
113. }

3. 重启项目，使用浏览器访问 “http://localhost:8081/hello”，结果如下图。
 

图6：Spring Boot 将 person.properties 的属性注入