springboot系列4-配置文件及yml、properties、xml对比
文章目录
- 1、配置文件
- 2、YAML语法:
- 1、基本语法
- yaml中的松散写法
- 2、值的写法
- 字面量:普通的值(数字，字符串，布尔)
- 对象、Map(属性和值)(键值对):
- 数组(List、Set):
- 3、配置文件值得注入
- 4、properties配置
- 乱码问题：
- 5、@ConfigurationProperties和@Value两种对比
- 6、分离配置
- 1、@PropertySource：加载指定的配置文件
- 2、@ImportResource：导入Spring的配置xml文件，让配置文件里面的内容生效
- 3、springboot推荐的配置方式
- 7、配置文件占位符
- 8、加载多配置文件
- 激活指定profile
- 9、配置文件加载位置
- 配置根目录
- 10、外部配置加载顺序
1、配置文件
spring默认只用两种配置文件：
SpringBoot使用一个全局的配置文件，配置文件名是固定的;
*application.properties*application.yml
配置文件的作用:
修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;
有以下说法：
- YAML(YAML Ain’t Markup Language)
- YAML A Markup Language:是一个标记语言
- YAML isn’t Markup Language:不是一个标记语言;
标记语言:
以前的配置文件;大多都使用的是 xxxx.xml文件;
YAML:以数据为中心，比json、xml等更适合做配置文件;
YAML:配置例子:
server:
port: 8082
properties配置：
server.port=8081
xml配置：
<server>
<port>8081port>
server>
springboot使用properties或yml均可，选一即可。
2、YAML语法:
1、基本语法
k:(空格)v:表示一对键值对(空格必须有);
以空格的缩进来控制层级关系;
只要是左对齐的一列数据，都是同一个层级的
server:
port: 8081
path: /hello
属性和值也是大小写敏感;
yaml中的松散写法
属性名匹配规则(Relaxedbinding)
person.firstName:使用标准方式person.first-name:大写用-person.first_name:大写用_PERSON_FIRST_NAME: 推荐系统属性使用这种写法
2、值的写法
字面量:普通的值(数字，字符串，布尔)
- k: v:字面直接来写;
- 字符串默认不用加上单引号或者双引号;
- “”: 双引号;会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
- name: “zhangsan \n lisi”:输出;zhangsan 换行 lisi ‘’:
- ‘’单引号; 不会转义特殊字符，特殊字符最终只是一个普通的字符串数据
- name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi
对象、Map(属性和值)(键值对):
方式1：
k: v:在下一行来写对象的属性和值的关系;注意缩进
对象还是k: v的方式
friends:
lastName: zhangsan
age: 20
方式2：行内写法
friend: {lastName: z, age: 12 }
数组(List、Set):
用- 值表示数组中的一个元素
pets:
- dog
- cat
- pig
pet: [dog,cat,pig]
3、配置文件值得注入
1.Person.java
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map maps;
private List 2.配置文件application.yml
person:
lastName: hello
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
‐ lisi
‐ zhaoliu
dog:
name: 小狗
age: 12
3.在bean需要加上注解，才能读配置文件
/**
* 将配置文件中配置的每一个属性的值，映射到这个组件中
* 1:
* @ConfigurationProperties：
* 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
* prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
*
* 2:
* @Component:
* 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
*
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
我们可以导入配置文件处理器，以后编写配置就有提示了
加入依赖：
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-configuration-processorartifactId>
<optional>trueoptional>
dependency>
这样写配置就会提示了：
person:
last-name: wang #这种写法和lastName都可以
4.单元测试
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot01SpringworldQuickApplicationTests {
@Autowired
Person person;
@Test
public void contextLoads() {
System.out.println(person);
}
...
//结果
Person{lastName='hello', age=18, boss=false, birth=Tue Dec 12 00:00:00 CST 2017, maps={k1=v1, k2=12}, lists=[‐ lisi ‐ zhaoliu], dog=Dog{name='小狗', age=12}}
4、properties配置
将application.yml中的内容注释掉，将配置写在application.properties中也行。
server.port=8081
# idea，properties配置文件utf-8
person.last-name=张三
person.age=12
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
测试结果：
Person{lastName='å¼ ä¸‰', age=12, boss=false, birth=Fri Dec 15 00:00:00 CST 2017, maps={k1=v1, k2=14}, lists=[a, b, c], dog=null}
乱码问题：
5、@ConfigurationProperties和@Value两种对比
不使用@ConfigurationProperties，对每个属性均时候用@Value注解也可以。
@Value方式：
@Value是底层注解，同xml中配置bean的方式。
/**
* <bean class="Person">
* <property name="lastName" value="①字面量/②${key}从环境变量、配置文件中获取值/③#{SpEL}">property>
* <bean/>
*/
@Component
//@ConfigurationProperties(prefix = "person")
public class Person {
@Value("${person.last-name}") //读配置
private String lastName;
@Value("#{11*2}") //表达式
private Integer age;
@Value("true") //字面量
private Boolean boss;
@ConfigurationProperties可以使用数据校验注解：
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
@Email
private String lastName;
上述代码即可校验lastName
对比：
-
配置文件yml还是properties他们都能获取到值；
-
如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用
@Value； -
如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用
@ConfigurationProperties；
6、分离配置
@ConfigurationProperties(prefix = “person”) 默认从全局配置文件中获取值。
以下注解可以指定配置
1、@PropertySource：加载指定的配置文件
@ConfigurationProperties(prefix = "person")
@PropertySource(value = {"classpath:person.properties"})
public class Person {
说明：虽然使用@PropertySource(value = {“classpath:person.properties”})指出了文件位置。还是要@ConfigurationProperties(prefix = “person”)注解。
2、@ImportResource：导入Spring的配置xml文件，让配置文件里面的内容生效
Spring Boot里面没有Spring的配置xml文件，我们自己编写的配置文件，也不能自动识别； 想让Spring的配置文件生效，加载进来；需要将@ImportResource标注在一个配置类上。
beans.xml:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="helloService" class="cn.whbing.springboot01.service.HelloService">
bean>
beans>
上述beans是想将HelloService注入到容器。如果直接建配置文件不会生效，需要在主配置类上加注解。
主配置加上@ImportResource注解：
@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效
@ImportResource(locations = {"classpath:beans.xml"}) //加载xml配置
@SpringBootApplication
public class HelloworldQuickApplication {
public static void main(String[] args) {
SpringApplication.run(HelloworldQuickApplication.class, args);
}
}
测试：
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot01SpringworldQuickApplicationTests {
@Autowired
Person person;
@Autowired
ApplicationContext ioc; //上下文
@Test
public void contextLoads() {
System.out.println(person);
}
@Test
public void helloServiceTest(){
boolean b = ioc.containsBean("helloService");
System.out.println(b); //true
}
}
3、springboot推荐的配置方式
springboot不推荐xml配置文件，推荐全注解方式。
过程：
（1）配置类@Configuration---->Spring xml配置
（2）@Bean给容器中添加组件
/**
* @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
*
* 在配置文件中用测试：
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot01SpringworldQuickApplicationTests {
@Autowired
Person person;
@Autowired
ApplicationContext ioc;
@Test
public void contextLoads() {
System.out.println(person);
}
@Test
public void helloServiceTest(){
// boolean b = ioc.containsBean("helloService");
// boolean b = ioc.containsBean("helloService01");
boolean b = ioc.containsBean("helloService02");
System.out.println(b); //true
}
}
7、配置文件占位符
1、随机数
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}
2、占位符获取之前配置的值，如果没有可以是用:指定默认值
person.last‐name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15
上述变量person.hello没有找到，所以使用默认值hello再拼接后边的
8、加载多配置文件
项目的三个配置文件，其中，application.yml是启动服务时，服务器会自动加载的配置文件，而application-dev.yml代表的是开发环境的配置文件，application-prod.yml代表的是生产环境的配置文件，后两个文件在启动服务时，服务器不会自动加载，那么在不同的环境中时怎么调用不同的文件的呢？
我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml
1、方式1：写多个.yml的配置文件，然后在application.yml中激活。见springboot多配置
2、方式2：yml支持多文档块方式
server:
port: 8081
spring:
profiles:
active: prod
‐‐‐
server:
port: 8083
spring:
profiles: dev
‐‐‐
server:
port: 8084
spring:
profiles: prod #指定属于哪个环境
激活指定profile
1、在配置文件中指定 spring.profiles.active=dev
2、命令行：
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；
可以直接在测试的时候，配置传入命令行参数
3、虚拟机参数；
-Dspring.profiles.active=dev
9、配置文件加载位置
springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/
–file:./
–classpath:/config/
–classpath:/
SpringBoot会从这四个位置全部加载主配置文件；互补配置；
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默 认加载的这些配置文件共同起作用形成互补配置；
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
配置根目录
server:
context-path: /boot
则访问时，都要加/boot
http://localhost:8081/boot/hello
10、外部配置加载顺序
SpringBoot也可以从以下位置加载配置； 优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置
如：
1、命令行参数
所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
多个配置用空格分开； --配置项=值