1 yaml简介
1.1 基本语法
k:(空格)v: 表示一对键值对(空格必须有)
以空格的缩进来控制层级关系;只要是做肚脐的一列数据,都是同一个层级的。
server:
port: 8081
path: /hello
属性和值都是大小写敏感的。
1.2 值的写法
1.2.1 字面量
1.2.1.1 普通的值(数字、字符串、布尔)
k:v;字面量直接来写,字符串不需要加上丹壹号或者双引号;
双引号:不会转移字符串李的特殊字符,特殊字符会作为本身想表示的意思。
name:"zhangsan\nlisi"
其输出就是有换行。
单引号:会转义特殊字符,特殊字符最终只是一个普通的字符串数据。
name:"zhangsan\nlisi"
输出为原样。
1.2.1.2 对象、Map(属性和值、键值对)
对象还是k:v的方式,在下一行直接写对象的属性和值的关系,不过要注意缩进(两个空格)。
friends:
lastName: zhangsan
age: 20
行内写法:
friends: {lastName: zhangsan,age: 18}
1.2.1.3 数组(List、Set)
短横线(空格)值 表示数组中的一个元素。
pets:
- cat
- dog
- pig
行内写法:
pets: [cat,dog,pig]
1.3 进阶语法
1.3.1 复合结构
person:
lastName: zhangsan
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
- lisi
- zhangsan
dog:
name: xiaogou
age: 2
2 配置文件
SB使用一个全局配置文件,配置文件名是固定的:
- application.properties
- application.yml
配置文件的作用:修改SB自动配置的默认值。SB在底层都给我们自动配置好了;
配置文件位于src/resources下面。
2.1 YAML
yaml a markup language 是一个标记语言,以数据为中心,比其他类型的标记语言更适合作为配置文件。
标记语言:以前的配置文件大多都使用XXX.xml文件,
2.2 不同文件配置方式
YAML:
server:
port: 8081
XML:
8081
properties:
server.port = 8081
3 例子:配置文件实现值的注入
3.1 编写配置文件
person:
lastName: zhaoyi
list:
- list1
- list2
maps:
k1: v1
k2: v2
age: 25
boss: false
dog:
name: xiaohuang
age: 30
配置组件
// person类
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private List
3.2 使配置拥有提示
导入配置文件处理器,这样就会有提示编写资源的信息;
org.springframework.boot
spring-boot-configuration-processor
true
只有组件是容器中的组件,才能使用ConfigurationProperties提供的功能;
3.3 编写测试类
SB单元测试:可以在测试期间很方便的类似编码一样进行自动注入等容器功能;
@RunWith(SpringRunner.class)
@SpringBootTest
public class Hello1ApplicationTests {
@Autowired
Person person;
@Test
public void contextLoads() {
System.out.println(person);
}
}
4 properties配置文件的编码问题
4.1 使用properties配置文件
注释掉application.yml的配置文件信息,新建一个application.properties文件,写入和applicatio.yml相同功能的配置
person.age=14
person.last-name=张三
person.boss=false
person.maps.k1=v1
person.maps.k2=v2
person.list=a,b,c
person.dog.name=小狗
person.dog.age=5
运行测试后发现有关中文部分的输出是乱码。
4.2 解决方法
idea使用的是utf-8编码,在setting处查询file encoding,设置为utf-8,并选择在运行时转化为ascll(勾选)
5 @configurationProperties和@Value
Spring中配置一个Bean:
其中,value可以:
- 字面量
- ${key} 从环境变量或者配置文件中提取变量值
#{SPEL}
而@Value其实效果和其一样,比如,在类属性上写
@Value("person.lastName")
private String lastName
@Value("#{11*2}")
private Integer age
5.1 区别
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
支持松散绑定 | 不支持松散绑定 | |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
注:
- 松散绑定例如:
配置文件填写的是last-name,而@Value必须写一模一样的,否则会报错。而使用@ConfigurationProperties则可以使用驼峰式(其实就是类的属性名) - @Validation 在类上加入此配置之后,开启jsr303校验,例如在某字段上加上@Email,则配置文件对应字段必须符合邮箱格式。相反,如果此处我们使用@Value注入值,可以看到,可以正常的注入,即便提供的不符合邮箱格式,也不会报错。
5.2 选择
从上面的说明我们可以知道,两者在配置上基本可以相互替换,彼此功能也大体一致,那么,我们在业务场景中,该选用哪一种进行编码呢?
- 如果说,我们只是在某个业务逻辑中需要获取一下配置文件的某项值,考虑使用
@Value
.
@RestController
public class HelloController {
@Value("${person.last-name}")
private String name;
@RequestMapping("/")
public String hello(){
return "hello world, " + name;
}
}
- 但是,如果我们专门去写一个java bean来和配置文件进行映射,那么毫无疑问,我们应该使用
@ConfigurationProperties
;
6 @PopertySource注解
@PropertySource
加载指定的配置文件。
我们知道,@ConfigurationProperties默认从全局配置文件(application.properties)中获取值,但通常我们会将相关的配置文件放到某个配置文件中,例如,我们将有关person的配置信息放到person.properties中去。为了使组件类Person能够找到配置文件的配置信息,需要使用增加新的注解@PropertySource
指定从哪里加载配置等相关信息。
@PropertySource("classpath:person.properties")
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
}
7 @ImportResource注解
@ImportResource
导入Spring的配置文件,让配置文件里面的内容生效。
- 添加新的服务类HelloService
package com.zhaoyi.hello1.service;
public class HelloService {
}
- 在类目录下创建一个bean.xml,即spring的配置文件,其中配置了一个service的bean.
那么问题来了,在spring-boot中显然是不会加载此bean的,我们测试一下。
- 编写测试类
@RunWith(SpringRunner.class)
@SpringBootTest
public class Hello1ApplicationTests {
@Autowired
ApplicationContext ioc;
@Test
public void testBean(){
System.out.println("Is have helloService bean? " + ioc.containsBean("helloService"));
}
}
测试结果:
Is have helloService bean? false
Spring boot里面是没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别,想让Spring的配置文件生效,则需要手动指示将其加载进行,使用@ImportResource
标注在一个配置类(例如应用程序启动类,他也是一个配置类)上:
@ImportResource(locations = {"classpath:bean.xml"})
@SpringBootApplication
public class Hello1Application {
public static void main(String[] args) {
SpringApplication.run(Hello1Application.class, args);
}
}
这时候运行测试用例就会发现,bean已经出现在容器中了。
7 @Bean注解
@ImportResource(locations = {"classpath:bean.xml"})
一般我们不会使用6中所提到的这种方式,因为xml配置方式实在是写了太多的无用代码,如果xml的标签声明,以及头部的域名空间导致。因此,SpringBoot推荐给容器中添加组件的方式:全注解方式。也就是用配置类来充当bean配置文件。如下,即为一个配置类:
/**
* @Configuration 指明当前类是一个配置类
*/
@Configuration
public class MyConfig {
// 将方法的返回值添加到容器中:容器中这个组件的id就是方法名
@Bean
public HelloService helloService(){
return new HelloService();
}
}
通过该配置类,可以为容器中添加了一个名为helloService
的bean。
8 配置文件占位符
无论是使用yaml还是properties都自持文件占位符配置方式
8.1 随机数
${random.value}
${random.int}
${random.long}
${random.int(10)}
${random.int[1024,65536]}
8.2 属性占位符
- 可以在配置文件中引用前面配置过的属性;
- ${app.name:默认值} 若找不到属性时,则取默认值处填写的值;
8.3 例子
- 在person.properties中写入如下配置
person.age=14
person.last-name=张三${random.uuid}
person.boss=false
person.maps.k1={person.xxx:novalue}
person.maps.k2=v2
person.list=a,b,c
person.dog.name=${person.last-name}_小狗狗
person.dog.age=${random.int}
- 测试输出
Person{lastName='张三1b9fbbb1-6c58-4a35-8165-ad23800d7456', list=[a, b, c], maps={k2=v2, k1=novalue}, age=14, boss=false, dog=Dog{name='张三b3a355d7-54ce-4afd-9ae6-d3be4aeb4165_小狗狗', age=-122850975}}
注意:留意默认值那一项设置,我们如愿的成功设置了默认值novalue。在实际项目中,这种情况比较常用,稍微留意一下。如果没有默认值,则会将${xxx}这一段作为值,这显然是错误的。
9 Profile
profile一般是spring用来做多环境支持的,可以通过激活指定参数等方式快速的切换当前环境。
9.1 多Profile文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties(yml)
例如:
application-dev.properties、application-prod.properties等。
9.2 激活指定profile
- 在application.properties中指定:
spring.profiles.active=dev
- 命令行方式激活,此配置的优先级高于配置文件处的配置。
--spring.profiles.active=dev
- 方式一 点击编译环境右上角的下拉框,选择第一项
edit configuration
,在environment配置节中的Program arguments
写入spring.profiles.active=dev即可。 - 方式二 将当前的项目打包生成jar包,然后执行
java -jar your-jar-name.jar --spring.profiles.active=dev
即可。
- 虚拟机参数方式激活 在步骤2的老地方,
Program arguments
上一项即为虚拟机参数激活,不过填写的内容为-Dspring.profiles.active=dev
,即多了一个-D
而已。
9.3 yml多文档配置文件
若我们使用properties,则需要编写多个不同的配置文件,但如果我们使用yml的话,则可以通过多文档配置节实现单文件管理。注:有关yml相关的知识参考此文档的前半部分。
可以看到,我们通过---
三个横线实现文档分割,同时在每一个文档块处指定了各个profile的不同配置信息,即dev环境下启动服务使用8082端口,prod环境下使用8083端口。而指定哪一个profile则是通过默认的文档块(即第一块)中的spring.profiles.active进行配置。完成如上配置之后我们启动服务,显然此时是以激活的prod环境所配置的端口8083运行的,如下启动日志所示:
com.zhaoyi.hello1.Hello1Application : The following profiles are active: prod
o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8083 (http)
也就说,当我们选定一个profile后,对应的文档块的配置就会全部生效。
未完待续。