Spring 注解驱动开发_组件注册-@Import 注解

最新推荐文章于 2024-09-11 14:27:43 发布
最新推荐文章于 2024-09-11 14:27:43 发布
阅读量599 收藏
点赞数
分类专栏： Spring 文章标签： spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/dingd1234/article/details/123751844
版权

一、@Import 注解介绍

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

	/**
	 * value 值可以是 @Configuration注解类，或者 ImportSelector 以及 ImportBeanDifinitionRegistrar 的实现类，或者一些常规的组件类
	 */
	Class<?>[] value();

}
  • @Import 注解可用于导入一个或多个组件类（一般是 @Configuration 类）。
  • @Import 注解提供了与 Spring XML 中的 <limport> 元素等效的功能。允许导入@Configuration 类、ImportSelector 和 ImportBeanDefinitionRegistrar 实现类，以及常规组件类。

二、使用 Import 给容器中快速导入一个组件

创建实体类 Color

package org.example.pojo;

public class Color {
}

创建实体类 Red

package org.example.pojo;

public class Red {
}

创建配置类 ImportTestConfig，使用 @Import 注解向容器中注入 Color 以及 Red 组件

package org.example.config;

import org.example.pojo.Color;
import org.example.pojo.Red;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Import({Color.class, Red.class})
@Configuration
public class ImportTestConfig {
}

测试方法：

@Test
public void testImport(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(ImportTestConfig.class);
    String[] beanDefinitionNames = ac.getBeanDefinitionNames();
    for (String beanDefinitionName : beanDefinitionNames) {
        System.out.println(beanDefinitionName);
    }
}

测试结果：
在这里插入图片描述
通过 @Import 注解成功的将 Color 以及 Red 两个实体类注入到了容器中，其在容器中的 id 默认是实体类的全类名

三、使用 ImportSelector 导入一组组件

3.1 接口定义

ImportSelector 是一个接口，先来看一下这个接口的定义：

public interface ImportSelector {

	/**
	 * 根据导入的 @Configuration 类的 AnnotationMetadata 选择并返回应导入的类的名称。
	 * @return 返回需要导入的类名，如果没有则返回一个空数组
	 */
	String[] selectImports(AnnotationMetadata importingClassMetadata);

	/**
	 * 用于排除某些不需要导入容器的候选类
	 */
	@Nullable
	default Predicate<String> getExclusionFilter() {
		return null;
	}

}

AnnotationMetadata 接口可以用来获取当前标注 @Import 注解的类的所有注解信息。

package org.springframework.core.type;

import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.stream.Collectors;

import org.springframework.core.annotation.MergedAnnotation;
import org.springframework.core.annotation.MergedAnnotations;
import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;

public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata {

	/**
	 * 获取基础类上存在的所有注释类型的完全限定类名。
	 */
	default Set<String> getAnnotationTypes() {
		return getAnnotations().stream()
				.filter(MergedAnnotation::isDirectlyPresent)
				.map(annotation -> annotation.getType().getName())
				.collect(Collectors.toCollection(LinkedHashSet::new));
	}

	/**
	 * 根据给定的注解名获取类上所有的元注解类型
	 */
	default Set<String> getMetaAnnotationTypes(String annotationName) {
		MergedAnnotation<?> annotation = getAnnotations().get(annotationName, MergedAnnotation::isDirectlyPresent);
		if (!annotation.isPresent()) {
			return Collections.emptySet();
		}
		return MergedAnnotations.from(annotation.getType(), SearchStrategy.INHERITED_ANNOTATIONS).stream()
				.map(mergedAnnotation -> mergedAnnotation.getType().getName())
				.collect(Collectors.toCollection(LinkedHashSet::new));
	}

	/**
	 * 确定基础类是否使用了给定类型的注解
	 */
	default boolean hasAnnotation(String annotationName) {
		return getAnnotations().isDirectlyPresent(annotationName);
	}

	/**
	 * 确定基础类是否有一个注释，该注释本身使用给定类型的元注释进行注释。
	 */
	default boolean hasMetaAnnotation(String metaAnnotationName) {
		return getAnnotations().get(metaAnnotationName,
				MergedAnnotation::isMetaPresent).isPresent();
	}

	/**
	 * 确定基础类是否具有使用给定注释类型注释（或元注释）的方法。
	 */
	default boolean hasAnnotatedMethods(String annotationName) {
		return !getAnnotatedMethods(annotationName).isEmpty();
	}

	/**
	 * 获取所有使用给定注释类型注释（或元注释）的所有方法的方法元数据。
	 */
	Set<MethodMetadata> getAnnotatedMethods(String annotationName);


	/**
	 * 使用标准反射为给定类创建新 AnnotationMetadata 实例的工厂方法
	 */
	static AnnotationMetadata introspect(Class<?> type) {
		return StandardAnnotationMetadata.from(type);
	}

}

