Spring Boot_配置

Scroll Down

上一篇 >> Spring Boot_入门

下一篇 >> Spring Boot_日志

fighting!fighting!

Spring Boot 配置

1. 配置文件

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

  • application.properties
  • application.yaml

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

YAML(YAML Ain't Markup Language)

  • YAML A Markup Languange: 是一个标记语言
  • YAML isn't Markup Languange: 不是一个标记语言

标记语言:

  • 以前的配置文件 大多都是用的是 xxx.xml 文件;
  • YAML 以数据为中心,比json、xml更适合做配置文件
  • YAML: 配置实列
server:
  port:8081
  • XML:
<server>
	<port>8081</port>
</server>

2. YAML 语法

2.1 YAML基本语法

K:(空格)v : 表示一对键值对(空格必须由);

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

server:
	port: 8081
	path: /hello

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

2.2 YAML值的写法

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

​ k: v :字面直接来写;

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

​ "":双引号; 会转义字符串里面的特殊字符; 特殊字符作为本身想表示的意思

​ name: "zhangsan \n lisi" : 输出 zhangsan 换行 lisi

​ '':单引号; 不会会转义特殊字符 特殊字符最终只是一个普通的字符串数据

​ name: 'zhangsan \n lisi' : 输出 zhangsan \n lisi

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

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

​ 对象还是k: v的方式

friends:
	lastName: zhangsan
	age: 20

行内写法:

friends: {lastName: zhagnsan,age:20}

数组( List, Set):

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

pets:
 - cat
 - dog
 - pig

行内写法:

pets: [cat,dog,pig]

3. 配置文件值注入

配置文件

person:
    lastName: zhangsan
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 2

javaBean:

/**
 * 将配置文件的每一个属性的值, 映射到这个组件中
 * @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>

3.1 properties配置文件在idea中默认utf-8可能会乱码

在设置编码那边勾选自动转换ascll码

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

对比
@ConfigurationProperties@Value
功能批量注入配置文件中的属性一个个指定
松散绑定支持(lastName==last-name)不支持
SpEL不支持(#{11*2})支持
JSR303数据校验支持不支持
复杂类型封装支持(如:map)不支持

配置文件yml还是properties他们都能获取到值;

只是在某个业务逻辑中需要获取一下配置文件中的某项值,就使用@Value

专门编写一个JavaBean来和配置文件进行映射,就直接是以哦那个@ConfigurationProperties

3.3 配置文件注入值数据校验

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

    /**
     * <bean class="person">
     *     <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * </bean>
     */
    //@Value("${person.last-name}")
    //lastName必须是邮箱格式
    @Email
    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;

3.4 @PropertySource&@ImportResource

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

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

    /**
     * <bean class="person">
     *     <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * </bean>
     */
    //@Value("${person.last-name}")
    //lastName必须是邮箱格式
    //@Email
    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;

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

Spring Boot里面没有Spring的配置文件, 我们自己编写的配置文件,也不能自动识别;

想让Spring的及配置文件生效, 加载进来;@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})
//导入Spring的配置文件让其生效

不来编写Spring的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="https://www.springframework.org/schema/beans"
       xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="https://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="helloService" class="work.idler.springboot.service.HelloService"></bean>
</beans>

Spring Boot推荐给容器中添加组件的方式:推荐使用全注解的方式

  1. 配置类==Spring配置文件
  2. 使用@Bean给容器添加组件
/**
 * @Configuration: 指明当前类是一个配置类;就是来代替之前的Spring配置文件
 *
 * 在配置文件中用<bean></bean>标签添加组件
 */
@Configuration
public class MyAppConfig {

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

4. 配置文件占位符

4.1 随机数

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int(1024.65536)}

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

person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2012/12/12
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=12

5. Profile

5.1 多Profile文件

在主配置文件编写的时候, 文件名可以是 application-.properties/yaml

默认使用application.properties/yaml

5.2 yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: dev

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

---
server:
  port: 8084
spring:
  profiles: prod

5.3 激活指定profile

  1. 在配置文件中指定 spring.profiles.active=dev
  2. 命令行:
    1. java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod
    2. --spring.profiles.active=dev(idea中)
  3. 虚拟机:
    1. -Dspring.profiles.active=dev

6. 配置文件加载位置

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

  • file:/config/
  • file:/
  • classpath:/config/
  • classpath:/

