写点什么

【深入浅出 Spring 原理及实战】「工作实战专题」叫你如何使用另类操作去实现 Spring 容器注入 Bean 对象 (1)

作者:洛神灬殇
  • 2024-05-06
    江苏
  • 本文字数:4141 字

    阅读完需:约 14 分钟

【深入浅出Spring原理及实战】「工作实战专题」叫你如何使用另类操作去实现Spring容器注入Bean对象 (1)

@Configuration + @Bean 的注入方式

@Configuration 用来声明一个配置类,然后使用 @Bean 注解,用于声明一个 bean,将其加入到 Spring 容器中。


具体代码如下:


@Configurationpublic class MyConfiguration {    @Bean    public Person person() {        Person person = new Person();        person.setName("spring");        return person;    }}
复制代码

@Componet + @ComponentScan 的注入方式

放在类名上面,然后 @ComponentScan 放置在我们的配置类上,然后可以指定一个路径,进行扫描带有 @Componet 注解的 bean,然后加至容器中。


@Componentpublic class Person {    private String name;
public String getName() {
return name; } public void setName(String name) { this.name = name; } @Override public String toString() { return "Person{" + "name='" + name + '\'' + '}'; }}
@ComponentScan(basePackages = "it.chusen.spring.*")public class Demo1 { public static void main(String[] args) { AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class); Person bean = applicationContext.getBean(Person.class); System.out.println(bean); }}
复制代码

@Import 注解导入

@Import 注解用的可能不是特别多了,在进行 Spring 扩展时经常会用到,它经常搭配自定义注解进行使用,然后往容器中导入一个配置文件。关于 @Import 注解,我会多介绍一点,它有三种使用方式,我会一一介绍。这是 @Import 注解的源码,表示只能放置在类上。


@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface Import {
/** * 用于导入一个class文件 * {@link Configuration @Configuration}, {@link ImportSelector}, * {@link ImportBeanDefinitionRegistrar}, or regular component classes to import. */ Class<?>[] value();
}
复制代码

@Import 直接导入类

public class Person {    private String name;
public String getName() {
return name; }
public void setName(String name) { this.name = name; }
@Override public String toString() { return "Person{" + "name='" + name + '\'' + '}'; }}/*** 直接使用@Import导入person类,然后尝试从applicationContext中取,成功拿到**/@Import(Person.class)public class Demo1 {
public static void main(String[] args) { AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class); Person bean = applicationContext.getBean(Person.class); System.out.println(bean); }}
复制代码

@Import + ImportSelector

其实在 @Import 注解的源码中,说的已经很清楚了,感兴趣的可以看下,我们实现一个 ImportSelector 的接口,然后实现其中的方法,进行导入。


@Import(MyImportSelector.class)public class Demo1 {
public static void main(String[] args) { AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class); Person bean = applicationContext.getBean(Person.class); System.out.println(bean); }}
class MyImportSelector implements ImportSelector { @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) { return new String[]{"it.chusen.spring.model.Person"}; }}
复制代码


我自定义了一个 MyImportSelector 实现了 selectImports 方法,然后将我们要导入的类的全限定名写在里面即可,实现起来也是非常简单。

@Import + ImportBeanDefinitionRegistrar

这种方式也需要我们实现 ImportBeanDefinitionRegistrar 中的方法,具体代码如下:


