SpringBoot 学习笔记：配置文件属性注入

落日映苍穹つ 2023-02-17 02:48 21阅读 0赞

### SpringBoot 配置学习笔记：配置文件属性注入 ###

*  一、注解：@ConfigurationProperties(prefix = "hero")
 *   *  依赖 pom.xml
     *  配置文件 application.yml
     *  Java 中取属性值
     *  返回结果
 *  二、注解：@Value("$\{hero.name\}")
 *   *  占位符（默认值）
 *  三、注入>静态属性
 *   *  方案1 \`@Value + @PostConstruct\`
     *  方案2 \`@Value + Set方法\`
     *  方案3 \`@ConfigurationProperties\`
 *  参考资料
 *   *  Blog
     *  官方文档
     *  湖边的小屋

从配置文件取值的几种方式。逐个演示。

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>功能</th> 
   <th>松散语法绑定</th> 
   <th>子对象</th> 
   <th>JSR303校验</th> 
   <th>SpEL</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@ConfigurationProperties</td> 
   <td>批量注入属性到<code>JavaBean</code></td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>@Value</td> 
   <td>单个注入属性</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td>支持</td> 
  </tr> 
 </tbody> 
</table>

# 一、注解：@ConfigurationProperties(prefix = “hero”) #

此注解作用是标注从`配置文件`中哪个`位置`取数据，注入到`当前类`的`属性`。  
要让注入生效有如下方案：  
1. 配合 `@Configuration` 将当前类注册为bean。  
2. 在单独的配置类中，用`@EnableConfigurationProperties({Hero.class, ...})`点名要注入的类。(启动类也是配置类)  
3. 用 `@ConfigurationPropertiesScan("com.jerry.config")` 扫描配置类所在包。

## 依赖 pom.xml ##

这种方式本质是通过 `setter` 向类中写入值，所以为了方便我加了`lombok`依赖。

<dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>

添加以下依赖，在编写配置文件时会有自动补全效果。否则当你添加`@ConfigurationProperties`注解后，idea会在类上提示`Spring Boot Cnfiguration Anotation Processor not configured`。字面意思，就是告诉你下面这个依赖没添加。

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

## 配置文件 application.yml ##

hero:
      name: 张三
      age: 18
      friend:
        - name: 李四
          age: 19
          friend: []
        - {  name: 王五, age: 20, friend: null}
        - {  name: 赵六, age: 21}
      weapon:
        id: 110
        type: weapon
        price: 99

## Java 中取属性值 ##

*  注意我添加了`lombok`的`@Data`注解，自动生成`setter`，不加的话，手写上`setter`也一样。
 *  属性`直接赋值`优先级 < `注入`。（比如：运行main方法`name`=`无名`，运行项目后`name`=`张三`）

package com.jerry.service;
    
    import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    @ConfigurationProperties(prefix = "hero")
    @Component
    @Data
    public class Hero{ 
        private String name = "无名";
        private int age;
        private Hero[] friend;
        private Equipment weapon;
    
        public Hero info(){ 
            return this;
        }
    }

`hero.java` 中的引用类型 `Equipment.java`

package com.jerry.service;
    
    import lombok.Data;
    
    @Data
    public class Equipment { 
        private String type;
        private long id;
        private Double price;
    }

加个控制器用来测试效果

@RestController
    public class MyController { 
        @Resource
        private Hero hero;
        @GetMapping
        public Hero myHero(){  return hero.info(); }
    }

## 返回结果 ##

{ 
        "name": "张三",
        "age": 18,
        "friend": [
            { 
                "name": "李四",
                "age": 19,
                "friend": [],
                "weapon": null
            },
            { 
                "name": "王五",
                "age": 20,
                "friend": [],
                "weapon": null
            },
            { 
                "name": "赵六",
                "age": 21,
                "friend": null,
                "weapon": null
            }
        ],
        "weapon": { 
            "type": "weapon",
            "id": 110,
            "price": 99.0
        }
    }

# 二、注解：@Value("$\{hero.name\}") #

@Value("${hero.name}")
    private String name;

## 占位符（默认值） ##

如果 `hero.name` 没有值则用`好汉`

${ hero.name:好汉}

注意：这样是空字符串。要完全不存在才算没有值。

hero:
      name:

# 三、注入>静态属性 #

创建一个对象，添加静态属性，完成静态注入供其它类调用。  
如果注入对象`@Value`换成`@Autowired`即可，逻辑相同。  
在服务器加载Servlet时`@PostConstruct`修饰的方法会在`构造函数`之后,`init`方法之前运行一次。通常用来做初始化

## 方案1 `@Value + @PostConstruct` ##

package com.jerry.demo;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    import javax.annotation.PostConstruct;
    
    public class Hero{ 
        @Value("${hero.name}")
        public String  name;
    
        /** 静态属性 */
        public static String HERO_NAME;
    
        @PostConstruct
        public void init() { 
            HERO_NAME = name;
        }
    }

## 方案2 `@Value + Set方法` ##

package com.jerry.dome;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    import javax.annotation.PostConstruct;
    
    @Component
    public class Hero{ 
        /** 静态属性 */
        public static String HERO_NAME;
    
        @Value("${hero.name}")
        public void setName(String name){ 
            HERO_NAME = name;
        }    
    }

## 方案3 `@ConfigurationProperties` ##

package com.jerry.dome;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    @ConfigurationProperties(prefix = "hero", ignoreInvalidFields = true)
    public class Hero{ 
        /** 静态属性 */
        public static String HERO_NAME;
    
        public void setName(String name){ 
            HERO_NAME = name;
        }   
    }

# 参考资料 #

## Blog ##

[阮一峰的网络日志 - YAML 语言教程][- YAML]  
[Springboot命令行配置–spring.config.location配置文件的优先级][Springboot_spring.config.location]

## 官方文档 ##

`注意查看与自己相符的版本`

*  Spring Boot Features  
    [Spring官网：2.7. Type-safe Configuration Properties][Spring_2.7. Type-safe Configuration Properties]  
    [Spring官网：2.7.10. @ConfigurationProperties vs. @Value][Spring_2.7.10. _ConfigurationProperties vs. _Value]
 *  Configuration Metadata  
    [Spring官网： 3.1. Configuring the Annotation Processor][Spring_ 3.1. Configuring the Annotation Processor]

## 湖边的小屋 ##

[SpringBoot 学习笔记：配置文件基础知识][SpringBoot]  
[SpringBoot 学习笔记：YAML基本语法][SpringBoot _YAML]  
SpringBoot 学习笔记：配置文件属性注入

[- YAML]: http://www.ruanyifeng.com/blog/2016/07/yaml.html
[Springboot_spring.config.location]: https://blog.csdn.net/z_ssyy/article/details/105347680
[Spring_2.7. Type-safe Configuration Properties]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-typesafe-configuration-properties
[Spring_2.7.10. _ConfigurationProperties vs. _Value]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-vs-value
[Spring_ 3.1. Configuring the Annotation Processor]: https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-configuration-metadata.html#configuration-metadata-annotation-processor
[SpringBoot]: https://jerryjin.blog.csdn.net/article/details/101567819
[SpringBoot _YAML]: https://jerryjin.blog.csdn.net/article/details/111823694