9.0、springboot-配置文件properties、yaml-给属性赋值的几种方式

9.0、springboot-配置文件properties、yaml-给属性赋值的几种方式

首先我写了两个实体类文件如下：

Pet.java实体类文件

package com.hkl.pojo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class Pet {
    @Value("小红")
    private String name;
    @Value("3")
    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Pet{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

在pet.java实体类文件中，我们使用的是@Value注解的方式来给属性注入值

Person.java实体类文件

package com.hkl.pojo;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Component
@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 Pet pets;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getHappy() {
        return happy;
    }

    public void setHappy(Boolean happy) {
        this.happy = happy;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }
 public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Pet getPets() {
        return pets;
    }

    public void setPets(Pet pets) {
        this.pets = pets;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", happy=" + happy +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", pets=" + pets +
                '}';
    }
}

        在Person.java实体类文件中我们使用的是@ConfigurationProperties设置yaml文件的前缀

        然后自动一一配对设置值。配置ConfigurationProperties注解时可能会爆红，但是其实不解决也能正常使用，加入以下依赖即可解决。

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

application.yaml文件如下

person:
  name: hkl
  age: 21
  happy: true
  birth: ${random.int}
  maps: {k1: v1,k2: v2}
  lists:
    -code
    -music
    -girl
  pets:
    name: ${person.hello:world}//这里是获取person的hello属性值,如果没有hello这个属性就默认后面我们自己设置的值--world
    age: 3

        @ConfigurationProperties作用:将配置文件中配置的每一个属性的值，映射到这个组件中

告诉Springboot将本类中的所有属性和配置文件中相关的配置进行绑定

        参数prefix = “person”将配置文件中的person下面的所有属性一一对应

        只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能

所以说这个组件不一定必须是pojo类也可以是其他的类比如说配置类里的配置信息

        properties格式的配置文件相比较yaml格式来说就较为复杂了，所以springboot官方推荐我们还是使用yaml格式文件，但是还是总结一下properties的用法如下

首先创建一个hkl.properties文件如下：

name="hkl"
age="3"
happy="true"

Person.java实体类文件：

package com.hkl.pojo;
        import org.springframework.beans.factory.annotation.Value;
        import org.springframework.context.annotation.PropertySource;
        import org.springframework.stereotype.Component;
@Component
@PropertySource("classpath:hkl.properties")
public class Person {
    @Value("${name}")
    private String name;
@Value("${age}")
    private Integer age;
@Value("${happy}")
    private Boolean happy;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getHappy() {
        return happy;
    }
    public void setHappy(Boolean happy) {
        this.happy = happy;
    }
    @Override
    public String toString() {
        return "Person{" +"name='" + name + '\'' +", age=" + age +
                ", happy=" + happy +'}';
    }
}

在properties文件里写好数据

        先用@PropertySource("classpath:hkl.properties")注解将hkl.properties文件定位

然后在pojo类中用@Value("${name}")注解这种方式手动来给每个属性赋值

乱码问题解决：但是使用properties文件格式可能或出现乱码，按以下方式即可解决

 

再补充一个知识，yaml格式的松散绑定：

例如我们在yaml中定义的属性名为 student-name

但是在实体类中定义的是studentName

那么使用@ConfigurationProperties注解也能顺利取到值

结论：

        ·cp只需要写一次即可，value需要每个字段都添加

        ·松散绑定：比如我们的yaml中写的student-name，这个和studentName是一样的，-后面跟着的字母默认是大写的。这就是松散绑定

        ·配置yaml和配置properties都可以获取到值，但是强烈推荐yaml

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

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