@Import(MyImportBeanDefinitionRegistrar.class)public class Demo1 {    public static void main(String[] args) {        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);        Person bean = applicationContext.getBean(Person.class);        System.out.println(bean);    }}
class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar { @Override public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { // 构建一个beanDefinition, 关于beanDefinition我后续会介绍,可以理解为bean的定义. AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition(); // 将beanDefinition注册到Ioc容器中. registry.registerBeanDefinition("person", beanDefinition); }}
复制代码


上述实现其实和 Import 的第二种方式差不多,都需要去实现接口,然后进行导入。接触到了一个新的概念,BeanDefinition,可以简单理解为 bean 的定义(bean 的元数据),也是需要放在 IOC 容器中进行管理的,先有 bean 的元数据,applicationContext 再根据 bean 的元数据去创建 Bean。

@Import + DeferredImportSelector

这种方式也需要我们进行实现接口,其实它和 @Import 的第二种方式差不多,DeferredImportSelector 它是 ImportSelector 的子接口,所以实现的方法和第二种无异。只是 Spring 的处理方式不同,它和 Spring Boot 中的自动导入配置文件 延迟导入有关,非常重要。使用方式如下:


@Import(MyDeferredImportSelector.class)public class Demo1 {    public static void main(String[] args) {        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);        Person bean = applicationContext.getBean(Person.class);        System.out.println(bean);    }}class MyDeferredImportSelector implements DeferredImportSelector {    @Override    public String[] selectImports(AnnotationMetadata importingClassMetadata) {        // 也是直接将Person的全限定名放进去        return new String[]{Person.class.getName()};    }}
复制代码


关于 @Import 注解的使用方式,大概就以上三种,当然它还可以搭配 @Configuration 注解使用,用于导入一个配置类。

使用 FactoryBean 接口

FactoryBean 接口和 BeanFactory 千万不要弄混了,从名字其实可以大概的区分开,FactoryBean, 后缀为 bean,那么它其实就是一个 bean, BeanFactory,顾名思义 bean 工厂,它是 IOC 容器的顶级接口,这俩接口其实都很重要。代码示例:


@Configurationpublic class Demo1 {    @Bean    public PersonFactoryBean personFactoryBean() {        return new PersonFactoryBean();    }
public static void main(String[] args) { AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class); Person bean = applicationContext.getBean(Person.class); System.out.println(bean); }}
class PersonFactoryBean implements FactoryBean<Person> {
/** * 直接new出来Person进行返回. */ @Override public Person getObject() throws Exception { return new Person(); } /** * 指定返回bean的类型. */ @Override public Class<?> getObjectType() { return Person.class; }}
复制代码


上述代码,我使用 @Configuration + @Bean 的方式将 PersonFactoryBean 加入到容器中,注意,我没有向容器中注入 Person, 而是直接注入的 PersonFactoryBean 然后从容器中拿 Person 这个类型的 bean,成功运行。

使用 BeanDefinitionRegistryPostProcessor

其实这种方式也是利用到了 BeanDefinitionRegistry,在 Spring 容器启动的时候会执行 BeanDefinitionRegistryPostProcessorpostProcessBeanDefinitionRegistry 方法,大概意思就是等 beanDefinition 加载完毕之后,对 beanDefinition 进行后置处理,可以在此进行调整 IOC 容器中的 beanDefinition,从而干扰到后面进行初始化 bean。


public class Demo1 {    public static void main(String[] args) {        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();        MyBeanDefinitionRegistryPostProcessor beanDefinitionRegistryPostProcessor = new MyBeanDefinitionRegistryPostProcessor();        applicationContext.addBeanFactoryPostProcessor(beanDefinitionRegistryPostProcessor);        applicationContext.refresh();        Person bean = applicationContext.getBean(Person.class);        System.out.println(bean);    }}
class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
@Override public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException { AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition(); registry.registerBeanDefinition("person", beanDefinition); } @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
}}
复制代码

小结

介绍了向 spring 容器中加入 bean 的几种方式.


  • @Configuration + @Bean

  • @ComponentScan + @Component

  • @Import 配合接口进行导入

  • 使用 FactoryBean。

  • 实现 BeanDefinitionRegistryPostProcessor 进行后置处理。


发布于: 15 分钟前阅读数: 5
用户头像

洛神灬殇

关注

🏆 InfoQ写作平台-签约作者 🏆 2020-03-25 加入

👑 前优酷资深工程师,一个具有高洞察力的理性自律小i人 — INTJ 📕 个人著作《深入浅出Java虚拟机—JVM原理与实战》 💻 10年开发经验,参与过多个大型互联网项目,定期分享技术干货和项目经验

评论

发布
暂无评论
【深入浅出Spring原理及实战】「工作实战专题」叫你如何使用另类操作去实现Spring容器注入Bean对象 (1)_Java_洛神灬殇_InfoQ写作社区