• SpringBoot自动配置的原理篇，剖析自动配置原理；实现自定义启动类！附有代码及截图详细讲解

    SpringBoot 自动配置

    Condition

    Condition 是在Spring 4.0 增加的条件判断功能，通过这个可以功能可以实现选择性的创建 Bean 操作

    思考：SpringBoot是如何知道要创建哪个Bean的？比如SpringBoot是如何知道要创建RedisTemplate的？

    演示1:
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
1. 没有添加坐标前，发现为空，报错
    ConfigurableApplicationContext context =
    SpringApplication.run(SpringbootCondition01Application.class, args);
    Object redisTemplate = context.getBean("redisTemplate");
    System.out.println(redisTemplate);
2. 有添加坐标前，发现有对象
    ConfigurableApplicationContext context =
    SpringApplication.run(SpringbootCondition01Application.class, args);
    Object redisTemplate = context.getBean("redisTemplate");
    System.out.println(redisTemplate);
疑问，他怎么知道的配置哪个类案例1：

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16

    案例1：

    Spring的IOC容器中有一个User的Bean现要求：导入Jedis坐标后，加载该Bean，没导入，则不加载

    代码实现：

    1. POJO实体类：User

      public class User {
}

      • 1
      • 2

    2. 现在对User的加载有条件，不能直接用@Component注入，需要写配置类通过@Bean的方式注入

      @Configuration
