springboot配置文件、注解、自动配置原理学习笔记（一）

曾经终败给现在 2022-12-19 15:24 202阅读 0赞

# 一、springboot的简单运行原理 #

首先，springboot一定有父项目，就是maven中的pom文件中引入的

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring‐boot‐starter‐parent</artifactId>
        <version>1.5.9.RELEASE</version>
    </parent>

点开该父文件启动器，它主要是有很多依赖构成的

<parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring‐boot‐dependencies</artifactId>
      <version>1.5.9.RELEASE</version>
      <relativePath>../../spring‐boot‐dependencies</relativePath>
    </parent>

他来真正管理Spring Boot应用里面的所有依赖版本；

它也叫做Spring Boot的版本仲裁中心，里边定义着很多该springboot父文件引入的依赖包的版本-properties；

以后我们导入依赖默认是不需要写版本；（没有在dependencies里面管理的依赖自然需要声明版本号）

很多springboot依赖的jar包根据应用的场合和功能被打包成了很多启动器，如web启动器，下边引入web启动器

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring‐boot‐starter‐web</artifactId>
    </dependency>

spring-boot-starter-web：  
spring-boot-starter：spring-boot场景启动器；帮我们导入了web模块正常运行所依赖的组件；  
Spring Boot将所有的功能场景都抽取出来，做成一个个的starters（启动器），只需要在项目里面引入这些starter  
相关场景的所有依赖都会导入进来。要用什么功能就导入什么场景的启动器

主启动类

/**
     *  @SpringBootApplication 来标注一个主程序类，说明这是一个Spring Boot应用
     */
    @SpringBootApplication
    public class HelloWorldMainApplication {
        public static void main(String[] args) {
            // Spring应用启动起来
            SpringApplication.run(HelloWorldMainApplication.class,args);
        }
    }

