Spring Boot基础之优雅的属性配置

1. 技术目标

• 目标01：传统的属性配置：@value注解
• 目标02：认识Spring Boot中优雅的属性配置
• 目标03：第一个Spring Boot中优雅的属性配置
• 目标04：@ConfigurationProperties注解

2. 技术介绍

在开发的过程中，我们为了隔离环境的差异，通常需要使用一些配置文件，Spring 提供了一些组件，使得使用配置文件的工作变得更加方便。@ConfigurationProperties 和 @Value都是 Spring 提供的用于从配置文件注入配置信息的方式。很显然，@Value 比较适用于配置比较少的场景，而 @ConfigurationProperties 则更适用于有很多配置的情况。本篇文章引导你通过Spring Boot优雅的属性配置来配置项目中的配置属性，可以更加灵活的配置项目中的配置项，话不多说直接上干货！

3. 环境配置

3.1 开发配置

• JDK
• Maven
• Eclipse&STS&IDEA

此案例使用IDEA作为开发工具！

3.2 技术栈

• Spring Boot

4. 技术实践

4.1 项目搭建

此处不详细讲解如果对Spring Boot项目创建有问题的，可以参考第一章：用一个HelloWord来阐述SpringBoot的简单与快速。

4.2 添加项目依赖

<!-- 支持 @ConfigurationProperties 注解 -->  
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-configuration-processor</artifactId>  
    <optional>true</optional>  
</dependency> 

4.3 传统的属性配置

@Value 比较适用于配置比较少的场景，但是对于属性很多的配置不太适合！

4.3.1 配置属性文件

# 传统方式的属性配置
guod.info.value.port=1111
guod.info.value.name=value
guod.info.value.age=22

4.3.2 注入属性值

@Value("${guod.info.port}")
private String port;
@Value("${guod.info.name}")
private String name;
@Value("${guod.info.age}")
private String age;

4.3.3 业务使用

@GetMapping(value = "/value")
public String value() {
    return port + name + age;
}

4.4 Boot中的属性配置

4.4.1 创建属性配置文件

myProps: #自定义的属性和值  
  simpleProp: simplePropValue  
  arrayProps: 1,2,3,4,5  
  listProp1:  
    - name: abc  
      value: abcValue  
    - name: efg  
      value: efgValue  
  listProp2:  
    - config2Value1  
    - config2Vavlue2  
  mapProps:  
    key1: value1  
    key2: value2  

4.4.2 Bean接收配置信息

@Component  
@ConfigurationProperties(prefix="myProps") //接收application.yml中的myProps下面的属性  
public class MyProps {  
    private String simpleProp;  
    private String[] arrayProps;  
    private List<Map<String, String>> listProp1 = new ArrayList<>(); //接收prop1里面的属性值  
    private List<String> listProp2 = new ArrayList<>(); //接收prop2里面的属性值  
    private Map<String, String> mapProps = new HashMap<>(); //接收prop1里面的属性值  
      
    public String getSimpleProp() {  
        return simpleProp;  
    }  
      
    //String类型的一定需要setter来接收属性值；maps, collections, 和 arrays 不需要  
    public void setSimpleProp(String simpleProp) {  
        this.simpleProp = simpleProp;  
    }  
      
    public List<Map<String, String>> getListProp1() {  
        return listProp1;  
    }  
    public List<String> getListProp2() {  
        return listProp2;  
    }  
  
    public String[] getArrayProps() {  
        return arrayProps;  
    }  
  
    public void setArrayProps(String[] arrayProps) {  
        this.arrayProps = arrayProps;  
    }  
  
    public Map<String, String> getMapProps() {  
        return mapProps;  
    }  
  
    public void setMapProps(Map<String, String> mapProps) {  
        this.mapProps = mapProps;  
    }  
}  

4.4.3 业务使用

@Autowired  
private MyProps myProps; 
@GetMapping(value = "/index")
public String index() {
    return userProperties.getName() + userProperties.getAge();
}

5. 技术总结

5.1 注意部分

@Configuration：标记这是一个的配置类。
@ConfigurationProperties：这个注解 可以标记在类上面 , 也可以标记在方法上面，被这个注解修饰的类或方法 会被**ConfigurationPropertiesBeanRegistrar **这个类解析 , 并生成代理对象 。在使用这个标签的时候 , 我们可以通过 prefix 这个属性 , 来对文件中前缀相同的配置进行映射。这里需要注意的是 , 如果我们的key需要驼峰命名的话 , 需要通过 "-" 来进行标记 。

6. 源码地址

本章以及后续章节的源码地址我都会分享出来，请大家自行下载以及git clone。
SpringBoot相关系列文章请访问：目录：SpringBoot学习目录
SpringBoot配套源码地址：https://gitee.com/guod369/Guod-Boot
开源分享，共同进步！