Spring注册bean的几种常用方法总结

spring中注册bean对象大概有一下几种方法:

  • @compont,@service,@controller,@repository等
  • @Bean
  • @Import
  • @FactoryBean

第一种方式不用多说,用过spring的大概都用过,那么第二种方式应该是比较常用的。其他第三方框架与spring整合的时候一般来说少不了这个注解。@Bean功能等效于配置文件中的<bean></bean>标签

重点看一下第三个

@Import

@Import,被称为springboot的万能粘合剂。在springboot的底层大量使用@Import注解

他有三种用法:

  1. 直接导入类到ioc
  2. ImportSelector
  3. ImportBeanDefinitionRegistrar

 直接导入类到ioc

 配置类上添加直接注解,并将想要注入到ioc中的类型写入即可

@Import({Blue.class})

ImportSelector

@Import({ColorSelector.class})

配置类注解是这样写即可,那么ColorSelector是什么?他是实现了ImportSelector接口的实现类

代码如下:

public class ColorSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.lhf.bean.beans.Red"};
    }
}

代码很简单,只需要实现他的方法即可,返回值为将要注册为bean对象的全限定类名。入参AnnotationMetadata是@Import注解所在类上的配置信息,主要是注解方面。一般来说在springboot底层中@Import("***ImportSelector")是标注在Enable***注解上的比如:

 ImportBeanDefinitionRegistrar

BeanDefinition被称之为bean定义信息。这种方式导入ioc无非就是通过导入BeanDefinition从而完成bean的注入:

@Import({ColorImportBeanDefinitionRegistrar.class})

同样的,使用这种方法也是需要实现一个接口:ImportBeanDefinitionRegistrar

public class ColorImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

        GenericBeanDefinition definition = new GenericBeanDefinition();
        definition.setBeanClass(Yellow.class);
        registry.registerBeanDefinition("yellow", definition);
    }
}

FactoryBean

如果做过spring+mybatis的整合朋友一定见过SqlSessionFactoryBean了,他就是用这种方法来将SqlSession注入到ioc中的

实现FactoryBean接口,并且实现他的方法即可

public interface FactoryBean<T> {


	String OBJECT_TYPE_ATTRIBUTE = "factoryBeanObjectType";


	@Nullable
	T getObject() throws Exception;

	@Nullable
	Class<?> getObjectType();

	default boolean isSingleton() {
		return true;
	}

这是他的源码,不难理解,第一个方法返回的是一个实例,第二个方法返回的是类型,至于第三个方法定义他是不是单例的,默认是单例。他是一个默认方法,可以不重写

public class ColorFactoryBean implements FactoryBean<Green> {
    @Override
    public Green getObject() throws Exception {
        return new Green();
    }

    @Override
    public Class<?> getObjectType() {
        return Green.class;
    }
}

这是自定义的FactoryBean如何注入?使用@Bean将ColorFactoryBean直接注入即可

 @Bean
 public ColorFactoryBean colorFactoryBean() {
     return new ColorFactoryBean();
 }

那么一定有小伙伴有疑问了,这个示例中要注入的不应该是Green吗?这样注入不就是ColorFactoryBean了吗?我们打印一下看看

public class MainTest {
    ApplicationContext context;

    @Before
    public void before() {
        context = new AnnotationConfigApplicationContext(MainConfig.class);
    }

    public void print() {
        Map<String, Color> map = context.getBeansOfType(Color.class);
        map.forEach((k, v) -> {
            System.out.println("name:" + k + "->value:" + v);
        });
    }

    #@Test
    #public void test01() {
    #    print();
    #}

    @Test
    public void test02(){
        Map<String, Green> map = context.getBeansOfType(Green.class);
        System.out.println(map);
    }

}

从打印结果来看bean的类型指定为Green的全类名,所以说上述问题完全不存在。

这几种注册bean的方式各有优劣,@Component注解式自定义类很方便的使用的,@Import注解作为SpringBoot的万能粘贴剂自然不用多说,@Bean是注入一些第三方jar中的类,最后FactoryBean用的就不是很多了,他只在部分框架整合中出现过,反正我自身是很少用它的。

文笔略差,可能有些不足,欢迎各位大佬指点

 


版权声明:本文为qq_43653951原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。