Spring Boot - 自动装配中的不可忽视的@Import

最新推荐文章于 2024-08-16 00:41:45 发布
最新推荐文章于 2024-08-16 00:41:45 发布
阅读量1.8w 收藏 32
点赞数 5
分类专栏： 【Spring Boot2.X】 文章标签： Import springboot自动装配
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yangshangwei/article/details/117147729
版权

文章目录


在这里插入图片描述

Pre

Spring Boot - 自动配置实现原理

四种处理方式

在使用 Spring Boot 时，@Import 也是一个非常常见的注解，可以用来动态创建 Bean。

在 @Import 注解的属性中可以设置需要引入的类名，例如 @AutoConfigurationPackage 注解上的 @Import(AutoConfigurationPackages.Registrar.class)。根据该类的不同类型，Spring 容器针对 @Import 注解有以下四种处理方式：

  • 如果该类实现了 ImportSelector 接口，Spring 容器就会实例化该类，并且调用其 selectImports 方法；
  • 如果该类实现了 DeferredImportSelector 接口，则 Spring 容器也会实例化该类并调用其 selectImports方法。DeferredImportSelector 继承了 ImportSelector，区别在于 DeferredImportSelector 实例的 selectImports 方法调用时机晚于 ImportSelector 的实例，要等到 @Configuration 注解中相关的业务全部都处理完了才会调用；
  • 如果该类实现了 ImportBeanDefinitionRegistrar 接口，Spring 容器就会实例化该类，并且调用其 registerBeanDefinitions 方法；
  • 如果该类没有实现上述三种接口中的任何一个，Spring 容器就会直接实例化该类。

我们来搞一搞@Import吧

从@SpringBootApplication注解说起

我们都知道 启动一个SpringBoot应用 无须各种的配置文件，无须各种繁杂的pom依赖，一个main方法，就能run起来了。

与其他框架整合也相当方便，使用EnableXXXXX注解就可以完成整合

那SpringBoot是如何实现自动配置的？？？？

在这里插入图片描述

@SpringBootApplication组合注解说明

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

在这里插入图片描述

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited

注解说明：

  • @Target(ElementType.TYPE) 设置当前注解可以标记在哪
  • @Retention(RetentionPolicy.RUNTIME) 当注解标注的类编译以什么方式保留。 RetentionPolicy.RUNTIME 会被jvm加载
  • @Documented java doc 会生成注解信息
  • @Inherited 是否会被继承

更详细的请参考我以前写的一篇博文： Java-Java5.0注解解读

在这里插入图片描述

@SpringBootConfiguration

Spring Boot的配置类 ， 标注在某个类上，表示这是一个Spring Boot的配置类

@EnableAutoConfiguration

开启自动配置功能 ， @EnableAutoConfiguration告诉SpringBoot开启自动配置，会自动去加载自动配置类

@ComponentScan

相当于在spring.xml 配置中<context:comonent-scan> 但是并没有指定basepackage，如果没有指定spring底层会自动扫描当前配置类所有在的包

@EnableAutoConfiguration

SpringBootApplication注解中最重要的一个注解就是 @EnableAutoConfiguration.

在这里插入图片描述

@AutoConfigurationPackage

将当前配置类所在包保存在BasePackages的Bean中。供Spring内部使用

在这里插入图片描述

使用了@Import注解 保存扫描路径， 注册

那看下 org.springframework.boot.autoconfigure.AutoConfigurationPackages.Registrar

在这里插入图片描述

@Import(AutoConfigurationImportSelector.class)

关键点！

可以看到，在@EnableAutoConfiguration注解内也使用到了@Import注解来完成导入配置的功能

那都用它，我们来搞搞@Import吧

在这里插入图片描述

@Import源码

在这里插入图片描述
@Import表示要导入的一个或多个@Configuration类

我们来看下value方法源码中的注释： Configuration，ImportSelector，ImportBeanDefinitionRegistrar 或者是一个普通的组件

那分别来看下如何使用吧

在这里插入图片描述

POM 核心 有个context就够了

  <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.18</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.2.6.RELEASE</version>
        </dependency>
    </dependencies>

