多配置yml configurationproperties注解获取不到 yml配置文件注释

文章目录

• 一、配置文件
• 二、application.yaml配置文件

• 1.了解YAML
• 2.YAML直接给实体类赋值
• 3.YAML支持EL表达式
• 4.application配置文件可以放的位置
• 5.多环境配置

---

一、配置文件

1. 配置文件的作用:修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了
2. SpringBoot使用一个全局的配置文件，配置文件名称是固定的（二者选其一）

• 1）application.properties：语法结构key=value（默认）

server.port=8081

• 2）application.yaml：语法结构key：空格value

server:
  port: 8081

二、application.yaml配置文件

1.了解YAML

• YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）。
• YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。
• YAML 支持以下几种数据类型：
• 对象：

key: 
    child-key: value
    child-key2: value2

• 数组：

pet:
  - cat
  - dog
  - pig

pet: [cat,dog,pig]

等等。

2.YAML直接给实体类赋值

不用yaml的话，我们也可以用注解赋值：参考文章：Spring注解开发

yaml赋值：
步骤一：导入依赖

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

步骤二：编写实体类
Dog.java

@Component
public class Dog {
    private String name;
    private Integer age;

    public Dog() {
    }

    public Dog(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    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;
    }

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

Person.java

@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 Dog dog;

    public Person() {
    }

    public Person(String name, Integer age, Boolean happy, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
        this.name = name;
        this.age = age;
        this.happy = happy;
        this.birth = birth;
        this.maps = maps;
        this.lists = lists;
        this.dog = dog;
    }

    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 Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

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

@ConfigurationProperties作用:

• 将配置文件中配置的每一个属性的值，映射到这个组件中;
• 告诉springBoot将本类中的所有属性和配置文件中相关的配置进行绑定
• 参数 prefix = "person”:将配置文件中的person下面的所有属性——对应
• 只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能

步骤三：yaml配置文件实体类赋值（application.yaml）

person:
  name: 高朗
  age: 15
  happy: false
  birth: 2018/09/08
  maps: {k1: v1,k2: v2}
  lists:
    - l1
    - l2
    - l3
  dog:
    name: 小黄
    age: 3

yaml与实体类对应图：

步骤四：测试（springboot自带的测试类）

@SpringBootTest
class SpringbootApplicationTests {

    @Autowired
    private Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }

}

运行结果：

Person{name='高朗', age=15, happy=false, birth=Sat Sep 08 00:00:00 CST 2018, 
maps={k1=v1, k2=v2}, lists=[l1, l2, l3], dog=Dog{name='小黄', age=3}}

3.YAML支持EL表达式

例如封装一个User类对象：

user:
  #random.uuid:随机生成一个uuid
  id: ${random.uuid}
  #random.int：随机生成一个int
  age: ${random.int}
  #占位符：  判断user.hello是否为null，是 输出后面的，不是,输出user.hello
  # 这里是null，输出hello_01
  name: ${user.hello:hello}_01

4.application配置文件可以放的位置

官网：

1. 可以放在项目名下新建的config文件目录下
2. 项目名下新建的config文件目录下的子目录下
3. 项目名下
4. resource目录的config目录下
5. resource目录下

优先级依次递减

5.多环境配置

看图

这里properties和yaml类似，不同的是yaml还可以在同一个文件中分模块（三杆分开），不需要多个文件。

spring:
  profiles:
    active: test


---
server:
  port: 8081
spring:
  profiles: dev

---
server:
  port: 8082
spring:
  profiles: test