SpringBoot学习-配置文件和注解

1、配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的：

  • application.properties
  • application.yml

配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；

YAML( YAML Ain’t a Markup Language )

​ YAML Ain’t a Markup Language : YAML不是一种标记语言；

​ Yet Another Markup Language ： 仍是一种标记语言；

标记语言：

​ 以前的配置文件，大多都是使用的是xxx.xml文件；

​ YAML：以数据为中心，比json、xml等更适合做配置文件；

​ YAML：配置例子

1
2
server:
	port: 8081

​ XML：

1
2
3
<server>
	<port>8081</port>
</server>

2、YAML语法

1、基本语法

​ k:[空格]v 表示一对键值对（空格必须有）；

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

1
2
3
server:
	port: 8081
	path: /hello

​ 属性和值也是大小写敏感；

2、值的写法

  1. 字面量： 普通的值（数字，字符串，布尔）

    k: v ：字面直接来写：

    ​ 字符串默认不用加上单引号或者双引号；

    ​ “”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

    ​ name: “zhangsan \n lisi” ：输出：zhangsan 换行 lisi

    ​ ‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符数据

    ​ name: ‘zhangsan \n lisi’：输出：zhangsan \n lisi

  2. 对象、Map（属性值）（键值对）：

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

    ​ 对象还是k: v的方式

    1
    2
    3
    friends:
    	lastName: zhangsan
    	age: 20

    行内写法

    1
    friends: {lastName: zhangsan,age: 18}

  3. 数组（List、Set）

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

    1
    2
    3
    4
    pets:
     - cat
     - dog
     - pig

    行内写法

    1
    pets: [cat,dog,pig]

3、配置文件值注入

  1. 配置文件
1
2
3
4
5
6
7
8
9
10
11
12
person:
  lastName: zhangsan
  age: 18
  boss: false
  birth: 2017/12/12
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - zhaoliu
  dog:
    name: 小狗
    age: 2
  1. javaBean
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/* 将配置文件中配置的每一个属性的值，映射到组件中
*   @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;
  1. 我们可以导入配置文件处理器，以后编写配置就有提示了
1
2
3
4
5
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-configuration-processor</artifactId>
      </dependency>

4、@ConfigurationProperties和@Vlaue获取值比较

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

配置文件yml还是properties都能获取到值；

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value;

如果说，我们专门编写了一个JavaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

@ConfigurationProperties(prefix = “person”)默认从全局配置文件中获取。

5、配置文件注入值数据校验

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Component
@ConfigurationProperties(prefix = "person")
@Validated //添加数据校验
public class Person {
    @Email //lastName必须是邮箱格式 （@ConfigurationProperties才支持）
//    @Value("${person.last-name}") //支持
//    @Value("${person.lastName}") //不支持（-n替换为N）
    private String lastName;
//    @Value("#{11*2}")
    private Integer age;
//    @Value("true")
    private Boolean boss;
    private Date birth;

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

6、@PropertySource和@ImportResource

@PropertySource

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

/* 将配置文件中配置的每一个属性的值，映射到组件中
*   @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
*       prefix = "person" ：配置文件中哪个下面的所有属性进行一一映射
*    只有这个组件是容器中的组件，才能还用容器@ConfigurationProperties提供的功能
*    @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取
* */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated //添加数据校验
public class Person {
    //    @Email //lastName必须是邮箱格式 （@ConfigurationProperties才支持）
//    @Value("${person.last-name}")
//    @Value("${person.lastName}") //（不支持-n替换为N）
    private String lastName;
//    @Value("#{11*2}")
    private Integer age;
//    @Value("true")
    private Boolean boss;

@ImportResource

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

Spring Boot里面，没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；想让Spring的配置文件生效，加载进来；需要把@ImportResource标注在一个配置类上；

1
2
//Spring的配置文件，让其生效
@ImportResource(locations = {"classpath:bean.xml"})

​ 现在不在编写Spring的配置文件

1
2
3
4
5
6
7
8
9
10
11
<?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-3.0.xsd">
    <bean id="helloService" class="com.ligangit.springbootstudy.service.HelloService">

