Spring Bean 的注册和注入的几种常用方式和区别

Spring 注册Bean:
包扫描 + 组件标注注解(@Controller、@Service、@Repository、@Component),一般项目里面使用。
使用@Bean注解,一般导入第三方组件的时候使用。
使用@Import注解,一般快速导入一批组件时使用。
使用FactoryBean接口 + @Bean注解。
包扫描 + 组件标注注解(@Controller、@Service、@Repository、@Component)
我们一般在项目开发中都是使用这种方式。

使用@Bean注解
一般导入第三方组件的时候使用,如注册一个RedisTemplate:

@Bean
public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate redisTemplate = new RedisTemplate<>();
redisTemplate.setConnectionFactory(redisConnectionFactory);

FastJsonRedisSerializer fastJsonRedisSerializer = new FastJsonRedisSerializer<>(Object.class);

// 设置值(value)的序列化采用KryoRedisSerializer。
redisTemplate.setValueSerializer(fastJsonRedisSerializer);
redisTemplate.setHashValueSerializer(fastJsonRedisSerializer);
// 设置键(key)的序列化采用StringRedisSerializer。
redisTemplate.setKeySerializer(new StringRedisSerializer());
redisTemplate.setHashKeySerializer(new StringRedisSerializer());

redisTemplate.afterPropertiesSet();
return redisTemplate;
 
 

}
使用@Import注解
一般快速导入一批组件时使用,如同时注册好几个动物类:

@Configuration
@Import({DogTestBean.class, CatTestBean.class})
public class ImportConfig {

@Bean
public ImportTestBean importTestBean() {
    return new ImportTestBean();
}

}
容器中的Bean:

打印 Spring 容器中的Bean 开始
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalRequiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
importConfig
com.xiaolyuh.iimport.DogTestBean
com.xiaolyuh.iimport.CatTestBean
importTestBean
打印 Spring 容器中的Bean 结束
ImportSelector 分组导入
@Configuration
@Import({DogTestBean.class, CatTestBean.class, AnimalImportSelector.class})
public class ImportConfig {

@Bean
public ImportTestBean importTestBean() {
    return new ImportTestBean();
}

}

public class AnimalImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
// 不能返回NULL,否则会报空指针异常,打断点可以看到源码
return new String[]{"com.xiaolyuh.iimport.bean.FishTestBean",
"com.xiaolyuh.iimport.bean.TigerTestBean" };
}
}
打印 Spring 容器中的Bean 开始
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalRequiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
importConfig
com.xiaolyuh.iimport.bean.DogTestBean
com.xiaolyuh.iimport.bean.CatTestBean
com.xiaolyuh.iimport.bean.FishTestBean
com.xiaolyuh.iimport.bean.TigerTestBean
importTestBean
打印 Spring 容器中的Bean 结束
selectImports()这个方法不能返回NULL,否则会报空指针异常,从源代码来看是在如下位置报出来的:

private Collection asSourceClasses(String[] > classNames) throws IOException {
List annotatedClasses = new ArrayList(classNames.length);
for (String className : classNames) {
annotatedClasses.add(asSourceClass(className));
}
return annotatedClasses;
}
通过 ImportBeanDefinitionRegistrar 自定义注册
只有动物园里面有 猫和狗的时候我么才将猪注入进去。ImportBeanDefinitionRegistrar注册器,在注册bean的过程中会在最后执行。

@Configuration
@Import({DogTestBean.class, CatTestBean.class, AnimalImportSelector.class, AnimalImportBeanDefinitionRegistrar.class})
public class ImportConfig {

@Bean
public ImportTestBean importTestBean() {
    return new ImportTestBean();
}

}

public class AnimalImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

