SprinfBoot--yaml配置注入

最新推荐文章于 2024-02-28 23:02:13 发布

白了少年头yy

最新推荐文章于 2024-02-28 23:02:13 发布

阅读量216

点赞数

分类专栏： SpringBoot

本文链接：https://blog.csdn.net/weixin_45685359/article/details/107741043

版权

SpringBoot 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

1、yaml语法学习

springboot建议使用application.ymal作为配置文件名，不建议使用application.properties。但是两者都可以，并且有优先级关系。
在这里插入图片描述

1.1、配置文件

SpringBoot使用一个全局的配置文件，配置文件名称是固定的（application）

application.properties
- 语法结构：key=value
application.ymal
- 语法结构：key:空格 value

配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层已经给我们默认配置好了；
比如：我们在配置文件中修改Tomcat默认的启动端口号。

在application.properties命名的配置文件中：

# 更改端口号
server.port=8081

在application.ymal命名的配置文件中：

# 更改端口号
server:
  port: 8081

1.2、yaml概述

YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）

这种语言是以数据作为中心，而不是以标记语言为重点。

以前的配置文件，大多数都使用.xml来配置。比如：端口号配置：

传统xml配置

<server>
    <port>8081<port>
</server>

yaml配置

server:
  port: 8081

1.3、yaml语法

语法要求严格。
1、空格不能省略。
2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一层级的
3、属性和值的大小写都是十分敏感。

字面量：普通的值【数字，布尔值，字符串】

字面量直接写在后面就可以，字符串默认不用加上双引号或者单引号；

// 语法
k: v

注意：

双引号（""），不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思
- 比如：name: “lijin \n yang” 输出：lijin 换行 yang
单引号（‘’），会转义特殊字符，特殊字符最终会变成普通字符一样输出
- 比如：name: “lijin \n yang” 输出：lijin \n yang

对象、Map（键值对）

// 对象、map语法
k:
  v1:
  v2:

举例如下

student:
  name: lijinyang
  age: 18

行内写法

student: {name: lijinyang,age: 18}

数组（List、set）
用 - 表示数组中的一个元素。举例如下：

pets:
 - cat
 - pig
 - dog

行内写法

pets: [cat,pig,dog]

2、注入配置文件

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

2.1、yaml注入配置文件

1、创建application.ymal文件
2、创建一个实体类

@Data
@NoArgsConstructor
@AllArgsConstructor
public class dog {
    private String name;
    private int age;

}

3、给bean注入属性值。

以前的方法

@Component //注册bean

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Dog {
    @Value("花花")
    private String name;
    @Value("3")
    private int age;
}

4、在SpringBoot的测试类下注入狗的类，并输出

@SpringBootTest
class Springboot01HelloworldApplicationTests {

    @Autowired  //将狗类自动注入进来
    Dog dog;

    @Test
    void contextLoads() {

        System.out.println(dog);
    }
}

5、输出结果
在这里插入图片描述

6、我们再创建一个复杂的实体类：person

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private int age;
    private boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

7、使用yaml文件注入值

person:
  name: lijinyang
  age: 18
  happy: true
  birth: 2020/02/02
  maps:
    k1: v1
    k2: v2
  lists:
    - girl
    - sport
    - music
  dog:
    name: 黄黄
    age: 3

8、将ymal文件中写好的值注入到person类中

@Component  //注册bean
@ConfigurationProperties(prefix = "person")

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private int age;
    private boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

}

@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中
告诉springBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数prefix = “person” ：将配置文件中的person下面的所有属性与之一一对应

9、这时，idea会提示springBoot配置注解处理器没有找到，让我们看文档，并找到一个依赖，需要导入他。（有时候这个文档会打不开）

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

10、测试，输出

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

结果：
在这里插入图片描述

2.2、加载指定的配置文件

需要注意两个注解
@PropertySource：加载指定的配置文件
@ConfigurationProperties：默认从全局配置文件中获取值

练习：
1、我们在recources目录下新建一个文件：person.properties

name=Mr.li

2、在我们的实体类中指定加载person.properties文件

@Component
@PropertySource(value ="classpath:person.properties")

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    @Value("${name}")
    private String name;
    ...
    }

3、测试输出
在这里插入图片描述

2.3、配置文件占位符

配置文件可以编写占位符生成随机数

person:
    name: qinjiang${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int
    happy: false

2.4、聊聊properties配置

上面学习了yaml配置文件，可以看出是简单的，也是springboot推荐的。
properties配置文件在写中文的时候，会出现乱码，我们需要去idea中设置编码格式为utf-8
在这里插入图片描述

测试：
1、新建一个实体类user


@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String name;
    private int age;
    private String sex;
}

2、编写配置文件

user1.name=南瓜

3、在室体类上使用@value来注入值。

@Component
@PropertySource(value = "classpath:user.properties")



@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    @Value("${user1.name}")
    private String name;
    @Value("#{9*2}")
    private int age;
    @Value("女")
    private String sex;
}