    </bean>

</beans>

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

  1. 配置类====Spring配置文件

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    /**
     * @Configuration 指明当前类是一个配置类，就是来替代之前的Spring配置文件
     * 在配置文件中使用<bean></bean>标签添加组件
     * 现在使用@Bean给容器中添加组件
     */
    @Configuration
    public class MyAppConfig {

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

7、配置文件中的占位符

  1. 随机数
1
2
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}
  1. 占位符获取之前配置的值，如果没有，那么值默认是表达式，也可以用“:”指定默认值（如 ${person.hello:hello}）
1
2
3
4
5
6
7
8
9
10
11
12
person.last-name=张三${random.uuid}
person.age=${random.int}
person.boss=false
person.birth=2017/12/12
person.maps.k1=v1
person.maps.k2=v4
person.lists=a,b,c
#person.dog.name=${person.last-name}_小狗
#如果占位符的值没有，那么值默认是表达式，如${person.hello}，那么输出${person.hello}
# 也可以设置默认值，如${person.hello:hello}，那么输出hello
person.dog.name=${person.hello:hello}_小狗
person.dog.age=2

8、Profile

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

多Profile文件格式

在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml；

默认使用application.properties的配置；

yml支持多文档块方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
server:
  port: 8081
spring:
  profiles:
    active:prod
---

server:
  port: 8082
spring:
  profiles:dev

---
server:
  port: 8084
spring:
  profiles:prod --指定属于哪个环境

激活指定profile

  1. 在配置文件中指定 spring.profiles.active=dev

  2. 命令行：

    • 打包后启动的时候

      java -jar hello.jar –spring.profiles.active=dev

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

      –spring.profiles.active=dev

      命令行

  3. 虚拟机参数：

    -Dspring.profiles.active=dev

9、配置文件加载位置

​ SpringBoot启动会扫描application.properties或者application.yml文件作为springboot的配置文件。默认创建项目生成application.properties/yml位置在classpath目录下，也可以在以下4个地方创建，优先级自上而下由高到低，SpringBoot会从这四个位置全部加载主配置文件，各个配置文件成互补状态存在，高优先级的配置会覆盖低优先级的配置。

　　 -file: ./config/ 当前项目下的config文件夹

　　 -file: ./ 当前项目下

　　-classpath: /config/ 类路径下的config文件夹

　　-classpath:/ 类路径的根目录

​ ==还可以通过spring.config.location来改变默认的配置文件位置（在配置文件中配置是没有用的，必须在打包后使用此命令）==

​ 使用示例：java -jar hello.jar –spring.config.location=D:/application.properties

​ 项目打包好后，可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同其作用形成互补配置。

10、外部配置加载顺序

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

  1. 命令行参数
    • java -jar hello.jar –server.port=8087 –server.context-path=/abc
    • 多个配置用空格分开；–配置项=值
  2. 来自java:comp/env的JNDI属性
  3. Java系统属性（System.getProperties()）
  4. 操作系统环境变量
  5. RandomValuePropertySource配置的random.*属性值
  6. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
    • 直接将配置文件放在和jar包同级的目录下
    • 直接使用 java -jar 启动就OK
  7. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
  8. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
  9. jar包内部的application.properties或application.yml(不带spring.profile)配置文件
  10. @Configuration注解类上的@PropertySource
  11. 通过SpringApplication.setDefaultProperties指定的默认属性

​ 首先看有没有带profile，然后再看配置文件在jar包内还是外，带profile>没带profile，jar包外>jar包内；

​ ==有jar包外向jar包内进行寻找，优先加载带profile的配置文件，再加载不带profile的配置文件==

最后更新： 2020年07月25日 15:22

原始链接： http://ligangit.com/2019/12/14/SpringBoot学习-配置文件/

赏
× 请我吃糖~
打赏二维码