关于java:SpringBoot03yaml配置注入

22次阅读

共计 4896 个字符,预计需要花费 13 分钟才能阅读完成。

1、配置文件

SpringBoot 应用一个全局的配置文件,配置文件名称是固定的

  • application.properties
    语法结构:
    key=value
  • application.yml
    语法结构:
    key:空格 value

配置文件的作用:
批改 SpringBoot 主动配置的默认值,因为 SpringBoot 在底层都给咱们主动配置好了;
比方咱们能够在配置文件中批改 Tomcat 默认启动的端口号!

application.properties

server.port=8081

student.name=RYGAR
student.age=18

application.yml

server:
 prot: 8081

#对象
student:
 name: RYGAR
 age: 18
#行内写法
student: {name: RYGAR,age: 18}

#数组
pets:
 - cat
 - dog
 - pig
pets: [cat,dog,pig]

2、yaml 概述

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

== 这种语言以数据作为核心,而不是以标记语言为重点!==
以前的配置文件,大多数都是应用 xml 来配置;比方一个简略的端口配置,咱们来比照下 yaml 和 xml

传统 xml 配置:

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

yaml 配置:


server:prot: 8080

3、yaml 根底语法

阐明:语法要求严格!
1、空格不能省略
2、以缩进来管制层级关系,只有是右边对齐的一列数据都是同一个层级的。
3、属性和值的大小写都是非常敏感的。

字面量:一般的值 [数字,布尔值,字符串]
字面量间接写在前面就能够,字符串默认不必加上双引号或者单引号;

k: v

留神:

  • “”双引号,不会本义字符串外面的特殊字符,特殊字符会作为自身想示意的意思;

      比方:name: "Hello \n World"   输入:Hello  换行   World
  • ” 单引号,会本义特殊字符,特殊字符最终会变成和一般字符一样输入

      比方:name:‘Hello \n World’输入:Hello  \n   World
    

对象、Map(键值对)


#对象、Map 格局
k: 
    v1:
    v2:

在下一行来写对象的属性和值得关系,留神缩进;比方:

student:
    name: RYGAR
    age: 18

行内写法

student: {name: RYGAR,age: 18}

数组(List、set)
用 – 值示意数组中的一个元素, 比方:

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

批改 SpringBoot 的默认端口号

配置文件中增加,端口号的参数,就能够切换端口;

server:
  port: 8082

3.1、注入配置文件

yaml 文件更弱小的中央在于,他能够给咱们的实体类间接注入匹配值!

3.2、yaml 注入配置文件

1、在 springboot 我的项目中的 resources 目录下新建一个文件 application.yml
2、编写一个实体类 Dog;

package com.kuang.springboot.pojo;

@Component  // 注册 bean 到容器中
@Data//lombok
public class Dog {
    private String name;
    private Integer age;
    
    // 有参无参结构、get、set 办法、toString()办法}

3、思考,咱们原来是如何给 bean 注入属性值的!@Value,给狗狗类测试一下:

@Component // 注册 bean
public class Dog {@Value("阿黄")
    private String name;
    @Value("18")
    private Integer age;
}

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

@SpringBootTest
class DemoApplicationTests {

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

    @Test
    public void contextLoads() {System.out.println(dog); // 打印看下狗狗对象
    }

}

后果胜利输入,@Value 注入胜利,这是咱们原来的方法对吧。

5、咱们在编写一个简单一点的实体类:Person 类

@Component // 注册 bean 到容器中
@Data    //lombok
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;
    