@Import 普通组件

@Import（{ 要导入的组件 } ）

【模拟第三方框架提供的】

package com.artisan.configuration;


import com.artisan.beans.Artisan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author 小工匠
 * @version 1.0
 * @description:  自定义的配置类  类比第三方的配置类
 * @date 2021/5/22 8:50
 * @mark: show me the code , change the world
 */


@Configuration
public class ArtisanConfig {

    @Bean
    public Artisan artisan() {
        Artisan artisan = new Artisan();
        artisan.setName("小工匠");
        artisan.setAge(18);
        return artisan;
    }
}

【模拟Spring自己的】

/**
 * 系统当前加载的配置类
 */

@Configuration
@Import({ArtisanConfig.class})
// @Import(ArtisanImportSelector.class)
//@Import(ArtisanRegistrar.class)
//@EnableArtisan
public class AppConfig {
}

将AppConfig.java添加注解 @Import({ArtisanConfig.class}) ， 将第三方的配置类导入到Bean容器中 ， 本质上就是导入 一个Configuration配置类组件

【测试类】

public class Main {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);

        Artisan artisan =  ctx.getBean(Artisan.class);
        System.out.println(artisan);
    }
}

【测试结果】
在这里插入图片描述

@Import 实现了ImportSelector接口的组件 (类的全限定类名)

【ImportSelector接口 返回全限定名】

package com.artisan.impt;

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

/**
 * @author 小工匠
 * @version 1.0
 * @description: TODO
 * @date 2021/5/22 9:25
 * @mark: show me the code , change the world
 */
public class ArtisanImportSelector implements ImportSelector {


    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        return new String[]{"com.artisan.beans.Artisan"};
    }
}

【AppConfig - @Import(ArtisanImportSelector.class)】

/**
 * 系统当前加载的配置类
 */

@Configuration
//@Import({ArtisanConfig.class})
 @Import(ArtisanImportSelector.class)
//@Import(ArtisanRegistrar.class)
//@EnableArtisan
public class AppConfig {
}

测试

在这里插入图片描述

ArtisanSelector返回的类的全限定类名，即为导入到容器中的组件全类名

@Import 实现了ImportBeanDefinitionRegistrar接口的组件

【ImportBeanDefinitionRegistrar 接口】

package com.artisan.impt;

import com.artisan.beans.Artisan;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

/**
 * @author 小工匠
 * @version 1.0
 * @description: TODO
 * @date 2021/5/22 9:28
 * @mark: show me the code , change the world
 */
public class ArtisanRegistrar implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(Artisan.class);
        builder.setScope(BeanDefinition.SCOPE_SINGLETON);
        builder.addPropertyValue("name", "小工匠Registrar");
        builder.addPropertyValue("age", "18");
        registry.registerBeanDefinition("artisan", builder.getBeanDefinition());
    }
}

【AppConfig - @Import(ArtisanRegistrar.class) 】

/**
 * 系统当前加载的配置类
 */

@Configuration
//@Import({ArtisanConfig.class})
// @Import(ArtisanImportSelector.class)
@Import(ArtisanRegistrar.class)
//@EnableArtisan
public class AppConfig {
}

【测试】
在这里插入图片描述

ImportBeanDefinitionRegistrar类似于ImportSelector用法，只不过这种用法能自定义化注册，往容器内注入一个BeanDefinition，然后BeanDeiniton在容器内转为一个实例bean。

在这里插入图片描述

最佳实践 @EnableXXX

【自定义注解 @EnableArtisan】

package com.artisan.annotation;


import com.artisan.configuration.ArtisanConfig;
import com.artisan.impt.ArtisanImportSelector;
import com.artisan.impt.ArtisanRegistrar;
import org.springframework.context.annotation.Import;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented

// @Import({ArtisanConfig.class})   @Import({ArtisanImportSelector.class})  都可以
@Import({ArtisanRegistrar.class})
public @interface EnableArtisan {


}

将AppConfig.java添加@EnableArtisan

在这里插入图片描述

【测试结果】

在这里插入图片描述

在这里插入图片描述

源码

https://github.com/yangshangwei/boot2/tree/master/spring_maven

