SpringBoot配置文件详解[云图智联]

配置文件详解

SpringBoot的全局配置文件有两种:

  • application.properties
  • application.yml

配置文件的作用:修改SpringBoot自动配置的默认值.

properties配置文件我们之前都有接触,今天就让我们来认识一下yaml配置文件吧。

SpringBoot配置文件详解[云图智联]

YAML表示YAML Ain’t Markup Language,在百度百科的解释是:

YAML是"YAML Ain’t a Markup Language"(YAML不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:"Yet Another Markup Language"(仍是一种标记语言),但为了强调这种语言以数据做为中心,而不是以标记语言为重点,而用反向缩略语重命名。

所以,我们不用在意它是否是一种标记语言,我们只要记得它是一种以数据为中心的语言就可以,语法非常简洁,使用空白,缩进,分行组织数据,从而使得表示更加简洁易读。

YAML基本语法

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键,只允许使用空格。
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可

所以YAML基本语法其实就是key:(空格)value的形式,其中空格必须要有,以空格的缩进来控制层级关系,只要对齐的一列数据都是同一个层级的,比如:

server: 

 port: 8081

 path: /example

YAML支持的数据结构

字面量(也有“纯量”一叫法)

语法:

字面量:普通的值(整数、浮点数、字符串、布尔、Null值、时间、日期)

  1. key: value(字面值直接写上就可以)
  2. 字符串也默认不需要加上单引号和双引号的(也可以加上引号)
  3. 单引号 :会转义特殊字符,将特殊字符转为一个普通的字符串
  4. name: ‘xiaowang /n’ 打印 xiaowang /n (ps:这里的/n被转成字符串)
  5. 双引号 :不会转义特殊字符,特殊字符还是表达其本身想表示的意思
  6. name: ‘xiaowang /n’ 打印 xiaowang 换行 (ps:这里的/n执行换行操作)

示例:

name: 张三

boolean: TRUE  #true,True都可以

float:

 - 3.14

 - 6.8523015e+5  #可以使用科学计数法

int:

 - 123

 - 0b1010/_0111/_0100/_1010/_1110    #二进制表示

null:

 nodeName: 'node'

 parent: ~  #使用~表示null

string:

 - 哈哈

 - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符

 - newline

 newline2    #字符串可以拆成多行,每一行会被转化成一个空格

date:

 - 2018-02-17    #日期必须使用ISO 8601格式,即yyyy-MM-dd
**注意**:在springboot中yaml文件的时间格式 date: yyyy/MM/dd HH:mm:ss

对象

  1. 对象:也可以说是map,也就是键值对的形式
  2. key: value形式(对象属性key: value的形式表示,在对象名下一行写属性: 属性值)
  3. 同一个对象的各个属性前对齐就可以(默认是两个空格)

    示例:

user:

 username: root

 password: rootpwd
  1. 另外对象也可以写成行内形式

    例如:

user:{username: root,password: rootpwd}

数组

数组:也可以说是list或者序列的方式表示 用"-"空格 值的方式表示数组中一个元素

示例:

pets:

 - cat

 - dog

同样数组也有对应的行内写法,如:

pets: /[cat,dog/]

注意:在实际应用中经常是多种类型相互配合、相互嵌套配合使用,下面我们就来上一个实例

注释

“#” 被注释内容

文本块

|:使用 | 标注的文本内容缩进表示的块,可以保留块中已有的回车换行

value: |

 hello

 world!

# 输出结果:hello 换行 world!

+ 表示保留文字块末尾的换行, - 表示删除字符串末尾的换行。

value: |

hello

value: |/-

hello

value: |+

hello

/# 输出:hello//n hello hello//n//n(有多少个回车就有多少个//n)

注意 “|” 与 文本之间须另起一行

>:使用 > 标注的文本内容缩进表示的块,将块中回车替换为空格,最终连接成一行

value: > hello

world!

/# 输出:hello 空格 world!

YAML在项目中的实际应用

开始实践,yaml使用的时候,经常是组合写法的,也就是对象、字面值等等一起组合使用的,本文结合Springboot,介绍一下这种用法,在Springboot中,yaml语言被用于配置属性,这种写法很简洁,值得推广

  1. 在Springboot项目的 resources目录 中添加 application.yml 文件,注意文件名字不能写错,后缀可以使yaml或者yml都可以,该配置文件springboot项目启动的时候会自动加载

内容如下:

/## 测试ConfigurationProperties

user:

 userName: root

 isAdmin: true

 regTime: 2020/01/01

 isOnline: 1

 maps: {k1 : v1,k2: v2}

 lists:

 - list1

 - list2

 address:

 tel: 15899988899

 name: 上海市

2. 编写测试bean类进行映射

2.1 User类

import org.springframework.boot.context.properties.ConfigurationProperties;

import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;​
@Component
@ConfigurationProperties(prefix /= "user")
public class User {
 private String userName;
 private boolean isAdmin;
 private Date regTime;
 private Long isOnline;
 private Map<String,Object> maps;
 private List<Object> lists;
 private Address address;


 @Override

 public String toString() {
 return "User{" +
 "userName='" + userName + '/'' +
 ", isAdmin=" + isAdmin +
 ", regTime=" + regTime +
 ", isOnline=" + isOnline +
 ", maps=" + maps +
 ", lists=" + lists +
 ", address=" + address +
 '}';
 }

 public String getUserName() {
 return userName;
 }

 public void setUserName(String userName) {
 this.userName = userName;
 }

 public boolean isAdmin() {
 return isAdmin;
 }

 public void setAdmin(boolean admin) {
 isAdmin = admin;
 }

 public Date getRegTime() {
 return regTime;
 }

 public void setRegTime(Date regTime) {
 this.regTime = regTime;
 }

 public Long getIsOnline() {
 return isOnline;
 }

 public void setIsOnline(Long isOnline) {
 this.isOnline = isOnline;
 }

 public Map<String, Object> getMaps() {
 return maps;
 }

 public void setMaps(Map<String, Object> maps) {
 this.maps = maps;
 }

 public List<Object> getLists() {
 return lists;
 }
 public void setLists(List<Object> lists) {
 this.lists = lists;
 }

 public Address getAddress() {
 return address;
 }
 public void setAddress(Address address) {
 this.address = address;
 }

}
解释:

@Component

需要将配置文件中每个属性都映射到这个组件,注意:记得加@Component注解,这样才能将这个组件加载到Spring容器中

@ConfigurationProperties(prefix = "user")

通过prefix属性配置的user在配置文件中绑定user对象,将配置文件中的属性值直接映射到bean属性中

2.2 Address类

public class Address {

 private String tel;

 private String name;

​

 @Override

 public String toString() {

 return "Address{" +

 "tel='" + tel + '/'' +

 ", name='" + name + '/'' +

 '}';

 }

​

 public String getTel() {

 return tel;

 }

​

 public void setTel(String tel) {

 this.tel= tel;

 }

​

 public String getName() {

 return name;

 }

​

 public void setName(String name) {

 this.name= name;

 }

}

3. 测试

ok,这时候启动项目的时候就可在容器中直接使用user对象了,现在我们使用spirng自带的测试类,测试一下

import com.example.easy.entity.Stu;
import org.junit.jupiter.api.Test;
importorg.springframework.boot.test.context.SpringBootTest;
import javax.annotation.Resource;
@SpringBootTest
class EasyApplicationTests {

 @Autowired
 User user;
 @Test
 public void testConfigurationProperties(){

 System.out.println(user);

 }

}

说明:

使用 @Autowired 装配bean直接输出节课(也可以使用其他的注解进行装配)

  1. 运行效果
User{userName='root', isAdmin=false, regTime=Wed Jan 01 00:00:00 CST 2020, isOnline=1, maps={k1=v1, k2=v2}, lists=[list1, list2], address=Address{tel='15899988899', name='上海市'}}

原文 

https://segmentfault.com/a/1190000023063182

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » SpringBoot配置文件详解[云图智联]

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址