SpringBoot中yaml格式、语法规则及数据读取方式(3种)

简介: SpringBoot中yaml格式、语法规则及数据读取方式(3种)

一、yaml格式

YAML(YAML Ain't Markup Language),一种数据序列化格式。这种格式的配置文件在近些年占主导地位,这些配置文件和前期的使用的优势对比:


最开始我们使用的xml,格式如下:

<enterprise>
    <name>xianming</name>
    <age>18</age>
    <tel>12345678</tel>
</enterprise>

而properties类的配置文件如下:

enterprise.name=xiaoming
enterprise.age=18
enterprise.tel=12345678

yaml类型的配置文件内容如下:

enterprise:
    name: xiaoming
    age: 16
    tel: 12345678

优点

● 容易阅读

       yaml类型的配置文件比xml类型的配置文件更容易阅读,结构更加清晰

● 容易与脚本语言交互

● 以数据为核心,重数据轻格式

       yaml更注重数据,而xml更注重格式


YAML文件扩展名

.yml(主流)
.yaml

上面两种后缀名都可以,以后使用更多的还是yml格式。

二、yaml格式语法规则

● 大小写敏感

● 属性层级关系使用多行描述,每行结尾使用冒号结束

● 使用缩进表示层级关系,同层级左侧对齐,只允许使用空格(不允许使用Tab键)

  空格的个数并不重要,只要保证同层级的左侧对齐即可

● 属性值前面添加空格(属性名与属性值之间使用冒号+空格作为分隔)

● #表示注释


核心规则:数据前面要加空格与冒号隔开


数组数据在数据书写的下方使用减号作为数据的开始符号,每一行数据,减号与数据间空格分隔,例如:

enterprise:
    name: xiaoming
    age: 18
    tel: 12345678
    subject:
      - JAVA
      - 前端
      - 大数据

三、yaml配置文件数据读取

环境准备

在controller包创建名为BookController控制器,内容如下:

@RestController 
@RequestMapping("/books") 
public class BookController { 
    @GetMapping("/{id}") 
    public String getById(@PathVariable Integer id){ 
        System.out.println("id ==> "+id); 
        return "hello , spring boot!"; 
    } 
}

在domin包下创建名为Enterprise的实体类用来封装数据,内容如下:

public class Enterprise { 
    private String name; 
    private int age; 
    private String tel; 
    private String[] subject; 
}

在resources下创建名为application.yml的配置文件,里面配置了不同的数据,内容如下:

lesson: SpringBoot
server:
  port: 80
enterprise:
  name: xiaoming
  age: 18
  tel: 12345678
  subject:
    - JAVA
    - 前端
    - 大数据

使用@Value注释

使用@Value("表达式")注解可以从配合文件中读取数据,注解中用于读取属性名引用方式是:${一级属性名,二级属性名......}我们可以在BookController中使用@Value注解读取配合文件数据,如下

@RestController 
@RequestMapping("/books") 
public class BookController { 
    @Value("${lesson}") 
    private String lesson; 
    @Value("${server.port}") 
    private Integer port; 
    @Value("${enterprise.subject[0]}") 
    private String subject_00; 
    @GetMapping("/{id}") 
    public String getById(@PathVariable Integer id){ 
        System.out.println(lesson); 
        System.out.println(port); 
        System.out.println(subject_00); 
        return "hello , spring boot!"; 
    } 
}

使用Environment对象

上面方式读取到的数据特别零散,SpringBoot还可以使用@Autowired注解注入Environment对象的方式读取数据,这种方式SpringBoot会将配置文件中所有数据封装到Environment对象中,如果需要使用哪个数据,只需要通过调用Environment对象的getProperty(String name)的方式获取,具体代码如下:

@RestController

@RequestMapping("/books") 
public class BookController { 
    @Autowired 
    private Environment env; 
    @GetMapping("/{id}") 
    public String getById(@PathVariable Integer id){
        System.out.println(env.getProperty("lesson"));
        System.out.println(env.getProperty("enterprise.name"));
        System.out.println(env.getProperty("enterprise.subject[0]"));
        return "hello , spring boot!"; 
    } 
}

注意:这种方式,框架内容大量数据,而在开发中我们很少使用

自定义对象

SpringBoot还提供了将配置文件中的数据封装到我们自定义的实体类中的方式,具体操作如下:

● 将实体类bean的创建交给Spring管理

   在类上添加@Component注解

● 使用@ConfigurationProperties注解表示加载配置文件

   在该注解中也可以使用prefix属性指定前缀的数据

● 在BookController中进行注入


具体代码如下:


Enterprise实体类内容如下:

//封装yaml对象格式数据必须先声明当前实体类受Spring管控
@Component
//使用@ConfigurationProperties注解定义当前实体类读取配置属性信息,通过prefix属性设置读取哪个数据
@ConfigurationProperties(prefix = "enterprise")
public class Enterprise {
    private String name;
    private Integer age;
    private String tel;
    private String[] subject;
    @Override
    public String toString() {
        return "Enterprise{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", tel='" + tel + '\'' +
                ", subject=" + Arrays.toString(subject) +
                '}';
    }
    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 String getTel() {
        return tel;
    }
    public void setTel(String tel) {
        this.tel = tel;
    }
    public String[] getSubject() {
        return subject;
    }
    public void setSubject(String[] subject) {
        this.subject = subject;
    }
}

BookController内容如下:

@RestController
@RequestMapping("/books")
public class BookController {
    @Autowired
    private Enterprise enterprise;
    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id){
        System.out.println(environment.getName());
        System.out.println(environment.getAge());
        System.out.println(environment.getSubject());
        System.out.println(environment.getTel());
        System.out.println(environment.getSubject()[0]);
        return "hello , spring boot!";
    }
}