3.2、案例

创建实体类 Yellow 以及 Blue

Yellow

package org.example.pojo;

public class Yellow {
}

Blue

package org.example.pojo;

public class Blue {
}

通过 @ImportSelector 注解的方式将 Yellow 和 Blue 这两个实体类注入到容器中

实现 ImportSelector 接口

package org.example.condition;

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

import java.util.Set;


public class MyImportSelector implements ImportSelector {
    /**
     * AnnotationMetadata：用于获取当前标注 @Import 注解的类的所有注解信息
     * */
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"org.example.pojo.Blue","org.example.pojo.Yellow"};
    }
}

在配置类 @Import 注解上，新增 MyImportSelector.class

package org.example.config;

import org.example.condition.MyImportSelector;
import org.example.pojo.Color;
import org.example.pojo.Red;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Import({Color.class, Red.class, MyImportSelector.class})
@Configuration
public class ImportTestConfig {
}

测试方法：

@Test
public void testImport(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(ImportTestConfig.class);
    String[] beanDefinitionNames = ac.getBeanDefinitionNames();
    for (String beanDefinitionName : beanDefinitionNames) {
        System.out.println(beanDefinitionName);
    }
}

测试结果：
在这里插入图片描述
根据测试结果可以看出，Blue 和 Yellow 两个实体类已经注册成功。

四、使用 ImportBeanDefinitionRegistrar 导入

4.1 ImportBeanDefinitionRegistrar 接口定义：

public interface ImportBeanDefinitionRegistrar {

	default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry,
			BeanNameGenerator importBeanNameGenerator) {

		registerBeanDefinitions(importingClassMetadata, registry);
	}

	/**
	 * 用于注册 beanDifinition
	 * AnnotationMetadata:当前类的注解信息
     * BeanDefinitionRegistry：BeanDifinition注册类
	 */
	default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
	}

}

4.2 案例

实体类 Rainbow

package org.example.pojo;

public class Rainbow {
}

MyImportBeanDefinitionRegistrar 类：

package org.example.condition;

import org.example.pojo.Rainbow;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    /**
     * AnnotationMetadata:当前类的注解信息
     * BeanDefinitionRegistry：BeanDifinition注册类
     *
     * 把所有需要添加到容器中的 bean，通过调用
     * BeanDefinitionRegistry.registerBeanDifinition 手工注册进来
     * @param importingClassMetadata
     * @param registry
     */

    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        boolean definition = registry.containsBeanDefinition("org.example.pojo.Red");
        boolean definition2 = registry.containsBeanDefinition("org.example.pojo.Blue");

        if(definition && definition2){
            RootBeanDefinition beanDefinition = new RootBeanDefinition(Rainbow.class);
            registry.registerBeanDefinition("rainbow", beanDefinition);
        }
    }
}

在配置类的 @Import 注解上新增定义的 MyImportBeanDefinitionRegistrar 类

package org.example.config;

import org.example.condition.MyImportBeanDefinitionRegistrar;
import org.example.condition.MyImportSelector;
import org.example.pojo.Color;
import org.example.pojo.Red;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Import({Color.class, Red.class, MyImportSelector.class, MyImportBeanDefinitionRegistrar.class})
@Configuration
public class ImportTestConfig {
}

