Spring Boot 配置文件（2）

最新推荐文章于 2022-09-04 16:30:47 发布

C小陈童鞋

最新推荐文章于 2022-09-04 16:30:47 发布

阅读量365

点赞数

分类专栏： Spring Boot

本文链接：https://blog.csdn.net/chenHaiJaheike/article/details/100124138

版权

Spring Boot 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

前言

本章主要讲解 Spring Boot 中的配置文件。

配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的；放置在src/main/resources 目录或者类路径的 /config 下。Spring Boot提供了两种常用的配置文件，分别是properties文件和yml文件。他们的作用都是修改Spring Boot自动配置的默认值。

application.properties
application.yml

Spring Boot 不仅支持常规的 properties 配置文件，还支持 yaml 语言的配置文件。yaml 是以数据为中心的语言，在配置数据的时候具有面向对象的特征。

在这里插入图片描述

Yaml

1、Yaml 简介

yml是YAML（YAML Ain’t Markup Language）语言的文件，以数据为中心，比json、xml等更适合做配置文件。

yml和xml相比，少了一些结构化的代码，使数据更直接，一目了然。

yml和json呢？没有谁好谁坏，合适才是最好的。yml的语法比json优雅，注释更标准，适合做配置文件。json作为一种机器交换格式比yml强，更适合做api调用的数据交换。

Yaml
```
server:
  port: 8081
```
XML：
```
<server>
	<port>8081</port>
</server>
```

2、Yaml语法

以空格的缩进程度来控制层级关系。空格的个数并不重要，只要左边空格对齐则视为同一个层级。注意不能用tab代替空格。且大小写敏感。支持字面值，对象，数组三种数据结构，也支持复合结构。

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
    port: 8081
    path: /hello

基本格式要求

YAML大小写敏感；
使用缩进代表层级关系；
缩进只能使用空格，不能使用TAB，不要求空格个数，只需要相同层级左对齐（一般2个或4个空格）
注释和properties相同，使用 # 作为注释，YAML中只有行注释。

值的写法

字面值：字符串，布尔类型，数值，日期。字符串默认不加引号，单引号会转义特殊字符，双引号不会。日期格式支持yyyy/MM/dd HH:mm:ss
对象：由键值对组成，形如 key:(空格)value 的数据组成。冒号后面的空格是必须要有的，每组键值对占用一行，且缩进的程度要一致，也可以使用行内写法：{k1: v1, …kn: vn}
数组：由形如 -(空格)value 的数据组成。短横线后面的空格是必须要有的，每组数据占用一行，且缩进的程度要一致，也可以使用行内写法： [1,2,…n]
复合结构：上面三种数据结构任意组合

3、Yaml运用

对象、Map（属性和值）（键值对）：

k: v：在下一行来写对象的属性和值的关系；注意缩进

对象还是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

数组（List、Set）：

用 - 值表示数组中的一个元素

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

配置文件值注入

person:
  # 属性赋值
  lastName: helloword
  age: 12
  boss: true
  birth: 2019/08/28
  # map赋值
  maps: {k1: v1,k2: 12}
  # list赋值
  lists:
  - lisi
  - zhaoliu
  # 对象赋值
  dog:
    name: xiaogou
    age: 12

创建实体类Person .java 获取配置文件中的属性值，通过注解@ConfigurationProperties获取配置文件中的指定值并注入到实体类中。

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

我们可以导入配置文件处理器，以后编写配置就有提示了

<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-configuration-processor</artifactId>
		<optional>true</optional>
	</dependency>

Test 测试类：

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {

    @Autowired
    Person person;
    @Test
    public void contextLoads() {
        System.out.println(person.toString());
    }

}

结果：

Person{lastName='helloword', age=12, boss=true, birth=Wed Aug 28 00:00:00 CST 2019, maps={k1=v1, k2=12}, lists=[lisi, zhaoliu], dog=com.example.demo.pojo.Dog@54562ea6}

4、Properties

properties文件大家经常用，这里就简单介绍一下。其语法结构形如：key=value。注意中文乱码问题，需要转码成ASCII。

#属性赋值
person.lastName = helloword
person.age= 12
person.boss= true
person.birth= 2019/08/28
# map赋值
person.maps.k1=v1
person.maps.k2=v2
# list赋值
person.lists=lisi,zhangsan
# 对象赋值
person.dog.name=xiaogou
person.dog.age=12

从配置文件中取值注入到实体类中，和YAML是一样的。

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

配置文件注入值数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated   //注入值数据校验的注解
public class Person {