public class UserConfig {
    @Bean
    @Conditional(value = ClassCondition.class)    // 注入条件
    public User user(){
        return  new User();
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8

      @Conditional中的ClassCondition.class的matches方法，返回true执行以下代码，否则反之

    3. 创建ClassCondition类实现Condition接口，重写matches方法

      public class ClassCondition implements Condition {
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    boolean falg = true;
    try {
      Class<?> cls = Class.forName("redis.clients.jedis.Jedis");
    } catch (ClassNotFoundException e) {
      falg=false;
    }
    return falg;
  }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12

    4. 启动类：

      @SpringBootApplication
public class SpringbootCondition01Application {
  public static void main(String[] args) {
    //启动SpringBoot的应用，返回Spring的IOC容器
    ConfigurableApplicationContext context = SpringApplication.run(SpringbootCondition01Application.class,args);
    
    //获取Bean，redisTemplate
    //情况1 没有添加坐标前，发现为空
    //情况2 有添加坐标前，发现有对象
    Object user = context.getBean("user");
    System.out.println(user);
  }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13

    5. 测试，通过pom文件中对Jedis坐标是否注释

      1. Jedi坐标未注释，可以打印出User对象地址

      2. Jedis坐标被注释掉，报错，不打印User对象地址

    案例二：

    在 Spring 的 IOC 容器中有一个 User 的 Bean，现要求：将类的判断定义为动态的。判断哪个字节码文件存在可以动态指定

    实现步骤：

    1. 不使用@Conditional(ClassCondition.class)注解
    2. 自定义注解@ConditionOnClass,因为他和之前@Conditional注解功能一直，所以直接复制
    3. 编写ClassCondition中的matches方法

    代码实现：

    1. POJO实体类User和案例1相同

    2. User的注入条件需要改变，使用@ConditionOnClass

      @Configuration
public class UserConfig {
    @Bean
//    @ConditionOnClass(value = "redis.clients.jedis.Jedis")  有jedis坐标注入User
    @ConditionOnClass(value = {"redis.clients.jedis.Jedis","com.alibaba.fastjson.JSON"})  //jedis和json都有才注入 
    public User user(){
        return new User();
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9

    3. 重写matches方法

      public class ClassCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Map<String, Object> map = metadata.getAnnotationAttributes(ConditionOnClass.class.getName());
        System.out.println("map:"+map);
        String[] value = (String[]) map.get("value");

        boolean isok = true;
        try {
            for(String val : value){
                Class<?> cls = Class.forName(val);
            }
        }catch (ClassNotFoundException e){
            isok = false;
        }
        return isok;
    }
}

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

    4. 自定义注解

      @Target({ElementType.TYPE,ElementType.METHOD})//可以修饰在类与方法上
@Retention(RetentionPolicy.RUNTIME)//注解生效节点runtime
@Documented//生成文档
@Conditional(value = ClassCondition.class)
public @interface ConditionOnClass {
    String[] value(); //设置此注解的属性redis.clients.jedis.Jedis
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7

    5. 启动类

      @SpringBootApplication
public class SpringbootCondition02Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootCondition02Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8

    6. 测试：通过pom文件中的Jedis和JSON坐标测试

      • Jedis和JSON坐标都有：打印User对象地址
      • 只有一个坐标或者都没有：报错，不打印User对象地址

    Condition总结

    自定义条件：

    1. 定义条件类：自定义类实现Condition接口，重写 matches 方法，在 matches 方法中进行逻辑判断，返回boolean值 。matches 方法两个参数：
      • context：上下文对象，可以获取属性值，获取类加载器，获取BeanFactory等。
      • metadata：元数据对象，用于获取注解属性。
    2. 判断条件： 在初始化Bean时，使用 @Conditional(条件类.class)注解

    SpringBoot提供的常用条件注解：

    一下注解在springBoot-autoconfigure的condition包下

    1. ConditionalOnProperty：判断配置文件中是否有对应属性和值才初始化Bean
    2. ConditionalOnClass：判断环境中是否有对应字节码文件才初始化Bean
    3. ConditionalOnMissingBean：判断环境中没有对应Bean才初始化Bean
    4. ConditionalOnBean：判断环境中有对应Bean才初始化Bean

    @Enable注解

    SpringBoot中提供了很多Enable开头的注解，这些注解都是用于动态启用某些功能的。而其底层原理是使用@Import注 解导入一些配置类，实现Bean的动态加载

    思考 SpringBoot 工程是否可以直接获取jar包中定义的Bean？

    @Enable的底层核心：@Import

    @Enable底层依赖于@Import注解导入一些类，使用@Import导入的类会被Spring加载到IOC容器中。而@Import提供4中用法：

    1. 导入Bean
    2. 导入配置类
    3. 导入 ImportSelector 实现类。一般用于加载配置文件中的类
    4. 导入 ImportBeanDefinitionRegistrar 实现类

    导入Bean

    代码实现：

    需要用到多模块编程，项目结构如图：

    在这里插入图片描述

    springboot_enable_02：

    1. springboot项目，pom文件不需要格外到坐标

    2. User

      public class User {
}

      • 1
      • 2

    3. UserConfig

      @Configuration
public class UserConfig {
    @Bean
    public User user(){
        return new User();
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7

    4. EnableUser自定义注解

      @Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(UserConfig.class)
public @interface EnableUser {
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6

    5. 启动类

      @SpringBootApplication
public class SpringbootEnable02Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootEnable02Application.class, args);
        Object user = context.getBean("user");   // enable_02中肯定能取到User
        System.out.println(user);
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8

    springboot_enable_01：

    1. pom文件导入springboot_enable_02的gav：

      <dependency>
  <groupId>org.springframework.bootgroupId>
  <artifactId>spring-boot-starter-webartifactId>
dependency>

<dependency>
  <groupId>org.springframework.bootgroupId>
  <artifactId>spring-boot-starter-testartifactId>
  <scope>testscope>
dependency>


<dependency>
  <groupId>com.donggroupId>
  <artifactId>springboot_enable_02artifactId>
  <version>0.0.1-SNAPSHOTversion>
dependency>

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

    2. 测试：

      //@Import(User.class)
//@Import(UserConfig.class)
//@EnableUser
@ComponentScan("com.dong.springboot_enable_02.config")
@SpringBootApplication
public class SpringbootEnable01Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootEnable01Application.class, args);
        Object user = context.getBean(User.class);
        System.out.println(user);
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12

      因为enable_01导如了enable_02的坐标，相当是把02的所有代码拷贝在与01的启动类同级目录下，如果包名和包的层级都相同，就可以直接装配User类，但是包的层级不同就必须加注解

      • @Import(User.class)：对应第一个使用场景

        ​ 导入02中的User类

      • @Import(UserConfig.class)：对应第二个使用场景

        ​ 加载02中的UserConfig配置类，加载配置类中所有的方法和类

      • @EnableUser：

        ​ 自定义的注解，包装了一个@Import(User.class)

      • @ComponentScan(“com.dong.springboot_enable_02.config”)：

        ​ 扫描包，加载类和配置类

    导入配置类

    见上方示例的@Import(UserConfig.class)，导入配置类加载配置类中所有的方法和类

    导入ImportSelector 实现类

    导入 ImportBeanDefinitionRegistrar 实现类

    ImportSelector 和 ImportBeanDefinitionRegistrar 一起演示

    代码实现：

    ​ 项目结构
    在这里插入图片描述

    springboot_enable_04

    1. springboot项目，pom文件不需要额外到坐标

    2. POJO

      实体类：User

      public class User {
}

      • 1
      • 2

      Student

      public class Student {
}

      • 1
      • 2

    3. UserConfig配置类

      @Configuration
public class UserConfig {
    @Bean
    public User user(){
        return  new User();
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7

    4. MyImportSelector

      public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.dong.springboot_enable_04.pojo.User","com.dong.springboot_enable_04.pojo.Student"};
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6

    5. MyImportBeanDefinitionRegistrar

      public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();
        registry.registerBeanDefinition("user1",beanDefinition);
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7

    springboot_enable_03

    1. springboot_enable_03pom文件导入springboot_enable_04坐标

      <dependencies>
  <dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webartifactId>
  dependency>

  <dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-testartifactId>
    <scope>testscope>
  dependency>
	
  <dependency>
    <groupId>com.donggroupId>
    <artifactId>springboot_enable_04artifactId>
    <version>0.0.1-SNAPSHOTversion>
  dependency>
dependencies>

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

    2. 测试：启动类

      @ComponentScan("com.dong.springboot_enable_04.config")
@Import(User.class)
@Import(UserConfig.class)
@Import(MyImportSelector.class)
@Import(MyImportBeanDefinitionRegistrar.class)
@SpringBootApplication
public class SpringbootEnable03Application {
  public static void main(String[] args) {
    ConfigurableApplicationContext context = SpringApplication.run(SpringbootEnable03Application.class, args);
    User user = context.getBean(User.class);
    System.out.println(user);

    Student student = context.getBean(Student.class);
    System.out.println(student);

    User user1 = (User) context.getBean("user1");
    System.out.println(user1);
  }
}

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

      • @Import(MyImportSelector.class)：对应第三个使用场景

        ​ MyImportSelector实现了ImportSelector接口，重写了selectImports方法，在字符出数组中的完全相对路径即注入了容器，因为引入了enable_04，所以03中可以获取到User和Student

      • @Import(MyImportBeanDefinitionRegistrar.class)：对应第四个使用场景

        ​ MyImportBeanDefinitionRegistrar实现了ImportBeanDefinitionRegistrar接口，registerBeanDefinitions方法，在此方法中就可以对Bean进行注册，如案例演示，04注入了一个User对象，id是user1，所以03中就可以获取到User这个对象，打印出地址

    @EnableAutoConfiguration注解

    • 主启动类

      //@SpringBootApplication 来标注一个主程序类
//说明这是一个Spring Boot应用
@SpringBootApplication
public class SpringbootApplication {
  public static void main(String[] args) {
    //以为是启动了一个方法，没想到启动了一个服务
    SpringApplication.run(SpringbootApplication.class, args);
  }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9

    • @SpringBootApplication注解内部

      @SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
// ......
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14

      1. @ComponentScan

        这个注解在Spring中很重要 ,它对应XML配置中的元素。

        作用：自动扫描并加载符合条件的组件或者bean ， 将这个bean定义加载到IOC容器中

      2. @SpringBootConfiguration

        作用：SpringBoot的配置类 ，标注在某个类上 ， 表示这是一个SpringBoot的配置类；

        //@SpringBootConfiguration注解内部
//这里的 @Configuration，说明这是一个配置类 ，配置类就是对应Spring的xml 配置文件；
@Configuration
public @interface SpringBootConfiguration {}
//里面的 @Component 这就说明，启动类本身也是Spring中的一个组件而已，负责启动应用
@Component
public @interface Configuration {}

        • 1
        • 2
        • 3
        • 4
        • 5
        • 6
        • 7

    • AutoConfigurationPackage ：自动配置包

      //AutoConfigurationPackage的子注解
//Registrar.class 作用：将主启动类的所在包及包下面所有子包里面的所有组件扫描到Spring容器
@Import({Registrar.class})
public @interface AutoConfigurationPackage {
}

      • 1
      • 2
      • 3
      • 4
      • 5

    • @EnableAutoConfiguration开启自动配置功能

      以前我们需要自己配置的东西，而现在SpringBoot可以自动帮我们配置 ；@EnableAutoConfiguration告诉SpringBoot开启自动配置功能，这样自动配置才能生效；

      @Import({AutoConfigurationImportSelector.class})：给容器导入组件 ；

      AutoConfigurationImportSelector ：自动配置导入选择器，给容器中导入一些组件

    AutoConfigurationImportSelector.class
					↓
		selectImports方法
					↓
this.getAutoConfigurationEntry(annotationMetadata)方法
					↓
this.getCandidateConfigurations(annotationMetadata, attributes)方法
					↓
方法体：
		List<String> configurations =
SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass
(), this.getBeanClassLoader());
		Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
return configurations;
					↓
在所有包名叫做autoConfiguration的包下面都有META-INF/spring.factories文件

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16

    总结原理：

    • @EnableAutoConfiguration 注解内部使用 @Import(AutoConfigurationImportSelector.class)

      来加载配置类。

    • 配置文件位置：META-INF/spring.factories，该配置文件中定义了大量的配置类，当 SpringBoot

      应用启动时，会自动加载这些配置类，初始化Bean

    • 并不是所有的Bean都会被初始化，在配置类中使用Condition来加载满足条件的Bean

    SpringBoot自动配置原理扒源代码图解

    在这里插入图片描述

    自定义启动类的实现

    案例需求：

    自定义redis-starter，要求当导入redis坐标时，SpringBoot自动创建Jedis的Bean

    参考：

    可以参考mybatis启动类的应用

    在这里插入图片描述

    实现步骤：

    1. 创建redis-spring-boot-autoconfigure模块
    2. 创建redis-spring-boot-starter模块,依赖redis-spring-boot-autoconfigure的模块
    3. 在redis-spring-boot-autoconfigure模块中初始化Jedis的Bean，并定义META-INF/spring.factories文件
    4. 在测试模块中引入自定义的redis-starter依赖，测试获取Jedis的Bean，操作redis

    代码实现演示：

    ​ 目录结构

    • redis-spring-boot-autoconfigure模块

      1. pom文件

        <dependencies>
  <dependency>
    <groupId>redis.clientsgroupId>
    <artifactId>jedisartifactId>
  dependency>
  <dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starterartifactId>
  dependency>
  
deendencies>

        • 1
        • 2
        • 3
        • 4
        • 5
        • 6
        • 7
        • 8
        • 9
        • 10
        • 11

      2. RedisAutoConfiguration配置类

        @Configuration
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {
    @Bean
    public Jedis jedis(RedisProperties redisProperties){
        return new Jedis(redisProperties.getHost(),redisProperties.getPort());
    }
}

        • 1
        • 2
        • 3
        • 4
        • 5
        • 6
        • 7
        • 8

      3. 动态获取主机号和端口号的类

        @ConfigurationProperties(prefix = "spring.redis")  
//如果配置文件中有就读取配置文件中的spring.redis下面get、set方法就会对host和port达到动态效果，如果配置文件中没有spring.redis就默认localhost和6379
public class RedisProperties {
    private String host="localhost";
    private int port=6379;
    public String getHost() {
        return host;
    }
    public void setHost(String host) {
        this.host = host;
    }
    public int getPort() {
        return port;
    }
    public void setPort(int port) {
        this.port = port;
    }
}

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

      4. 在resources目录下创建META-INF文件夹，下创建spring.factories文件，写入键值

        org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.dong.redisspringbootautoconfigure.config.RedisAutoConfiguration

        • 1
        • 2

    • redis-spring-boot-start模块

      此模块只需要在pom文件中导入上个模块的gav，test文件夹和java下的目录都可以删除

      <dependencies>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starterartifactId>
    dependency>

    
    <dependency>
        <groupId>com.donggroupId>
        <artifactId>redis-spring-boot-autoconfigureartifactId>
        <version>0.0.1-SNAPSHOTversion>
    dependency>
dependencies>

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13

    • 测试模块springboot_enable_05

      1. pom文件导入redis-spring-boot-start模块gav

        <dependencies>
  <dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-webartifactId>
  dependency>
  <dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-testartifactId>
    <scope>testscope>
  dependency>
  
  <dependency>
    <groupId>com.donggroupId>
    <artifactId>redis-spring-boot-startartifactId>
    <version>0.0.1-SNAPSHOTversion>
  dependency>
dependencies>

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

      2. yaml配置文件修改端口

        spring:
  redis:
    port: 6060

        • 1
        • 2
        • 3

      3. 测试：

        @SpringBootApplication
public class SpringbootEnable05Application {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootEnable05Application.class, args);
        Jedis bean = context.getBean(Jedis.class);
        System.out.println(bean);
    }
}

        • 1
        • 2
        • 3
        • 4
        • 5
        • 6
        • 7
        • 8

        输出内容：BinaryJedis{Connection{DefaultJedisSocketFactory{localhost:6060}}}

        说明走了我们自定义的启动器

  • 相关阅读:
    JS进阶-变量和函数提升
    RedisSyncer 中采用链式策略处理同步数据
    Java学习07——原码、反码和补码
    VUE+Layui 输入框、下拉选择框、复选框、开关、文本域 数据回显
    抖音短视频账号矩阵seo分发系统--开发源代
    玄幻小说阵法大全—— 网文助手
    基于Java+SpringBoot+Thymeleaf+Mysql在线外卖点餐系统设计与实现
    【Unity】【C#】【VS】如何将VS写的通用C#窗体程序修改为Unity程序
    Python Flask Web开发二：数据库创建和使用
    十七、完整神经网络模型训练步骤
  • 原文地址：https://blog.csdn.net/HakerDONG/article/details/134323112