配置文件
1. 配置文件
1.0 配置文件介绍
Springboot使用一个全局的配置文件,配置文件名称固定的:
- application.properties
- application.yml
配置文件的作用:修改SpringBoot自动配置的默认值:SpringBoot在底层已经自动都配置好。
YAML 是又不是一个标记语言。
(YAML a Markup Language;YAML isn’t Markup Language)
YMAL:是以数据为中心的配置文件。
server:
port: 8080
xml:是以标签为依据的配置文件。
<server>
<port>8080</port>
</server>
xml相比YMAL要创建许多的标签。所以YMAL比xml更适合作为配置文件。
1.1 YMAL 基本语法
k:(空格)v:表示一对键值对(空格必须有);
以空格的缩进进行控制层级关系;只要左对齐的一列数据,都是一个层级的
属性和值都是对大小写敏感。
1.1.1. 值的写法
**字面量:普通的值(数字,字符串,布尔)**
k: v: 字面量直接来写。
字符串默认不用加上单引号或者双引号。
- 双引号:不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
name: "zhangsan \n lisi" 输出 zhangsan 换行 lisi - 单引号:会转义特殊字符,特殊字符最终只是一个普通的字符串数据
name: 'zhangsan \n lisi' 输出 zhangsan \n lisi
1.1.2. 对象:Map(属性和值)
k: v:在下一行来写对象的属性和值的关系;注意缩进 对象还是k: v的方式 ``` friends: lastName: zhangsan age; 20 ```
行内写法:<br/>
```
fridens: (lastName: zhangsan,age: 20)
```
1.1.3. 数组
用-值表示数组中的一个元素 ``` pets: - cat - dog - pig ``` 行内写法:
``` pets: {cat,dog,pig} ```
2.常用注解
- @ConfigurationProperties获取值
从配置文件中获取值(该类必须是spring容器中的bean)
默认从全局配置文件中获取
/***
* 将配置文件中配置映射到组件中
* @ConfigurationProperties
* prefex = "person" 配置文件中那个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Map<String,Object> saps;
private List<Object> list;
private Dog dog;
- **@Value获取值** ``` @Component public class Person { @Value("${key}") // key为配置文件中键 private String lastName; @Value("22") private Integer age; ```
First Header | @ConfigurationProperties | @Value |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个一个的指定 |
松散绑定(松散语法) | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303数据校验(eg:@email) | 支持 | 不支持 |
复杂类型封装(map类型等非基本数据类型) | 支持 | 不支持 |
在properties和yml中这两种方式都可以获取到值。
如果在业务逻辑中,只需要获取配置文件中的某一项值,使用@Value
如果在业务逻辑中,我们专门编写了一个JavaBean来和配置文件来进行映射,就用@ConfigurationProperties
- 配置文件注入值数据校验
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
@Email
private String lastName;
private Integer age;
}
- @PropettySource()
获取指定配置文件;但是需要配合@ConfigurationProperties使用。
@Component
@ConfigurationProperties(prefix = "cat")
@PropertySource(value = {"classpath:cat.properties"})
public class Cat {
private String name;
private int age;
- @ImportResource():
导入Spring的配置文件,让配置文件中内容生效。
SpringBoot里面没有Spring的配置文件
需要将该注解放在配置类上
@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
public class Springboot02Application {
public static void main(String[] args) {
SpringApplication.run(Springboot02Application.class, args);
}
}
下面是SPringle的配置文件:beans.xml
<?xml version="1.0" encoding="UTF-8"?>
<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="com.tit.springboot.service.personService" ></bean>
</beans>
- SpringBoot推荐给容器添加组件 采用全注解方式。
- 配置类========Spring的配置文件
- 使用@Bean给容器中添加组件
/**
* @Configuration : 指明当前类是一个配置类;就是代替之前Spring配置文件
*/
@Configuration
public class MyappConfig {
//@Bean 将该方法的返回值添加到容器中;容器中这个组件的默认id就是方法名。
@Bean
public personService helloService() {
System.out.println("配置类添加添加组件》》》》");
return new personService();
}
}
3. 配置文件中的占位符
3.1 随即数
${random.value}
${random.int}
${random.long}
${random.int(10)}
${random.int[1024,65536]}
2。占位符获取之前配置的值,如果没有可以用:指定默认值
person.age=${random.int}
person.last-name=jingdo${random.uuid}
person.dog.name=xiaogou${person.last-name}
person.list=lisi,wangwu
4. profile 主配置文件加载外面的分散配置(环境配置 不同的运行环境)
多profile文件激活
主配置类是properties 中激活指定profile
properties文件名称:application-{profile}.properties
主配置 中通过spring.profiles.active=profile激活
当主配置为yml文件 中激活指定profile
不需要学多个配置文件
在一个文件中写通过yml的多文档块进行写
server:
port: 8888
spring:
profiles:
active:
---
server:
port: 8899
spring:
profiles: dev1
---
server:
port: 8890
spring:
profiles: dev 指定属于哪个环境
SpringBoot支持多种外部位置方式
在命令行激活指定profile
java -jar 项目名称.jar --spring.profiles.active=profile
可以直接在测试时,配置传入命令行参数
虚拟机参数激活指定profile
-Dspring.profiles.active=profile
5.配置文件加载位置(在项目内部)
SpringBoot启动会扫描以下位置的application.properties/application.yml文件夹作为SpringBoot的默认配置
加载的优先级顺序 由高到低,高优先级的覆盖低优先级的;不同优先级之间可以
互补配置:
-file:./config
-file:./
-classpath:/Config
-classpath:/
还可以同过spring.config.location来改变默认的配置文件位置
适合运维时使用:
项目打包好后,我们可以通过命令行参数的形式,启动项目的时候指定配置文件的路径;
指定文件和默认加载的配置文件共同起作用形成互补;
java -jar 项目名称.jar --spring.location=配置文件地址
6.外部配置加载顺序(测试运维的时候使用最方便)
优先级从大到小
命令行参数
java -jar 项目打包后的jar --server.prot=8089 --server.context-path=/abc
多个配置用空格分开; --配置项=值
由jar包外向内加载进行寻找。
优先加载带profile的
- jar包外部的application-{profile}.properties或application-{profile}.yml(带spring.profile)配置文件。
- application-{profile}.properties或application-{profile}.yml(带spring.profile)配置文件。
再来加载不带profile
3. jar包外部的application.properties或application.yml(不带spring.profile)配置文件。
4. jar包内部的application.properties或application.yml(不带spring.profile)配置文件。