SpringBoot配置文件 - SpringBoot中读取配置文件的属性值 - 《Java 笔记》

1、通过@Value注解读取配置
2、通过 @ConfigurationProperties 注解读取配置属性
3、通过Environment Bean读取
- 3.1 定义配置内容
- 3.2 读取配置内容

SpringBoot

1、通过`@Value`注解读取配置

1.1 List类型的数据

定义参数

.yml 文件配置如下：

test:  
  list:  
    - aaa  
    - bbb  
    - ccc

.properties 文件配置如下：

test.list[0]=aaa  
test.list[1]=bbb  
test.list[2]=ccc

使用参数

使用 @Value 注解去读取这个值

@Value("${test.list}")  
private List<String> testList;

程序直接报错了，报错信息如下：

java.lang.IllegalArgumentException: Could not resolve placeholder 'test.list' in value "${test.list}"

需要通过一个有List类型的属性的配置类才可以注入

@Configuration  
@ConfigurationProperties("test")  
public class TestListConfig {  
    private List<String> list;  
    public List<String> getList() {  
        return list;  
    }  
    public void setList(List<String> list) {  
        this.list = list;  
    }  
}

在使用时候。采用自动注入的方式，去获取值：

@Autowired  
private TestListConfig testListConfig;  
// testListConfig.getList();

这种方式十分的不方便，最大的问题是配置和代码高耦合了，增加一个配置，还需要对配置类做增减改动。

1.2 数组类型的数据

test:  
  array1: aaa,bbb,ccc  
  array2: 111,222,333  
  array3: 11.1,22.2,33.3

使用方式如下

@Value("${test.array1}")  
private String[] testArray1;  
@Value("${test.array2}")  
private int[] testArray2;  
@Value("${test.array3}")  
private double[] testArray3;

这样就能够直接使用，如果对应的索引下没有具体的值会报错，可以使用 : 来设置默认值

@Value("${test.array1:}")  
private String[] testArray1;  
@Value("${test.array2:}")  
private int[] testArray2;  
@Value("${test.array3:}")  
private double[] testArray3;

仅仅多了一个 : 号，冒号后的值表示当 key 不存在时候使用的默认值，使用默认值时数组的 length = 0。
总结下使用数组实现的优缺点：
优点：

不需要写配置类
使用逗号分割，一行配置，即可完成多个数值的注入，配置文件更加精简

缺点：

业务代码中数组使用很少，基本需要将其转换为 List，去做 contains、foreach 等操作。
1.3 使用 EL 表达式将数组数据转换为List、Set、Map
解析 List
```
test:  
list: aaa,bbb,ccc
```
在调用时，借助 EL 表达式的 split() 函数进行切分即可。
```
@Value("#{'${test.list}'.split(',')}")  
private List<String> testList;
```
同样，为它加上默认值，避免不配置这个 key 时候程序报错：
```
@Value("#{'${test.list:}'.split(',')}")  
private List<String> testList;
```
:::danger 但是这样有个问题，当不配置该 key 值，默认值会为空串，它的 length = 1（不同于数组，length = 0），这样解析出来 list 的元素个数就不是空了。
这个问题比较严重，因为它会导致代码中的判空逻辑执行错误。这个问题也是可以解决的，在 split() 之前判断下是否为空即可。 :::
```
@Value("#{'${test.list:}'.empty ? null : '${test.list:}'.split(',')}")  
private List<String> testList;
```
解析 Set
解析 Set 和解析 List 本质上是相同的，唯一的区别是 Set 会做去重操作。
```
test:  
set: 111,222,333,111
```
```java @Value(“#{‘${test.set:}’.empty ? null : ‘${test.set:}’.split(‘,’)}”)
private Set testSet;

// output: [111, 222, 333]

<a name="F5uxt"></a>
#### 解析 Map
解析 Map 的写法如下所示，value 为该 map 的 JSON 格式，注意这里使用的引号：整个 JSON 串使用引号包裹，value 值使用引号包裹。
```yaml
test:  
  map1: '{"name": "zhangsan", "sex": "male"}'  
  map2: '{"math": "90", "english": "85"}'

在程序中，利用 EL 表达式注入：

@Value("#{${test.map1}}")  
private Map<String,String> map1;  
@Value("#{${test.map2}}")  
private Map<String,Integer> map2;