优先级由高到低,高优先级的配置会覆盖低优先级的配置;

SpringBoot会从这四个位置全部加载配置文件;互补配置;

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

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

7.外部配置加载顺序

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

  1. 命令行参数
    1. java -jar xxx.jar --sever.port=8087
  2. 来自java:comp/env的NDI属性
  3. Java系统属性(System.getProperties())
  4. 操作系统环境变量
  5. RandomValuePropertySource配置的random.*属性值
  6. jar包外部的application-.properties或application.yml(带spring.profile)配置文件
  7. jar包内部的application-.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指定的默认属性
  12. 所有支持的配置加载来源

8. 自动配置原理

配置文件到底能写什么?怎么写?自动配置原理:

配置文件能配置的属性参照

8.1自动配置原理

  1. SpringBoot启动的时候加载著配置类,开启了自动配置功能 @EnableAutoConfiguration

  2. @EnableAutoConfiguration 作用

    1. 利用EnableAutoConfigurationImportSelector给容器导入一些组件

    2. 可以插件selectImports()方法的内容;

    3. List configurations = getCandidateConfigurations(annotationMetadata, attrbutes);获取候选的配置

      1. SpringFactoriesLoader.loadFactoryNames()
        //扫描所有jar包路径下  META-INF/spring.factories
        //把扫描到的这些文件的内容装成properties对象
        //从preperties中获取到EnableAutoConfiguration.class类(类名)对应的值, 然后把他们添加在容器中
        
      2. 将类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到容器中;

  3. 每一个自动配置类进行自动配置功能;

  4. HttpEncodingAutoConfiguration为例解释自动配置原理

@Configuration  //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class)  //启动ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingProperties加入到ioc容器中
@ConditionalOnWebApplication  //Spring底层@Conditonal注解,根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效; 判断当前应用是否是web应用,如果是当前配置类生效
@ConditionalOnClass(CharacterEncodingFilter.class)  //判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器;
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)  //判断配置文件是否存在某个配置 spring.http.encoding.enabled; 如果不存在判断也是成立的
//即使我们配置文件中不配置spring.http.encoding.enabled=true,也是默认生效的
public class HttpEncodingAutoConfiguration {
    
    //他已经和SpringBoot的配置文件映射了
    pivate final HttpEncodingProperties properties;
    
    //只有一个有参构造器的情况下,参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
        this.properties = properties;
    }
    
    @Bean  //给容器添加一个组件
    @ConditionalOnMissingBean(CharacterEncodingFilter.class)

根据当前不同条件就判断,决定这个配置类是否生效

一但这个配置类生效; 这个配置类就会给容器中添加各种组件; 这些组件的属性是从对应的properties类中获取的, 这些类里面的每一个属性又是和配置文件绑定的;

  1. 所有在配置文件中能配置的属性都是在xxx.properties类中封装着;配置文件能配置什么就可以参照某个功能对应的这个属性类
@ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpEncodingProperties {
    
    public static final Charset DEFAULT_CHARSET = CHarset.forName("UTF-8");

8.2 精髓

  • SpringBoot启动会加载大量的自动配置类
  • 看需要的功能有没有SpringBoot默认写好的自动配置类
  • 看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,就不需要在配置)
  • 给容器中自动配置类添加组件的时候,会从properties类中获取某些属性, 我们就可以在配置文件中指定这些属性的值;

xxxAutoConfiguration: 自动配置类;

给容器中添加组件

xxxProperties: 封装配置文件中相关属性;

8.3 细节

1.@Conditional派生注解(Spring注解版原生的@Conditional作用)

作用: 必须是@Conditional指定的条件成立,才给容器中添加组件, 配置里面的所有内容才生效;

自动配置类必须在一定条件下才能生效;

怎么知道哪些自动配置类生效:

​ 可以通过启用 debug=true属性; 来让控制台打印自动配置报告, 这样我们就可以很方便的知道哪些自动配置类生效;

=========================
AUTO-CONFIGURATION REPORT
=========================


Positive matches: (自动配置类启用的)
-----------------

   DispatcherServletAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnWebApplication (required) found 'session' scope (OnWebApplicationCondition)
          
Negative matches:(没有启用, 没有匹配成功的自动配置类)
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
支付宝 微信