上篇文章介绍了spring的@Conditional:
@Conditional---Spring源码从入门到精通(四)
这篇文章深入解析,如何给容器注册bean:
ComponentScan+注解(如:@Controller,@Service,@Compoment,@Repository)
@Bean+@Configuration定义导入的第三方bean
@Import(相对于Bean的优势:快速给容器中导入一个组件)
这篇文章着重介绍import下面三个用法,springboot用importSelector接口非常多。
1)@import注解,直接导入容器,id默认【全类名】。
2) 自定义类实现importSelector,返回需要注册进ioc容器的【全类名】数组。
3) 自定义类实现ImportBeanDefinitionRegistrar,手动注册入容器,可以自定义id。
从Import源码我们可以看到,导入的是一个数组,所以可以放多个类。原本加载beanConfig2是没有color和red类打印的,但import进去之后,就会吧这两个组件注入容器,代码如下。
定义一个junit测试类,因为每次都需要打印容器中的组件,考虑到复用性,提取出一个方法,后面可以直接调用getDefinitionNames(),再写一个red和color类,用import吧组件注入容器。
1、@Import基础使用
AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext( BeanConfig2.class); /** * @Import */ @org.junit.Test public void testImport(){ getDefinitionNames(annotationConfigApplicationContext); } private void getDefinitionNames(AnnotationConfigApplicationContext annotationConfigApplicationContext) { String[] names = annotationConfigApplicationContext.getBeanDefinitionNames(); for (String name: names) { System.out.println("容器中的组件:"+name); } System.out.println("======="); String[] personNames = annotationConfigApplicationContext.getBeanNamesForType(Person.class); for (String name: personNames) { System.out.println("Person中的组件:"+name); } }
/** * Color * * @author keying * @date 2021/6/28 */ public class Color { } /** * red * * @author keying * @date 2021/6/28 */ public class Red { }
@Configuration @Import({Color.class, Red.class}) public class BeanConfig2 { //之前的代码我都删掉,方便观看上面的@Import }
打印结果如下,如果没有import,则不打印,会因为import了,所以容器中有red和color组件:
2、自定义类实现importSelector
自定义myImportSelector实现ImportSelector,里面返回新增的blue,yellow类路径,再加上扫描自定义的类,代码如下。
/** * @author keying * @Import */ public class MyImportSelector implements ImportSelector { /** * @param importingClassMetadata 当前标注@Import注解类的所有注解信息 * @return 容器里的组件 */ public String[] selectImports(AnnotationMetadata importingClassMetadata) { //可以返回空数组,不要返回null return new String[] {"com.alibaba.bean.Blue", "com.alibaba.bean.Yellow"}; } } //加上扫描自定义类 @Import({Color.class, Red.class, MyImportSelector.class}) public class BeanConfig2 {}
/** * @Import */ @org.junit.Test public void testImport() { getDefinitionNames(annotationConfigApplicationContext); //放入容器后,从容器中获取 Blue blue = annotationConfigApplicationContext.getBean(Blue.class); System.out.println("获取成功的组件:" + blue); }
打印结果如下,通过自定义importSelect,blue和yellow组件也成功放入容器,并且能成功从容器中获取对象:
3、自定义类实现ImportBeanDefinitionRegistar
手动注册bean到ioc容器中,自定义组件名,上面import导入的时候组件名默认是类路径,代码如下:
public class MyImportBeanDefinition implements ImportBeanDefinitionRegistrar { /** * @param importingClassMetadata 当前类注解信息 * @param registry beanDefinition 注册类 */ public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { boolean red = registry.containsBeanDefinition("com.alibaba.bean.Red"); boolean yellow = registry.containsBeanDefinition("com.alibaba.bean.Yellow"); if (red && yellow) { BeanDefinition beanDefinition = new RootBeanDefinition(RedYellow.class); //自定义组件名 registry.registerBeanDefinition("RedYellow", beanDefinition); } } }
@Import({Color.class, Red.class, MyImportSelector.class, MyImportBeanDefinition.class}) public class BeanConfig2 { }
junit不变,运行后打印如下,从结果可以看到,因为ioc容器中有red和yellow的bean,所以if判断返回为true,之后手动注册id为redYellow的主键进入容器,beanDefinition则是指定类的加载信息。