java读入yml文件

转载

mob64ca14079fb3 2024-09-28 21:45:42

文章标签 java读入yml文件 spring boot spring java 配置文件 文章分类 Java 后端开发

yaml语法学习

配置文件

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

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

配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！

# springboot这个配置文件中到底可以配置哪些东西呢？
# 官方的配置太多了
# 了解原理：一通百通

server:
  port: 1314

概述

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

基础语法

说明：语法要求严格！

1、空格不能省略

2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

字面量：普通的值 [ 数字，布尔值，字符串 ]

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

k: v

注意：

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

对象、Map（键值对）

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

在下一行来写对象的属性和值得关系，注意缩进；比如：

student:
    name: qingfeng
    age: 18

# 传统写法
# name=qingfeng
# student.name=qingfeng
# student.age=18

行内写法

student: {name: qingfeng,age: 3}

空格不能省略!!!

数组（ List、set ）

用 - 值表示数组中的一个元素,比如：

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

修改SpringBoot的默认端口号

配置文件中添加，端口号的参数，就可以切换端口；

server:
  port: 1315

java读入yml文件_spring

注入配置文件

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

1、在新建一个springboot项目springboot-02-config

java读入yml文件_java_02

java读入yml文件_java读入yml文件_03

2、新建一个文件 application.yml

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

server:
  port: 1314

3、编写两个实体类 Dog、Person 类；

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
public class Dog {
    private String name;
    private Integer age;
}

Person

@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class Person {

    @Value("旺财")
    private String name;
    @Value("3")
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

4、思考

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

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

5、在测试类下注入狗狗输出一下；

@SpringBootTest
class TestConfigApplicationTests {

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

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

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

java读入yml文件_spring_04

6、使用yaml配置的方式进行注入

注意区别和优势，我们编写一个yaml配置！

person:
  name: qingfeng
  age: 18
  happy: false
  birth: 2020/02/24
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
    name: 旺财
    age: 3

7、注入到类中

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

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

@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
@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配置注解处理器没有找到，就会提示报红，但是不影响使用，让我们看文档，我们可以查看文档，找到一个依赖！

java读入yml文件_spring boot_05

java读入yml文件_java读入yml文件_06

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

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

@SpringBootTest
class TestConfigApplicationTests {

    @Autowired
    private Person person;

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

java读入yml文件_java读入yml文件_07

Person( name=qingfeng,
age=18,
happy=false,
birth=Mon Feb 2400:00:00 CST 2020,
maps={k1=v1, k2=v2},
lists=[code, girl, music],
dog=Dog(name=旺财, age=3) )
yaml配置注入到实体类完全OK！

测试：

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

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

加载指定的配置文件

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

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

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

name=qingfeng

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

javaConfig绑定我们配置文件的值，可以采取这些方式！
//加载指定的配置文件
@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
    //SPEL表达式取出配置文件的值
    @Value("${name}")
    private String name;

    ......  
}

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

配置文件占位符

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

person:
  name: qingfeng${random.uuid} # 随机uuid
  age:  ${random.int}  # 随机int
  happy: false
  birth: 2020/02/24
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
    name: ${person.hello:other}_旺财
    age: 3

java读入yml文件_java读入yml文件_08

回顾properties配置：

我们上面采用的方法都是最简单的方式，开发中最常用的;

那我们来唠唠其他的实现方式，道理都是相同得；写还是那样写

【注意】配置文件除了yml还有我们之前常用的properties，properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8;

settings–>Editor–>File Encodings中配置;

java读入yml文件_配置文件_09

测试步骤：

1、新建一个实体类User

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

2、编辑配置文件 user.properties

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

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

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

结果正常输出：

java读入yml文件_spring boot_10

对比小结

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

java读入yml文件_java读入yml文件_11

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

2、松散绑定：这个什么意思呢?
比如我的yml中写的first-name，这个和firstName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。
可以测试一下:
yml:

dog:
  first-name: 旺财 # 松散绑定
  age: 3

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@ConfigurationProperties(prefix = "dog")
public class Dog {
    private String firstName; //松散绑定
    private Integer age;
}

测试：

@SpringBootTest
class TestConfigApplicationTests {

    @Autowired
    private Dog dog;

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

java读入yml文件_java_12