:::danger 注意，使用这种方式，必须得在配置文件中配置 key 及其 value。 ::: 如果真的很需要这个功能，就得自己写解析方法了，这里以使用 fastjson 进行解析为例：

(1) 自定义解析方法

public class MapDecoder {  
    public static Map<String, String> decodeMap(String value) {  
        try {  
            return JSONObject.parseObject(value, new TypeReference<Map<String, String>>(){});  
        } catch (Exception e) {  
            return null;  
        }  
    }  
}

(2) 在程序中指定解析方法

@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map1:}')}")  
private Map<String, String> map1;  
@Value("#{T(com.github.jitwxs.demo.MapDecoder).decodeMap('${test.map2:}')}")  
private Map<String, String> map2;

使用注意

@Value 注解不能和 @AllArgsConstructor 注解同时使用，否则会报错

Consider defining a bean of type 'java.lang.String' in your configuration

这种做法唯一不优雅的地方就是，这样写出来的 @Value 的内容都很长，既不美观，也不容易阅读。

2、通过 `@ConfigurationProperties` 注解读取配置属性

随着业务复杂度的增加，一个项目中可能会有越来越多的微服务，某个模块可能需要调用多个微服务获取不同的信息，那么就需要在配置文件中配置多个微服务的地址。可是，在需要调用这些微服务的代码中，如果一个个去使用 @Value 注解引入相应的微服务地址的话，太过于繁琐，也不科学。
所以，在实际项目中，业务繁琐，逻辑复杂的情况下，需要考虑封装一个或多个配置类。假如在当前服务中，某个业务需要同时调用订单微服务、用户微服务和购物车微服务，分别获取订单、用户和购物车相关信息，然后对这些信息做一定的逻辑处理。那么在配置文件中，需要将这些微服务的地址都配置好：

# 配置多个微服务的地址
url:
  # 订单微服务的地址
  orderUrl: http://localhost:8002
  # 用户微服务的地址
  userUrl: http://localhost:8003
  # 购物车微服务的地址
  shoppingUrl: http://localhost:8004

也许实际业务中，远远不止这三个微服务，甚至十几个都有可能。对于这种情况，可以先定义一个 MicroServiceUrl 类来专门保存微服务的 url，如下：

@Component
@ConfigurationProperties(prefix = "url")
public class MicroServiceUrl {
    private String orderUrl;
    private String userUrl;
    private String shoppingUrl;
    // 省去get和set方法
}

这里使用 @ConfigurationProperties 注解并且使用 prefix 来指定一个前缀，然后该类中的属性名就是配置中去掉前缀后的名字，一一对应即可。即：前缀名 + 属性名就是配置文件中定义的 key。同时，该类上面需要加上 @Component 注解，把该类作为组件放到Spring容器中，让 Spring 去管理，使用的时候直接注入即可。
需要注意的是，使用 @ConfigurationProperties 注解需要导入它的依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

直接通过 @Resource 注解将刚刚写好配置类注入进来即可使用了，非常方便。如下：

@RestController
@RequestMapping("/test")
public class TestController {
    private static final Logger LOGGER = LoggerFactory.getLogger(TestController.class);
    @Resource
    private MicroServiceUrl microServiceUrl;
    @RequestMapping("/config")
    public String testConfig() {
        LOGGER.info("=====获取的订单服务地址为：{}", microServiceUrl.getOrderUrl());
        LOGGER.info("=====获取的用户服务地址为：{}", microServiceUrl.getUserUrl());
        LOGGER.info("=====获取的购物车服务地址为：{}", microServiceUrl.getShoppingUrl());
        return "success";
    }
}

启动项目，可以看到，控制台打印出如下信息，说明配置文件生效，同时正确获取配置文件内容：

=====获取的订单服务地址为：http://localhost:8002
=====获取的订单服务地址为：http://localhost:8002
=====获取的用户服务地址为：http://localhost:8003
=====获取的购物车服务地址为：http://localhost:8004

3、通过Environment Bean读取

3.1 定义配置内容

test:
    msg: aaa

3.2 读取配置内容

@RestController
@RequestMapping("/test")
public class TestController {
    @Autowired
    private Environment env
    @RequestMapping(value = "index2", method = RequestMethod.GET)
    public String index2() {
        System.out.println(env.getProperty("test.msg"));
        return "The Way 2 : "+ env.getProperty("test.msg");
    }
}

SpringBoot中读取配置文件的属性值

1、通过@Value注解读取配置