Configuration注解一定要加吗?

在上一期SpringBoot自定义starter中,我们讲到自动配置类是可以不加@Configuration注解的,但是在特定的场景会引发一个小小的问题,今天我们就来聊一下这个奇怪的小知识吧

案例

先定义两个Bean, 其中Foo依赖Boo

public class Bar {

    public Bar(){
        System.out.println("init");
    }
}
public class Foo {

    public Foo(Bar bar){
    }
}

配置类

@Configuration
public class FooConfig {

    @Bean
    public Foo foo(){
        return new Foo(bar());
    }

    @Bean
    public Bar bar(){
        return new Bar();
    }
}

问题

配置类中有个写法: new Foo(bar()),相信大家也这样写过,但是不知道大家有没有思考过这样一个问题:

Spring里面的Bean默认都是单例的,没错吧?

那么请问new Bar()这一行代码在程序启动时执行了几次?

发现问题了吗?

正常来说,应该是有两次

一:将bar注入到容器中时调用一次

二:将foo注入容器中时调用到bar()方法,又调用一次new Bar()

那此时将会产生一个血案,Spring容器中的bar对象与foo持有的bar对象不是同一个实例!

分析到这,觉得是1次的小伙伴扣1,2次的小伙伴扣2

答案

那我们都能发现这个问题,Spring的开发者肯定也能想到,所以到底是几次呢?我们来运行一下看看吧

每次运行new Bar()就会调用一次Bar对象的构造器,输出init语句

编写测试类

public class Main {

    public static void main(String[] args) {
        new AnnotationConfigApplicationContext(FooConfig.class);
    }
}

结果:

image

嘿,答案是一次,这要是B站我不得来一句"猜对的小伙伴把不愧是我打在公屏上"

那么如果把Configuration注解去掉呢?

再来一把

image

!!!啊这....

此时Bar对象居然被实例化了两次,血案发生了!

没错,这就我在开头跟大家说的,如果不加@Configuration注解在某些特订的场景会引发一个小问题,这个特定的场景就是:在@Bean注解修饰的方法中调用了另一个@Bean注解修饰的方法。

思考

到这里,文章标题的问题已经回答大家了,@Configuration注解可以不加,但是会出现问题。

但是,有时候Spring建议你不要加!就是在我说的没有特定的场景的时候。为什么呢?

这就需要大家思考一下,按正常的逻辑,Bar对象肯定是要被实例化两次的,但是为什么加了@Configuration注解后只实例化了一次呢?Spring到底做了什么?

探索

我们打开@Configuraiton注解,里面有这样的一个属性proxyBeanMethods,默认值为ture,Spring对它的描述是这样的:

指定@Bean方法是否应该被代理,以便执行Bean生命周期行为,例如,即使在用户代码中直接调用@Bean方法的情况下,也要返回共享的单子Bean实例。这个功能需要方法拦截,通过运行时生成的CGLIB子类来实现。

默认情况下是true,允许通过配置类内的方法进行调用。如果不需要这样做,因为这个特定配置的每个@Bean方法都是自成一体的,被设计成供容器使用的普通工厂方法,那么将这个标志切换为false,以避免CGLIB子类处理。
关闭bean方法拦截可以有效地处理@Bean方法。它在行为上等同于移除@Configuration。

所以当我们加上@Configuraiton注解时,最后Spring其实使用的是一个CGLIB代理类

什么是CGLIB动态代理

CGLIB是一个功能强大的高性能代码生成库。它是JDK动态代理的补充,因为它提供了不实现接口的代理类(通过继承)。

案例

还是刚才的例子,这里再添加一个CGLIB的使用样例

public class Test {

    public static void main(String[] args) {
        Enhancer enhancer = new Enhancer();
    // 设置继承的父类
        enhancer.setSuperclass(FooConfig.class);
    // 设置拦截的方法
        enhancer.setCallback((MethodInterceptor) (obj, method, args1, methodProxy) -> {
            // 调用父类方法前打印一行日志
      System.out.println("cglib proxy!");
            return methodProxy.invokeSuper(obj, args1);
        });
        final FooConfig fooConfig = (FooConfig) enhancer.create();
        fooConfig.bar();
    }
}

运行

image

Spring中的实现方式

Spring中的实现方式同样体现在它的回调方法中,它的回调方法还是有些复杂的,我这里只摘出它的逻辑部分

@Override
@Nullable
public Object intercept(Object enhancedConfigInstance, Method beanMethod, Object[] beanMethodArgs,
                        MethodProxy cglibMethodProxy) throws Throwable {
  // 取出BeanFactory
  ConfigurableBeanFactory beanFactory = getBeanFactory(enhancedConfigInstance);
  // 通过beanMethod确定beanName
  String beanName = BeanAnnotationHelper.determineBeanNameFor(beanMethod);
  // 当前执行的方法是否与beanMethod相同, 如果正在执行foo,当在foo中调用到bar时则会返回false
  if (isCurrentlyInvokedFactoryMethod(beanMethod)) {
    // 调用父类方法
    return cglibMethodProxy.invokeSuper(enhancedConfigInstance, beanMethodArgs);
  }
  // 直接从容器中取出Bean
  return resolveBeanReference(beanMethod, beanMethodArgs, beanFactory, beanName);
}

这里贴出源码地址:ConfigurationClassEnhancer.BeanMethodInterceptor#intercept

感兴趣的小伙伴可以自己研究下细节

小结

今天和小伙伴们聊了一下@Configuration的必要性,以及一点点它的原理,希望大家有所收获,我们下期再见

想要了解更多精彩内容,欢迎关注公众号:程序员阿鉴

个人博客空间:https://zijiancode.cn

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

推荐阅读更多精彩内容