注意:


使用第三种方式,在实体类上有如下警告提示

a9914d14f44f46e2bc1cfedb393d1123.png

这个警告解决是在pom.xml中添加如下依赖即可

<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-configuration-processor</artifactId> 
    <optional>true</optional> 
</dependency>
目录
相关文章
|
4月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
470 3
|
Java 数据库连接 Maven
springBoot:项目建立&配置修改&yaml的使用&resource 文件夹(二)
本文档介绍了如何创建一个基于Maven的项目,并配置阿里云仓库、数据库连接、端口号、自定义启动横幅及多环境配置等。同时,详细说明了如何使用YAML格式进行配置,以及如何处理静态资源和模板文件。文档还涵盖了Spring Boot项目的`application.properties`和`application.yaml`文件的配置方法,包括设置数据库驱动、URL、用户名、密码等关键信息,以及如何通过配置文件管理不同环境下的应用设置。
1060 1
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
686 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
JSON Java 数据格式
springboot中表字段映射中设置JSON格式字段映射
springboot中表字段映射中设置JSON格式字段映射
623 1
|
Java 测试技术 Spring
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
这篇文章介绍了Spring Boot中配置文件的语法、如何读取配置文件以及如何通过静态工具类读取配置文件。
1327 0
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
|
XML JSON Kubernetes
什么是 YAML?:一种简洁高效的数据序列化格式
什么是 YAML?:一种简洁高效的数据序列化格式
2285 0
|
XML Java C语言
yaml语法格式,springboot中yaml的使用
本文介绍了YAML的语法格式和数据类型表示方法,并详细讲解了如何在Spring Boot中使用YAML,包括@ConfigurationProperties注解及Bean的创建、编写Controller、配置application.yaml配置文件,以及在pom.xml中开启YAML提示。
|
敏捷开发 数据可视化 Devops
阿里云云效产品使用合集之可视化编排数据如何转换成YAML化编排数据
云效作为一款全面覆盖研发全生命周期管理的云端效能平台,致力于帮助企业实现高效协同、敏捷研发和持续交付。本合集收集整理了用户在使用云效过程中遇到的常见问题,问题涉及项目创建与管理、需求规划与迭代、代码托管与版本控制、自动化测试、持续集成与发布等方面。
|
敏捷开发 缓存 安全
阿里云云效产品使用问题之手动触发流水线的YAML语法该怎么写
云效作为一款全面覆盖研发全生命周期管理的云端效能平台,致力于帮助企业实现高效协同、敏捷研发和持续交付。本合集收集整理了用户在使用云效过程中遇到的常见问题,问题涉及项目创建与管理、需求规划与迭代、代码托管与版本控制、自动化测试、持续集成与发布等方面。
|
XML 数据格式
yaml基本语法和yaml数据格式,ymal对象写法,数组写法
yaml基本语法和yaml数据格式,ymal对象写法,数组写法