    // 有参无参结构、get、set 办法、toString()办法}

6、咱们来应用 yaml 配置的形式进行注入,大家写的时候留神区别和劣势,咱们编写一个 yaml 配置!

person:
  name: RYGAR
  age: 18
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 旺财
    age: 1

7、咱们方才曾经把 person 这个对象的所有值都写好了,咱们当初来注入到咱们的类中!

/*
@ConfigurationProperties 作用:将配置文件中配置的每一个属性的值,映射到这个组件中;通知 SpringBoot 将本类中的所有属性和配置文件中相干的配置进行绑定
参数 prefix =“person”: 将配置文件中的 person 上面的所有属性一一对应
*/
@Component // 注册 bean
@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 DemoApplicationTests {

    @Autowired
    Person person; // 将 person 主动注入进来

    @Test
    public void contextLoads() {System.out.println(person); // 打印 person 信息
    }

}

yaml 配置注入到实体类齐全 OK!

测试:

1、将配置文件的 key 值 和 属性的值设置为不一样,则后果输入为 null,注入失败
2、在配置一个 person2,而后将 @ConfigurationProperties(prefix = “person2”) 指向咱们的 person2;

3.2.1、加载指定的配置文件

@PropertySource:加载指定的配置文件;properties

@configurationProperties:默认从全局配置文件中获取值;yml

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

name=RYGAR

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

@PropertySource(value = "classpath:person.properties")
@Component // 注册 bean
public class Person {@Value("${name}")
    private String name;

    ......  
}

3.1.3、配置文件占位符

配置文件还能够编写占位符生成随机数

person:
    name: RYGAR${random.uuid} # 随机 uuid
    age: ${random.int}  # 随机 int
    happy: false
    birth: 2000/01/01
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - girl
      - music
    dog:
      name: ${person.hello:other}_旺财
      age: 1

3.3、回顾 properties 配置

    咱们下面采纳的 yaml 办法都是最简略的形式,开发中最罕用的;也是 springboot 所举荐的!那咱们来唠唠其余的实现形式,情理都是雷同的;写还是那样写;配置文件除了 yml 还有咱们之前罕用的 properties 

【留神】properties 配置文件在写中文的时候,会有乱码,咱们须要去 IDEA 中设置编码格局为 UTF-8;

settings–>FileEncodings 中配置

测试步骤:
1、新建一个实体类 User

@Component // 注册 bean
@Data
public class User {
    private String name;
    private int age;
    private String sex;
}

2、编辑配置文件 user.properties

user1.name=RYGAR
user1.age=18
user1.sex= 男

3、咱们在 User 类上应用 @Value 来进行注入!

@Data
@Component // 注册 bean
@PropertySource(value = "classpath:user.properties")
public class User {
    // 间接应用 @value
    @Value("${user.name}") // 从配置文件中取值
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring 表达式
    private int age;
    @Value("男")  // 字面量
    private String sex;
}

4、Springboot 测试


@SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

    @Test
    public void contextLoads() {System.out.println(user);
    }

}

比照小结

@Value 这个应用起来并不敌对!咱们须要为每个属性独自注解赋值,比拟麻烦;咱们来看个性能比照图

文件类型 yml properties
注解 @configurationProperties @PropertySource
性能 批量注入配置文件中的属性 一个个指定
涣散绑定 反对 不反对
SpEL 不反对 反对
JSR303 数据校验 反对 不反对
简单类型封装 反对 不反对

1、@ConfigurationProperties 只须要写一次即可,@Value 则须要每个字段都增加
2、涣散绑定:这个什么意思呢? 比方我的 yml 中写的 last-name,这个和 lastName 是一样的,– 前面跟着的字母默认是大写的。这就是涣散绑定。能够测试一下
3、JSR303 数据校验,这个就是咱们能够在字段是减少一层过滤器验证,能够保证数据的合法性
4、简单类型封装,yml 中能够封装对象,应用 value 就不反对

论断:

配置 yml 和配置 properties 都能够获取到值,强烈推荐 yml;
如果咱们在某个业务中,只须要获取配置文件中的某个值,能够应用一下 @value;
如果说,咱们专门编写了一个 JavaBean 来和配置文件进行一一映射,就间接 @configurationProperties,不要犹豫!

正文完
 0