   //lastName必须是邮箱格式
    @Email
    private String lastName;
    private Integer age;
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

5、配置文件的存取

Spring Boot通过ConfigurationProperties注解从配置文件中获取属性。从上面的例子可以看出ConfigurationProperties注解可以通过设置prefix指定需要批量导入的数据。支持获取字面值，集合，Map，对象等复杂数据。ConfigurationProperties注解还有其他特么呢？它和Spring的Value注解又有什么区别呢？

@ConfigurationProperties和@Value优缺点

可以从配置文件中批量注入属性；
支持获取复杂的数据类型；
对属性名匹配的要求较低，比如user-name，user_name，userName，USER_NAME都可以取值；
支持JAVA的JSR303数据校验；
缺点是不支持强大的SpEL表达式；

Value注解的优缺点正好相反，它只能一个个配置注入值；不支持数组、集合等复杂的数据类型；不支持数据校验；对属性名匹配有严格的要求。最大的特点是支持SpEL表达式，使其拥有更丰富的功能。

@Value获取值和@ConfigurationProperties获取值比较

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

配置文件yml还是properties他们都能获取到值；
如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；
如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

6、`@PropertySource`&`@ImportResource`&`@Bean`

概述：

我们对于一些属性的配置肯定不会写在一个配置文件中这样显得耦合性太强，如何去指定配置文件呢？下面我们就通过@PropertySource、@ImportResource、@Bean的使用这几个属性的学习来解决此问题。

@PropertySource：加载指定的配置文件；

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {

   //lastName必须是邮箱格式
   // @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，不能自动识别；
想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上
@ImportResource标注在一个配置类上但是这种方式官方并不推荐

@ImportResource(locations = {"classpath:beans.xml"})

不来编写Spring的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.atguigu.springboot.service.HelloService"></bean>
</beans>

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

1、配置类 @Configuration --------- Spring配置文件

2、使用 @Bean给容器中添加组件

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

配置文件占位符

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

Profile

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活，指定参数等形式快速切换环境。

1、多Profile文件（properties文件）

编写的时候，文件名可以是： application-{profile}.properties/yml

默认使用application.properties的配置；

创建配置文件application-dev.properties,此文件为开发环境的配置文件
```
server.port=8081
```
创建配置文件allpication-prod.properties,此文件为生产环境的配置文件
```
server.port=8082
```

在appliapplication.properties中添加使用的环境

#默认配置文件的端口
server.port=8080
#使用的环境名称
spring.profiles.active=dev

2、yml支持多文档块方式

在以下yml文件中，用 --- 分为三个ducement，第一个ducument为默认的配置文件，第二个部分为dev的配置文件，第三个部分为prod的配置文件。在默认doucment中使用spring.profiles.active设置使用哪个ducument 的配置。

server:
  port: 8081
spring:
  profiles:
    active: prod #指定运行哪个环境

---
server:
  port: 8083
spring:
  profiles: dev

---

server:
  port: 8084
spring:
  profiles: prod

3、激活指定profile

在配置文件中指定 spring.profiles.active=dev
Program arguments
在Program arguments中配置参数 --spring.profiles.active=dev
命令行：
将项目打包成jar包，切换到命令行的界面下使用命令： java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；

可以直接在测试的时候，配置传入命令行参数

虚拟机参数；
-Dspring.profiles.active=dev

配置文件加载位置

Spring Boot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件

file：../config/
file：../
classpath：/config/
classpath：/

即根目录下的config目录下，然后是根目录下，然后是classpath路径下的config目录下，最后是classpath路径下。

优先级由高到底，高优先级的配置会覆盖低优先级的配置；如果SpringBoot中四个位置都有配置文件，会从这四个位置全部加载主配置文件；并且形成互补配置；

我们还可以通过spring.config.location来改变默认的配置文件位置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；
```
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=D:/application.properties
```

外部配置加载顺序

SpringBoot也可以从以下位置加载配置；优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置

命令行参数

所有的配置都可以在命令行上进行指定
```
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087  --server.context-path=/abc
```
多个配置用空格分开； --配置项=值
来自java:comp/env的JNDI属性
Java系统属性（System.getProperties()）
操作系统环境变量
RandomValuePropertySource配置的random.*属性值

由jar包外向jar包内进行寻找；优先加载带profile

jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

再来加载不带profile

jar包外部的application.properties或application.yml(不带spring.profile)配置文件
jar包内部的application.properties或application.yml(不带spring.profile)配置文件
@Configuration注解类上的@PropertySource
通过SpringApplication.setDefaultProperties指定的默认属性

总结

Spring Boot 配置文件就讲到这里，还有一个自动配置原理，下一篇讲解。在这里插入图片描述

C小陈童鞋

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring Boot 配置文件（2）

前言讲解一下 Spring Boot 中的配置文件。Spring Boot 配置文件SpringBoot使用一个全局的配置文件，配置文件名是固定的；放置在【src/main/resources】目录或者类路径的 /config 下。application.propertiesapplication.yml配置文件的作用：修改SpringBoot自动配置的默认值；Spri...
复制链接

扫一扫