在这里插入图片描述

小小工匠
关注
专栏目录
Seata 整合多数据源dynamic-datasource-spring-boot-starter | Spring Cloud 60
gmHappy
06-30 1万+
在这篇文章中，我们使用Seata整合一下多数据源的场景。多数据源切换的功能我们使用`dynamic-datasource-spring-boot-starter`来完成，并且这个组件还可以和`Seata`进行整合，实现数据源的代理。
【面试必问】彻底搞懂Spring Boot自动装配原理及自定义starter
zyq8514700的博客
07-16 4897
【ANYTHING &WHY序言】 面试官：说一下Spring boot和Spring的区别 小白：没用过Spring 面试官：那为什么选型要选择Spring Boot而不是Spring Framework呢？ 小白：（架构师选的，我哪知道为啥...）因为Spring Boot能完全兼容Spring，并且提供了减少开发工作量的核心特性 面试官：好，那说一下Spring Boo...
详细解读Spring Boot中@Import三种使用方式
wdj_yyds的博客
11-23 1064
Import是一个非常有用的注解，它的长处在于你可以通过配置来控制是否注入该Bean，也可以通过条件来控制注入哪些Bean到Spring容器中。、、等等统一采用的都是借助@Import注解来实现的。下面我们就通过示例来了解@Import三种用法！
总结：Springboot注解之@Import
w2009211777的专栏
03-29 504
一、介绍 在平时看源码或者很多配置类上面都会出现@Import注解，作用是用来导入配置类或者一些需要前置加载的类。 @Import支持 三种方式 1、普通类 2、带有@Configuration的配置类 3、ImportSelector 的实现 4、ImportBeanDefinitionRegistrar 的实现 二、普通类导入 新建一个TestA public class TestA { public void fun(String str) { System.
Springboot中@Import(AutoConfigurationImportSelector.class)
最新发布
weixin_42583591的博客
08-16 234
因此，@Import(AutoConfigurationImportSelector.class)在Spring Boot中的意思是：在Spring Boot应用程序的自动配置阶段，使用AutoConfigurationImportSelector来动态地导入一组符合条件的自动配置类。总的来说，@Import(AutoConfigurationImportSelector.class)是Spring Boot自动配置机制的核心之一，它使得Spring Boot能够根据项目的需求和环境自动地配置应用程序。
Springboot的@import
a3337779的博客
08-05 219
Import注解，顾名思义，导入，即把类加入Spring IOC容器。有多种方式能让类加IOC容器管理，如@Bean、@Component等，@Import是另外一种方式，更加快捷。
SpringBoot @Import
m0_37732829的博客
07-11 845
SpringBoot 的 @Import 用于将指定的类实例注入之Spring IOC Container中。 A.java(无任何属性和实现) public class A { } B.java(无任何属性和实现) public class B { } ImportDirect.java import com.example.demo.model.A; i...
spring注解版 @Import和ImportSelector
qq_39023116的博客
10-18 2297
根据我简单的理解，@Import放类上面貌似只能引入一些无参组件但是比起@bean方便之处就是一个注解可以引入多个还不用写方法。比如： @Import({ZhangSan.class,LiSi.class,WangWu.class}) public class MainConfig { } 一下就引入三个组件，简洁明了。   ImportSelector强调的是复用性，使用它需要自建一...
spring-boot-project:spring-boot原始解析-源码解析
03-24
spring-boot-import-sample导入实现模块 spring-boot-alias-annotation-sample注解属性别名模块 spring-boot-actuator-sample监控组件模块 spring-boot-enable-sample自动装配模块 formatter-spring-boot-starter-...
Spring Boot面试杀手锏————自动配置原理
热门推荐
Morty的技术乐园
11-07 19万+
引言 不论在工作中，亦或是求职面试，Spring Boot已经成为我们必知必会的技能项。除了某些老旧的政府项目或金融项目持有观望态度外，如今的各行各业都在飞速的拥抱这个已经不是很新的Spring启动框架。 当然，作为Spring Boot的精髓，自动配置原理的工作过程往往只有在“面试”的时候才能用得上，但是如果在工作中你能够深入的理解Spring Boot的自动配置原理，将无往不利。 Spr...
谈谈spring boot里的@import
flyforlove的专栏
03-09 311
使用spring boot时，如果想自己实现一些初始设置比较复杂的bean时，可以在类上用@Configuration注解，然后类内部在返回具体bean的方法上使用@Bean注解。 那么如何让容器找到这个配置类呢？   1.最简单的方法，当然是把它放到程序可以扫描到的package里，也就是@ComponentScan注解所指定的package里。    平时自己创建的配置类通常用这种方...
如果不懂，就去搞懂——Spring Boot中的@Import
qq_52496081的博客
12-09 441
Spring Boot中的@Import
【SpringBoot】@import注解的原理
后端研发工程师Marion的博客
08-30 403
一、参考资料 @Import注解的作用
SpringBoot 注解 @Import 的原理-ConfigurationClassPostProcessor 源码解析
谈谈1974
07-01 2128
文章目录1. @Import 详解1.1 @Import 的作用1.2 @Import 的使用方式2. @Import 注册目标类的流程 1. @Import 详解 1.1 @Import 的作用 1.2 @Import 的使用方式 2. @Import 注册目标类的流程
springboot自动装配@Import原理
路人甲的博客
01-01 2202
springboot启动main方法中都会加@SpringBootApplication这个注解，就把这个注解作为入口，研究下springboot自动装配的原理。 springboot使用的版本号是2.2.1.RELEASE 文章目录@SpringBootApplication@EnableAutoConfiguration@AutoConfigurationPackage@Import@Im...
SpringBoot @Import 详解
tuonioooo
05-06 1万+
SpringBoot 的 @Import 用于将指定的类实例注入之Spring IOC Container中。SpringBoot 提供了 三种使用 @Import 将 类实例注入至 Spring IOC Container中 的实例。直接注入实现 ImportBeanDefinitionRegistrar 接口 注入实现 ImportSelector 注入直接注入Broker.java(无任何...
SpringBoot之@Import详解
NestorBian的博客
09-16 818
SpringBoot之@Import详解 前言 SpringBoot 的 @Import 用于选择性地将指定的类实例注入之Spring IOC容器中。一般使用场景:针对依赖包，选择性地将一些类加载到当前容器，或者根据一些具体场景选择性的加载一些你想要的类到当前容器。 SpringBoot 提供了三种使用 @Import 将 类实例注入至 Spring IOC Container中 的实例。 直接注入 实现 ImportSelector 注入 实现 ImportBeanDefinitionRegistrar
spring-boot-starter-data-redis 如何自动装配
01-17
根据提供的引用内容，spring-boot-starter-data-redis是Spring Boot中用于自动装配Redis的starter包。它包含了自动装配所需的类和注解等。当我们在项目的pom.xml文件中引入spring-boot-starter-data-redis包时，Spring Boot会自动根据配置文件中的相关配置信息来完成Redis的自动装配。 具体来说，spring-boot-starter-data-redis使用了RedisAutoConfiguration类来实现自动装配。该类通过读取配置文件中的相关配置信息，例如主机名、端口号、密码等，来创建Redis连接工厂和RedisTemplate等实例。这些实例可以在应用程序中直接使用，而无需手动配置和初始化。 下面是一个示例代码，展示了如何使用spring-boot-starter-data-redis进行自动装配： ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.data.redis.core.RedisTemplate; @SpringBootApplication public class RedisApplication { private final RedisTemplate<String, String> redisTemplate; public RedisApplication(RedisTemplate<String, String> redisTemplate) { this.redisTemplate = redisTemplate; } public static void main(String[] args) { SpringApplication.run(RedisApplication.class, args); } // 在需要使用Redis的地方，可以直接注入RedisTemplate实例，并进行操作 // 例如： // redisTemplate.opsForValue().set("key", "value"); // String value = redisTemplate.opsForValue().get("key"); } ``` 通过上述代码，我们可以看到，在Spring Boot应用程序中，我们只需要在需要使用Redis的地方注入RedisTemplate实例，就可以直接使用Redis的相关操作方法。
评论 15
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小小工匠

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值