配置文件

SpringBoot使用一个全局的配置文件,配置文件名是固定的;
•application.properties
•application.yml
配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;

YAML语法

1、基本语法

k:(空格)v:表示一对键值对(空格必须有)
空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的

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

属性和值也是大小写敏感;

2、值的写法

字面量:普通的值(数字,字符串,布尔)

  1. k: v:字面直接来写;<br /> 字符串默认不用加上单引号或者双引号;<br /> "":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思<br /> name: "zhangsan \n lisi":输出;zhangsan 换行 lisi<br /> '':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据<br /> name: zhangsan \n lisi’:输出;zhangsan \n lisi

对象、Map(属性和值)(键值对):

  1. k: v:在下一行来写对象的属性和值的关系;注意缩进
  2. 对象还是k: v的方式
  1. friends:
  2. lastName: zhangsan
  3. age: 20

行内写法:

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

数组(List、Set):

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

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

行内写法

  1. pets: [cat,dog,pig]

配置文件值注入

  1. person:
  2. lastName: hello
  3. age: 18
  4. boss: false
  5. birth: 2017/12/12
  6. maps: {k1: v1,k2: 12}
  7. lists:
  8. - lisi
  9. - zhaoliu
  10. dog:
  11. name: 小狗
  12. age: 12
  1. /**
  2. * 将配置文件中配置的每一个属性的值,映射到这个组件中
  3. * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
  4. * prefix = "person":配置文件中哪个下面的所有属性进行一一映射
  5. *
  6. * 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
  7. */
  8. @Component
  9. @ConfigurationProperties(prefix = "person")
  10. public class Person {
  11. private String lastName;
  12. private Integer age;
  13. private Boolean boss;
  14. private Date birth;
  15. private Map<String,Object> maps;
  16. private List<Object> lists;
  17. private Dog dog;
  1. <!--导入配置文件处理器,配置文件进行绑定就会有提示-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-configuration-processor</artifactId>
  5. <optional>true</optional>
  6. </dependency>

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

  1. 原来为 table,需要自己转换一下
  2. {"cells":[{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":""},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"@ConfigurationProperties","inlineStyles":{"bold":[{"from":0,"to":24,"value":true}]}},{"textAlign":"center","value":"@Value","inlineStyles":{"bold":[{"from":0,"to":6,"value":true}]}},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"功能"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"批量注入配置文件中的属性"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"一个个指定"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"松散绑定(松散语法)"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"支持"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"×","inlineStyles":{"bold":[{"from":0,"to":1,"value":true}],"font-size":[{"from":0,"to":1,"value":36}]}},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"SpEL"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"×","inlineStyles":{"bold":[{"from":0,"to":1,"value":true}],"font-size":[{"from":0,"to":1,"value":36}]}},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"支持"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"JSR303数据校验"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"支持"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"backColor":"rgb(248, 248, 248)","value":"×","inlineStyles":{"bold":[{"from":0,"to":1,"value":true}],"font-size":[{"from":0,"to":1,"value":36}]}},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"复杂类型封装"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"支持"},{"textAlign":"center","verticalAlign":"middle","wrap":true,"value":"×","inlineStyles":{"bold":[{"from":0,"to":1,"value":true}],"font-size":[{"from":0,"to":1,"value":36}]}}],"heights":[40,40,40,40,40,40],"widths":[203,239,172]}

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

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

  1. @Component
  2. @ConfigurationProperties(prefix = "person")
  3. @Validated
  4. public class Person {
  5. //lastName必须是邮箱格式
  6. @Email
  7. private String lastName;
  8. private Integer age;
  9. private Boolean boss;
  10. private Date birth;
  11. private Map<String,Object> maps;
  12. private List<Object> lists;
  13. private Dog dog;

3、@PropertySource&@ImportResource&_@_Bean

@PropertySource:加载指定的配置文件

  1. /**
  2. * @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值;
  3. *
  4. */
  5. @Component
  6. @ConfigurationProperties(prefix = "person")
  7. @PropertySource(value = {"classpath:person.properties"})
  8. public class Person {
  9. private String lastName;
  10. private Integer age;
  11. private Boolean boss;

@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效

Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上
_@_ImportResource(locations = {“classpath:beans.xml”})
导入Spring的配置文件让其生效
编写Spring的配置文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
  5. <bean id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
  6. </beans>

_@_Bean

SpringBoot推荐给容器中添加组件的方式;推荐使用全注解的方式
1、配置类@Configuration———>Spring配置文件
2、使用@Bean给容器中添加组件

  1. /**
  2. * @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置文件
  3. * 在配置文件中用<bean><bean/>标签添加组件
  4. */
  5. @Configuration
  6. public class MyAppConfig {
  7. //将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
  8. @Bean
  9. public HelloService helloService02(){
  10. System.out.println("配置类@Bean给容器中添加组件了...");
  11. return new HelloService();
  12. }
  13. }

4、配置文件占位符

1、随机数

  1. ${random.value}、${random.int}、${random.long}
  2. ${random.int(10)}、${random.int[1024,65536]}

2、占位符获取之前配置的值,如果没有可以是用”:”指定默认值

  1. person.last-name=张三${random.uuid}
  2. person.age=${random.int}
  3. person.birth=2017/12/15
  4. person.boss=false
  5. person.maps.k1=v1
  6. person.maps.k2=14
  7. person.lists=a,b,c
  8. person.dog.name=${person.hello:hello}_dog
  9. person.dog.age=15

5、Profile

1、多Profile文件

我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties的配置;

2、yml支持多文档块方式

  1. server:
  2. port: 8081
  3. spring:
  4. profiles:
  5. active: prod
  6. ---
  7. server:
  8. port: 8083
  9. spring:
  10. profiles: dev
  11. ---
  12. server:
  13. port: 8084
  14. spring:
  15. profiles: prod #指定属于哪个环境

3、激活指定profile

  1. 1、在配置文件中指定 spring.profiles.active=dev
  2. 2、命令行:
  3. java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
  4. 可以直接在测试的时候,配置传入命令行参数
  5. 3、虚拟机参数;
  6. -Dspring.profiles.active=dev

6、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
file:./config/
file:./
classpath:/config/
classpath:/
03 配置文件 - 图1
优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件;互补配置;
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar —spring.config.location=G:/application.properties

7、外部配置加载顺序

SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置
1.命令行参数
所有的配置都可以在命令行上进行指定

  1. java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
  2. 多个配置用空格分开; --配置项=值

2.来自java:comp/env的JNDI属性
3.Java系统属性(System.getProperties())
4.操作系统环境变量
5.RandomValuePropertySource配置的random.*属性值
由jar包外向jar包内进行寻找
优先加载带profile
6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
再来加载不带profile
8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件
10.@Configuration注解类上的_@_PropertySource
11.通过SpringApplication.setDefaultProperties指定的默认属性
所有支持的配置加载来源;
参考官方文档