0
点赞
收藏
分享

微信扫一扫

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


目录

​​一、yaml格式​​

​​二、yaml格式语法规则​​

​​三、yaml配置文件数据读取​​

​​环境准备​​

​​使用@Value注释​​

​​使用Environment对象​​

​​自定义对象​​

一、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!";
}
}

注意:

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

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

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

<dependency> 
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>

举报

相关推荐

0 条评论