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>
目录
相关文章
|
6天前
|
前端开发 Java API
SpringBoot整合Flowable【06】- 查询历史数据
本文介绍了Flowable工作流引擎中历史数据的查询与管理。首先回顾了流程变量的应用场景及其局限性,引出表单在灵活定制流程中的重要性。接着详细讲解了如何通过Flowable的历史服务API查询用户的历史绩效数据,包括启动流程、执行任务和查询历史记录的具体步骤,并展示了如何将查询结果封装为更易理解的对象返回。最后总结了Flowable提供的丰富API及其灵活性,为后续学习驳回功能做了铺垫。
17 0
SpringBoot整合Flowable【06】- 查询历史数据
|
3月前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
295 2
|
6天前
|
存储 前端开发 Java
SpringBoot整合Flowable【05】- 使用流程变量传递业务数据
本文介绍了如何使用Flowable的流程变量来管理绩效流程中的自定义数据。首先回顾了之前的简单绩效流程,指出现有流程缺乏分数输入和保存步骤。接着详细解释了流程变量的定义、分类(运行时变量和历史变量)及类型。通过具体代码示例展示了如何在绩效流程中插入全局和局部流程变量,实现各节点打分并维护分数的功能。最后总结了流程变量的使用场景及其在实际业务中的灵活性,并承诺将持续更新Flowable系列文章,帮助读者更好地理解和应用Flowable。 简要来说,本文通过实例讲解了如何利用Flowable的流程变量功能优化绩效评估流程,确保每个环节都能记录和更新分数,同时提供了全局和局部变量的对比和使用方法。
30 0
|
2月前
|
SQL 前端开发 关系型数据库
SpringBoot使用mysql查询昨天、今天、过去一周、过去半年、过去一年数据
SpringBoot使用mysql查询昨天、今天、过去一周、过去半年、过去一年数据
83 9
|
3月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
116 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
2月前
|
存储 easyexcel Java
SpringBoot+EasyExcel轻松实现300万数据快速导出!
本文介绍了在项目开发中使用Apache POI进行数据导入导出的常见问题及解决方案。首先比较了HSSFWorkbook、XSSFWorkbook和SXSSFWorkbook三种传统POI版本的优缺点,然后根据数据量大小推荐了合适的使用场景。接着重点介绍了如何使用EasyExcel处理超百万数据的导入导出,包括分批查询、分批写入Excel、分批插入数据库等技术细节。通过测试,300万数据的导出用时约2分15秒,导入用时约91秒,展示了高效的数据处理能力。最后总结了公司现有做法的不足,并提出了改进方向。
|
2月前
|
XML JSON Kubernetes
什么是 YAML?:一种简洁高效的数据序列化格式
什么是 YAML?:一种简洁高效的数据序列化格式
296 0
|
3月前
|
Java 测试技术 Spring
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
这篇文章介绍了Spring Boot中配置文件的语法、如何读取配置文件以及如何通过静态工具类读取配置文件。
277 0
springboot学习三:Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件
|
3月前
|
Web App开发 JavaScript Java
elasticsearch学习五:springboot整合 rest 操作elasticsearch的 实际案例操作,编写搜索的前后端,爬取京东数据到elasticsearch中。
这篇文章是关于如何使用Spring Boot整合Elasticsearch,并通过REST客户端操作Elasticsearch,实现一个简单的搜索前后端,以及如何爬取京东数据到Elasticsearch的案例教程。
283 0
elasticsearch学习五:springboot整合 rest 操作elasticsearch的 实际案例操作,编写搜索的前后端,爬取京东数据到elasticsearch中。
|
3月前
|
前端开发 Java 数据库
springBoot:template engine&自定义一个mvc&后端给前端传数据&增删改查 (三)
本文介绍了如何自定义一个 MVC 框架,包括后端向前端传递数据、前后端代理配置、实现增删改查功能以及分页查询。详细展示了代码示例,从配置文件到控制器、服务层和数据访问层的实现,帮助开发者快速理解和应用。