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

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

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

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

FastJsonRedisSerializer<Object> 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<SourceClass> asSourceClasses(String[] > classNames) throws IOException {
List<SourceClass> annotatedClasses = new ArrayList<SourceClass>(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<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<String, BeanDefinition>(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
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343