测试方法：

@Test
public void testImport(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(ImportTestConfig.class);
    String[] beanDefinitionNames = ac.getBeanDefinitionNames();
    for (String beanDefinitionName : beanDefinitionNames) {
        System.out.println(beanDefinitionName);
    }
}

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

总结

@Import 注解向容器中注入 bean 的方式有三种，一是直接导入普通类或者配置类，二是通过导入实现了 ImportSelector 接口的类来实现批量导入 bean 实例，三是通过导入实现了 ImportBeanDefinitionRegistrar 接口来实现导入 bean 实例。

喵先森爱吃鱼
关注
专栏目录
Spring注解驱动开发第8讲——使用@Import注解给容器中快速导入一个组件
李阿昀的博客
11-29 4591
写在前面 我们知道，我们可以将一些bean组件交由Spring来管理，并且Spring还支持单实例bean和多实例bean。我们自己写的类，自然是可以通过包扫描+给组件标注注解（@Controller、@Servcie、@Repository、@Component）的形式将其注册到IOC容器中，但这种方式比较有局限性，局限于我们自己写的类，比方说我们自己写的类，我们当然能把以上这些注解标注上去了。 那么如果不是我们自己写的类，比如说我们在项目中会经常引入一些第三方的类库，我们需要将这些第三方类库中的类注册到
spring源码：@Import注解
小小少年的博客
06-18 299
目的 前面的文章@Bean源码解析有说到，将一个bean，转换成BeanDefinition，并存入BeanDefinitionMap有三种方式；本文，我们要说的是@Import注解这种方式； @Import是用来引入bean的；和本文相关的，我们需要关注ImportSelector和ImportBeanDefinitionRegistrar 接口说明 ImportBeanDefinitionRegistrar该接口，定义了一个public void registerBeanDefinitions( Ann
Spring注解驱动-@Import组件导入
失忆๑的博客
08-23 161
一）@Import注解的使用 @Import注解是和@Bean注解一样的都是创建一个的bean对象 相比于@Bean @Import的导入方式更简便，但是实际的功能是和@Bean一致的 使用的方法在类注解上导入一个类 使用@Import导入的方式bean的名称默认为类的全类名 @Configuration @Import(value = {Color.class, Red.class}) pub...
@Import
孔的博客
03-20 92
@Import注释允许从另一个配置类加载@Bean定义，如下面的示例所示: @Configuration public class ConfigA { @Bean public A a() { return new A(); } } @Configuration @Import(ConfigA.class) public class ConfigB { @Bean public B b() { return new B(); } } @Configuration public class ServiceCo
Spring元数据Metadata的使用，注解编程之AnnotationMetadata，ClassMetadata、MetadataReaderFactory
z69183787的专栏
02-26 2623
前言 Spring在2.0的时候就支持了基于XML Schema的扩展机制，让我们可以自定义的对xml配置文件进行扩展（四大步骤，有兴趣的可以自己学习），比如鼎鼎大名的Dubbo它就扩展了xml，用它来引入服务或者导出服务。 随着Spring3.0+的发展，xml慢慢的淡出了我们的视野，特别是Spring Boot的流行让xml彻底消失，所有的xml配置都使用注解的方式进行了代替。有的人说注解编...
@Import注解中使用ImportSelector接口导入bean
weixin_44230693的博客
04-23 506
@Import注解中使用ImportSelector接口导入bean
SpringBoot注入Bean的使用
冰冰凉的博客
01-17 4046
目录一、ImportSelector注入组件二、ImportBeanDefinitionRegistrar注入组件2.1 根据类路径装载单个对象2.2 扫描指定包下的自定义注解三、FactoryBean的基本使用3.1 使用FactoryBean注入普通对象3.2 使用FactoryBean注入代理对象四、ImportBeanDefinitionRegistrar结合FactoryBean使用注入接口的代理对象 一、ImportSelector注入组件 功能：可以根据字符串数组（数组元素为类的全类名）来批量
浅谈Spring中@Import注解的作用和使用
08-19
Spring 中 @Import 注解的作用和使用 @Import 注解是 Spring 框架中的一种重要注解，主要用于导入@Configuration 注解的配置类、声明@Bean 注解的 bean 方法、导入 ImportSelector 的实现类或导入 ...
通俗易懂的Spring注解驱动开发教程（含配套资料）
06-14
《Spring注解驱动开发》是一套帮助我们深入了解Spring原理机制的教程。现今SpringBoot.SpringCloud技术非常火热，作为Spring之上的框架，他们大量使用到了Spring的一些底层注解.原理，比如@Conditional.@Import.@...
详解Spring 注解之@Import 注入的各种花活
08-25
Spring 框架中的 @Import 注解是一个非常强大的工具，可以用来实现组件的自动装配和配置。下面我们将详细介绍 @Import 注解的多种使用场景，并通过示例代码来演示其使用方法。 一、使用 @Import 导入组件 @Import...
spring注解@Import用法详解
08-25
Spring 注解 @Import 用法详解 Spring 框架中，@Import 注解是一个非常重要的注解，它可以将外部的配置文件或类导入到当前的应用程序中，以实现模块化和解耦合。在本文中，我们将详细介绍 @Import 注解的用法和实现...
Spring注解驱动开发1
08-03
本文将深入探讨Spring的注解驱动开发，特别是`@Configuration`和`@Bean`这两个关键注解，以及如何通过Maven来构建一个Spring注解驱动的项目。 首先，让我们创建一个Maven项目，名为`spring-annotation`，并引入`...
Bean注入容器的多种方式
u014365523的博客
08-19 3040
bean注入容器
Spring（32）——ImportSelector介绍
ywb201314的专栏
10-08 358
因为在它的selectImports()你可以实现各种获取bean Class的逻辑，通过其参数AnnotationMetadata importingClassMetadata可以获取到@Import标注的Class的各种信息，包括其Class名称，实现的接口名称、父类名称、添加的其它注解等信息，通过这些额外的信息可以辅助我们选择需要定义为Spring bean的Class名称。可能有的时候你不希望依赖于配置类上的@ComponentScan，而期望直接扫描配置类所在的包。
@Import与ImportSelector
HCY_1992的博客
10-27 1131
@Import与ImportSelector 为什么只需要加上@EnableTransactionManagement就开启注解式事务，点进源码，发现一个重要的注解@Import @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Import(TransactionManagementConfigu...
spring之ImportSelector
libo_hh的博客
09-01 157
public class MyDefineImportSelector implements ImportSelector{ @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) { //动态导入bean, 告诉了Spring ， 两个配置类在哪里 return new String[]{MySqlSessionFactory.class.get.
Spring源码分析十五：事务实现① - AutoProxyRegistrar
猫吻鱼的博客
07-12 2518
文章目录一、前言二、 一、前言 本文是笔者阅读Spring源码的记录文章，由于本人技术水平有限，在文章中难免出现错误，如有发现，感谢各位指正。在阅读过程中也创建了一些衍生文章，衍生文章的意义是因为自己在看源码的过程中，部分知识点并不了解或者对某些知识点产生了兴趣，所以为了更好的阅读源码，所以开设了衍生篇的文章来更好的对这些知识点进行进一步的学习。 二、 ...
Spring中使用@Import注册一个配置类时，这个配置类不应该再使用@Component或者@Configuration注解
Brucelwl的博客
07-04 2041
Spring中通过@Import注册一个配置类时，这个配置类不应该在使用@Component或者@Configuration注解
第三章 SpringBoot项目构建 - 整合Spring Security入门
最新发布
想做一个小孩的杨先生的博客
09-11 580
Spring Security 是一个强大的框架，用于保护基于 Spring 的应用程序。它提供了全面的认证和授权功能，使得安全机制与应用逻辑相分离。以下是 Spring Security 的基本使用指南，包括如何集成 Spring Security、定义用户角色和权限、以及自定义安全配置。在 Java 生态中，目前有 Spring Security 和 Apache Shiro 两个安全框架，可以完成认证和授权的功能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值