@SpringBootApplication: Spring Boot应用标注在某个类上说明这个类是SpringBoot的主配置类，SpringBoot  
就应该运行这个类的main方法来启动SpringBoot应用；

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ComponentScan(excludeFilters = {
          @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
          @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
    public @interface SpringBootApplication {

@SpringBootConfiguration:Spring Boot的配置类；  
标注在某个类上，表示这是一个Spring Boot的配置类；  
@Configuration:配置类上来标注这个注解；  
配置类 ----- 配置文件；配置类也是容器中的一个组件；@Component

@EnableAutoConfiguration：开启自动配置功能；  
以前我们需要配置的东西，Spring Boot帮我们自动配置；@EnableAutoConfiguration告诉SpringBoot开启自  
动配置功能；这样自动配置才能生效；

@AutoConfigurationPackage
    @Import(EnableAutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration {

@AutoConfigurationPackage：自动配置包  
@Import(AutoConfigurationPackages.Registrar.class)：  
Spring的底层注解@Import，给容器中导入一个组件；导入的组件由![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70][]

有了自动配置类，免去了我们手动编写配置注入功能组件等的工作；  
SpringFactoriesLoader.loadFactoryNames(EnableAutoConfiguration.class,classLoader)；  
Spring Boot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值，将  
这些值作为自动配置类导入到容器中，自动配置类就生效，帮我们进行自动配置工作；以前我们需要自己配置的东  
西，自动配置类都帮我们；  
J2EE的整体整合解决方案和自动配置都在spring-boot-autoconfigure-1.5.9.RELEASE.jar；

AutoConfigurationPackages.Registrar.class；  
将主配置类（@SpringBootApplication标注的类）的所在包及下面所有子包里面的所有组件扫描到Spring容器；  
@Import(EnableAutoConfigurationImportSelector.class)；  
给容器中导入组件？  
EnableAutoConfigurationImportSelector：导入哪些组件的选择器；  
将所有需要导入的组件以全类名的方式返回；这些组件就会被添加到容器中；  
会给容器中导入非常多的自动配置类（xxxAutoConfiguration）；就是给容器中导入这个场景需要的所有组件，  
并配置好这些组件；

# 二、springboot的配置文件 #

SpringBoot使用一个全局的配置文件，配置文件名是固定的；  
•application.properties  
•application.yml

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

YAML（YAML Ain't Markup Language）  
YAML A Markup Language：是一个标记语言  
YAML isn't Markup Language：不是一个标记语言；  
标记语言：  
以前的配置文件；大多都使用的是 xxxx.xml文件；  
YAML：以数据为中心，比json、xml等更适合做配置文件；  
YAML：配置例子

server:
      port: 8081 #不要使用tab键缩进，冒号后边加空格，属性和值大小写敏感

2、值的写法  
字面量：普通的值（数字，字符串，布尔）  
k: v：字面直接来写；  
字符串默认不用加上单引号或者双引号；  
""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思  
name: "zhangsan \\n lisi"：输出；zhangsan 换行 lisi  
''：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据  
name: ‘zhangsan \\n lisi’：输出；zhangsan \\n lisi

对象、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]

# 三、springboot配置文件的注入 #

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

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>

1、properties配置文件在idea中默认utf-8可能会乱码  
调整

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 1][]

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 2][]

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

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

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

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

4、@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 {
        /**
         * <bean class="Person">
         *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#
    {SpEL}"></property>
         * <bean/>
         */
       //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(locations = \{"classpath:beans.xml"\})  
导入Spring的配置文件让其生效

不来编写Spring的配置文件

<?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();
        }
    }

# 4、配置文件占位符   1、随机数 #

${random.value}、${random.int}、${random.long}
    ${random.int(10)}、${random.int[1024,65536]}
    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

# 5、Profile   1、多Profile文件   我们在主配置文件编写的时候，文件名可以是 application-\{profile\}.properties/yml   默认使用application.properties的配置；   2、yml支持多文档块方式 #

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

# 6、配置文件加载位置 #

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文  
件  
–file:./config/  
–file:./  
–classpath:/config/  
–classpath:/  
优先级由高到底，高优先级的配置会覆盖低优先级的配置；  
server:  
  port: 8081  
spring:  
  profiles:  
    active: prod  
‐‐‐  
server:  
  port: 8083  
spring:  
  profiles: dev  
‐‐‐  
server:  
  port: 8084  
spring:  
  profiles: prod  \#指定属于哪个环境  
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.命令行参数  
所有的配置都可以在命令行上进行指定  
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.\*属性值  
由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指定的默认属性  
所有支持的配置加载来源；

# 8、自动配置原理 #

配置文件到底能写什么？怎么写？自动配置原理；

1、自动配置原理：  
1）、SpringBoot启动的时候加载主配置类，开启了自动配置功能 @EnableAutoConfiguration  
2）、@EnableAutoConfiguration 作用：  
利用EnableAutoConfigurationImportSelector给容器中导入一些组件？  
可以查看selectImports()方法的内容；  
List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置

![20201108193555258.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 3][]

每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；  
3）、每一个自动配置类进行自动配置功能；  
4）、以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

@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;        
    }

根据当前不同的条件判断，决定这个配置类是否生效？  
一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取  
的，这些类里面的每一个属性又是和配置文件绑定的；  
5）、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘；配置文件能配置什么就可以参照某个功  
能对应的这个属性类

@ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属
    性进行绑定
    public class HttpEncodingProperties {
       public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");

精髓：  
1）、SpringBoot启动会加载大量的自动配置类  
2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；  
3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）  
4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这  
些属性的值；  
xxxxAutoConfigurartion：自动配置类；  
给容器中添加组件

xxxxProperties:封装配置文件中相关属性；  
2、细节  
1、@Conditional派生注解（Spring注解版原生的@Conditional作用）  
作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 4][]

自动配置类必须在一定的条件下才能生效；  
我们怎么知道哪些自动配置类生效；  
我们可以通过启用 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 StandardServletEnvironment
    (OnWebApplicationCondition)
           
       
    Negative matches:（没有启动，没有匹配成功的自动配置类）
    ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
       ActiveMQAutoConfiguration:
          Did not match:
             ‐ @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory',
    'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
       AopAutoConfiguration:
          Did not match:
             ‐ @ConditionalOnClass did not find required classes
    'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70]: /images/20221120/28f6cf54d8514623a7bae04e8798d8eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 1]: /images/20221120/919ba391cc4c49eba809aa1920d43a8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 2]: /images/20221120/0d86dae6e03444beb34e580694873905.png
[20201108193555258.png]: /images/20221120/1445810300ff404cbd76b428b95cc57b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 3]: /images/20221120/1f103208f53e41e1b4bac4f5e6336600.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 4]: /images/20221120/e841197648894738bf2683a4623ea649.png