/**
 * @param importingClassMetadata 当前类的注解信息
 * @param registry               注册器,通过注册器将特定类注册到容器中
 */
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    // 猫和狗的Bean我们可以声明一个注解,类似Spring Boot的条件注解
    boolean isContainsDog = registry.containsBeanDefinition(DogTestBean.class.getName());
    boolean isContainsCat = registry.containsBeanDefinition(CatTestBean.class.getName());

    if (isContainsDog && isContainsCat) {
        RootBeanDefinition beanDefinition = new RootBeanDefinition(PigTestBean.class);
        // 第一个参数是Bean id ,第二个是RootBeanDefinition
        registry.registerBeanDefinition("pigTestBean", beanDefinition);
    }
}

}
打印 Spring 容器中的Bean 开始
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalRequiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
importConfig
com.xiaolyuh.iimport.bean.DogTestBean
com.xiaolyuh.iimport.bean.CatTestBean
com.xiaolyuh.iimport.bean.FishTestBean
com.xiaolyuh.iimport.bean.TigerTestBean
importTestBean
pigTestBean
打印 Spring 容器中的Bean 结束
通过该方式注册Bean,必须将Bean封装成 RootBeanDefinition。
ImportBeanDefinitionRegistrar注册器,在注册bean的过程中会在最后执行。
跟进源码我们可以看到容器就是一个Map,private final Map beanDefinitionMap = new ConcurrentHashMap(256);
使用 FactoryBean
@Configuration
@Import({DogTestBean.class, CatTestBean.class, AnimalImportSelector.class, AnimalImportBeanDefinitionRegistrar.class})
public class ImportConfig {

@Bean
public ImportTestBean importTestBean() {
    return new ImportTestBean();
}

// 最终注入的其实是 MonkeyTestBean 类
@Bean
public AnimalFactoryBean monkeyTestBean() {
    return new AnimalFactoryBean();
}

}

public class AnimalFactoryBean implements FactoryBean {

/**
 * 获取实例
 *
 * @return
 * @throws Exception
 */
@Override
public MonkeyTestBean getObject() throws Exception {

    return new MonkeyTestBean();
}

/**
 * 获取示例类型
 *
 * @return
 */
@Override
public Class getObjectType() {
    return MonkeyTestBean.class;
}

/**
 * 是否单例
 *
 * @return
 */
@Override
public boolean isSingleton() {
    return true;
}

}
输出结果:

打印 Spring 容器中的Bean 开始
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalRequiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
importConfig
com.xiaolyuh.iimport.bean.DogTestBean
com.xiaolyuh.iimport.bean.CatTestBean
com.xiaolyuh.iimport.bean.FishTestBean
com.xiaolyuh.iimport.bean.TigerTestBean
importTestBean
monkeyTestBean
pigTestBean
打印 Spring 容器中的Bean 结束

开始获取容器中的Bean
14:07:12.533 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'monkeyTestBean'

MonkeyTestBean 初始化

14:07:12.534 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'monkeyTestBean'
true
我爱吃香蕉
使用该方式会注册两个Bean到容器,一个是FactoryBean,一个是我们真实需要注册的Bean,如demo中的MonkeyTestBean。
使用该方式不管是否是单例模式下,实例化真实的Bean都是在第一次获取Bean 的时候。也就是说都是在容器初始化完成之后。
根据名称获取Bean的时候,如果在Bean名称前加一个&符号表示获取工厂Bean,否则是获取我们真实注册的Bean。

Spring 注入Bean的注解:
@Autowired:Spring提供的注解。
@inject:JSR-330提供的注解。
@Resource:JSP-250提供的注解。
‘@Autowired’ 和‘@Inject’他们都是通过‘AutowiredAnnotationBeanPostProcessor’ 类实现的依赖注入,二者具有可互换性。
‘@Resource’通过 ‘CommonAnnotationBeanPostProcessor’ 类实现依赖注入,即便如此他们在依赖注入时的表现还是极为相近的。
以下是他们在实现依赖注入时执行顺序的概括:

@Autowired and @Inject

Matches by Type
Restricts by Qualifiers
Matches by Name
@Resource

Matches by Name
Matches by Type
Restricts by Qualifiers (ignored if match is found by name)

作者:xiaolyuh
链接:https://www.jianshu.com/p/b33bc52cada7
来源:
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

你可能感兴趣的:(Spring Bean 的注册和注入的几种常用方式和区别)