封面

『Spring Boot系列』—— 2.配置文件

  |     |   本文总阅读量:

Spring Boot帮助我们节省了编写大量配置文件的工作.而这些自动配置离不开它自己封装好的配置文件. 本文记录了下配置文件的常用写法以及配置文件加载的优先级和自动配置的原理

配置文件

springBoot使用一个全局的配置文件,配置文件名固定使用:

  • application.properties
  • application.yml
properties乱码

idea配置乱码

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

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

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

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

配置文件注入值数据校验
1
2
3
4
5
6
7
8
9
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {

//lastName必须是邮箱格式
@Email
//@Value("${person.last-name}")
private String lastName;
@PropertySource&@ImportResource&@Bean
  • @PropertySource:加载指定的配置文件

    @PropertySource(value = {“classpath:person.properties”})

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

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

  • @Bean: SpringBoot推荐给容器中添加组件的方式,使用全注解的方式

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

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

    1
    2
    ${random.value}、${random.int}、${random.long}
    ${random.int(10)}、${random.int[1024,65536]}
  2. 占位符获取之前配置的值

    1
    2
    # : 表示如果前面没指定person.hello ,则默认取hello
    person.dog.name=${person.hello:hello}_dog
Profile
  1. 多个profile文件

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

    默认使用application.properties的配置;

  2. yml支持多文档块方式

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

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

    ---

    server:
    port: 8084
    spring:
    profiles: prod #指定属于哪个环境
  3. 激活指定profile

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

    2、命令行:

    ​ java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar –spring.profiles.active=dev;

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

    3、虚拟机参数:

    ​ -Dspring.profiles.active=dev

配置文件加载位置

加载优先级

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

–file:./config/

–file:./

–classpath:/config/

–classpath:/

优先级由高到底,高优先级的配置会覆盖低优先级的配置;SpringBoot会从这四个位置全部加载主配置文件;互补配置

命令行参数指定配置文件

当我们项目已经发布的时候 如果只有少量的配置文件需要修改, 我们只需要通过命令行参数指定配置文件的方式来重启项目即可.指定配置文件和默认加载的这些配置文件共同起作用形成互补配置

1
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
外部配置加装顺序
  1. 命令行参数

    所有的配置都可以在命令行上进行指定

    java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.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)配置文件

  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指定的默认属性

所有支持的配置加载来源 : 参考官方文档

自动配置原理

源码分析
  1. SpringBoot启动的时候加载主配置类,开启了自动配置功能

    @EnableAutoConfiguration

  2. @EnableAutoConfiguration 作用

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

    查看selectImports()方法的内容

    1
    2
    3
    4
    5
    6
    7
    List<String> configurations = getCandidateConfigurations(annotationMetadata,      attributes);
    获取候选的配置

    SpringFactoriesLoader.loadFactoryNames()
    扫描所有jar包类路径下 META-INF/spring.factories
    把扫描到的这些文件的内容包装成properties对象
    从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,然后把他们添加在容器中
  3. 每一个这样的 xxxAutoConfiguration类都是容器中的一个组件,都加入到容器中;用他们来做自动配置

  4. HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    @Configuration   //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
    @EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingProperties加入到ioc容器中

    @ConditionalOnWebApplication //Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效; 判断当前应用是否是web应用,如果是,当前配置类生效

    @ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器;

    @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled;如果不存在,判断也是成立的
    //即使我们配置文件中不配置pring.http.encoding.enabled=true,也是默认生效的;
    public class HttpEncodingAutoConfiguration {

    //他已经和SpringBoot的配置文件映射了
    private final HttpEncodingProperties properties;

    //只有一个有参构造器的情况下,参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
    this.properties = properties;
    }

    @Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获取
    @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件?
    public CharacterEncodingFilter characterEncodingFilter() {
    CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
    filter.setEncoding(this.properties.getCharset().name());
    filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
    filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
    return filter;
    }
  5. 所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘;配置文件能配置什么就可以参照某个功能对应的这个属性类

    1
    2
    3
    4
    @ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属性进行绑定
    public class HttpEncodingProperties {

    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
@Conditional派生注解

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

@Conditional扩展注解 作用(判断是否满足当前指定条件)
@ConditionalOnJava 系统的java版本是否符合要求
@ConditionalOnBean 容器中存在指定Bean;
@ConditionalOnMissingBean 容器中不存在指定Bean;
@ConditionalOnExpression 满足SpEL表达式指定
@ConditionalOnClass 系统中有指定的类
@ConditionalOnMissingClass 系统中没有指定的类
@ConditionalOnSingleCandidate 容器中只有一个指定的Bean,或者这个Bean是首选Bean
@ConditionalOnProperty 系统中指定的属性是否有指定的值
@ConditionalOnResource 类路径下是否存在指定资源文件
@ConditionalOnWebApplication 当前是web环境
@ConditionalOnNotWebApplication 当前不是web环境
@ConditionalOnJndi JNDI存在指定项

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


赏我 e(=2.72) 元咖啡钱吧,您的支持将鼓励我继续创作!



文章目录
  1. 1. 配置文件
    1. 1.1. properties乱码
    2. 1.2. @Value和@ConfigurationProperties
    3. 1.3. 配置文件注入值数据校验
    4. 1.4. @PropertySource&@ImportResource&@Bean
    5. 1.5. 配置文件占位符
    6. 1.6. Profile
  2. 2. 配置文件加载位置
    1. 2.1. 加载优先级
    2. 2.2. 命令行参数指定配置文件
    3. 2.3. 外部配置加装顺序
  3. 3. 自动配置原理
    1. 3.1. 源码分析
    2. 3.2. @Conditional派生注解
您是第 位小伙伴 | 本站总访问量 | 已经写了 8.6k 字啦 (图片资源存储于又拍云 )

载入天数...载入时分秒...