SpringBoot快速入门（六）-注入配置文件

注入配置文件

yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！

Yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yml

2、编写一个实体类 Dog；

@Component  //注册bean到容器中
@Data  //使用Lombok插件偷懒，自动生成构造方法，及get、set、toString()方法
public class Dog {
    private String name;
    private Integer age;
}

3、思考，我们原来是如何给bean注入属性值的！ @Value，给狗狗类测试一下： 

@Component  //注册bean到容器中
@Data  //使用Lombok插件偷懒，自动生成构造方法，及get、set、toString()方法
public class Dog {
    @Value("狗哥")
    private String name;
    @Value("18")
    private Integer age;
}

4、在SpringBoot的测试类下注入狗狗输出一下； 

@SpringBootTest
class HelloWorldApplicationTests {
    @Autowired //将狗狗类自动注入进来
    private Dog dog;
    @Test
    void contextLoads() {
        System.out.println(dog); //打印看下狗狗对象
    }
}

结果成功输出，@Value注入成功，这是我们原来的办法对吧。 

5、我们在编写一个复杂一点的实体类：Person 类 

@Component
@Data
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}

6、我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置 

person:
  name: itheibai
  age: 18
  happy: true
  birth: 2003/01/01
  maps: {k1: v1,k2: v2}
  lists: [code,girl,music]
  dog:
    name: 狗哥
    age: 18

7、我们刚才已经把person这个对象的所有值都写好了，我们现在来注入到我们的类中！ 

/**
 * @ConfigurationProperties作用:
 * 将配置文件中的每一个属性的值，映射到这个组件中；
 * 告诉SpringBoot将本类中的所有属性和配置文件中的相关的配置进行绑定
 * 参数 prefix = "person" ：将配置文件中的person下面的所有属性一一对应
 */
@Component
@Data
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}

8、IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依

赖！

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 --> 
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

9、确认以上配置都OK之后，我们去测试类中测试一下： 

@SpringBootTest
class HelloWorldApplicationTests {
    @Autowired //将person类自动注入进来
    private Person person;
    @Test
    void contextLoads() {
        System.out.println(person); //打印看下person对象
    }
}

结果：所有值全部注入成功！

yaml配置注入到实体类完全OK！

测试：

1、将配置文件的key 值 和 属性的值设置为不一样，则结果输出为null，注入失败

2、在配置一个person2，然后将 @ConfifigurationProperties(prefifix = “person2”) 指向我们的

person2； 

加载指定配置文件

@PropertySource ：加载指定的配置文件；

@confifigurationProperties：默认从全局配置文件中获取值；

1、我们去在resources目录下新建一个person.properties文件 

name=itheibai

2、然后在我们的代码中指定加载person.properties文件 

@Component
@Data
@PropertySource(value = "classpath:person.properties")
public class Person {
    @Value("${name}") 
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;
}

3、再次输出测试一下：指定配置文件绑定成功！

配置文件占位符 

person:
  name: itheibai${random.uuid} #随机uuid
  age: ${random.int} #随机int
  happy: true
  birth: 2003/01/01
  maps: {k1: v1,k2: v2}
  lists: [code,girl,music]
  dog:
    name: ${person.hello:没有hello属性，则显示冒号后面的默认值}_狗哥
    age: 18

在输出一下

回顾properties配置

我们上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！那我们来唠

唠其他的实现方式，道理都是相同得；写还是那样写；配置文件除了yml还有我们之前常用的properties

， 我们没有讲，我们来唠唠！

【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；

settings–>FileEncodings 中配置； 

测试步骤：

1、新建一个实体类User 

@Component
@Data
public class User {
    private String name;
    private Integer age;
    private String sex;
}

2、编辑配置文件 user.properties

user.name=itheibai
user.age=18
user.sex=男

3、我们在User类上使用@Value来进行注入！ 

@Component
@Data
@PropertySource(value = "classpath:user.properties")
public class User {
    //直接使用@Value
    @Value("${user1.name}") //从配置文件中取值（如${user.name},则输出计算机用户名）
    private String name;
    @Value("#{9*3}") //#{SPEL} spring表达式
    private Integer age;
    @Value("男") //字面量
    private String sex;
}

4、Springboot测试 

@SpringBootTest
class HelloWorldApplicationTests {
    @Autowired //将user类自动注入进来
    private User user;
    @Test
    void contextLoads() {
        System.out.println(user); //打印看下user对象
    }
}

结果正常输出： 

对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图

1、@ConfifigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加

2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， – 后面跟

着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持

结论：

配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@confifigurationProperties，不要犹豫！