Spring解决循环依赖(上)

本篇先尝试自己实现一个解决循环依赖的方案，下篇分析Spring是如何解决的。

1. 什么是循环依赖？

所谓的循环依赖是指，A 依赖 B，B 又依赖 A，它们之间形成了循环依赖。或者是 A 依赖 B，B 依赖 C，C 又依赖 A。它们之间的依赖关系如下：

Spring循环依赖

2. Spring解决了什么？

首先要搞清楚，Spring提供的几种注入方式。

2.1 构造器注入

顾名思义，构造方法注入，就是被注入对象可以通过在其构造方法中声明依赖对象的参数列表，让外部（通常是IoC容器）知道它需要哪些依赖对象。

2.2 属性注入

对于JavaBean对象来说，通常会通过setXXX()和getXXX()方法来访问对应属性。这些setXXX()方法统称为setter方法，getXXX()当然就称为getter方法。通过setter方法，可以更改相应的对象属性，通过getter方法，可以获得相应属性的状态。所以，当前对象只要为其依赖对象所对应的属性添加setter方法，就可以通过setter方法将相应的依赖对象设置到被注入对象中。

2.3 接口注入(平时用不到，可以不考虑)

相对于前两种注入方式来说，接口注入没有那么简单明了。被注入对象如果想要IoC Service
Provider为其注入依赖对象，就必须实现某个接口。这个接口提供一个方法，用来为其注入依赖对象。
IoC Service Provider最终通过这些接口来了解应该为被注入对象注入什么依赖对象。

2.4 Spring只解决了单例下属性注入的循环依赖

直接上代码，先看构造器注入的。

package com.spring.beans;

import org.springframework.stereotype.Component;

@Component
public class ClassA {

    private ClassB classB;

    public ClassA(ClassB classB) {
        this.classB = classB;
    }
}

package com.spring.beans;

import org.springframework.stereotype.Component;

@Component
public class ClassB {

    private ClassA classA;

    public ClassB(ClassA classA) {
        this.classA = classA;
    }
}

测试类

package com.spring.beans;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Demo {

    public static void main(String[] args) {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext("com.spring.beans");

    }

}

最后报错了，可见Spring不能解决构造器注入的循环依赖问题，记住这个报错信息，以后出现该报错都是循环依赖的问题。

Caused by: org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'classA': Requested bean is currently in creation: Is there an unresolvable circular reference?

再来看属性注入的。

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ClassA {

    @Autowired
    private ClassB classB;

}

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ClassB {

    @Autowired
    private ClassA classA;

}

package com.spring.beans;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Demo {

    public static void main(String[] args) {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext("com.spring.beans");
    }

}

运行成功。

3. 自己实现一个

3.1 第一版

3.1.1 解决思路

先上流程图。

第一版

3.1.2 具体代码

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ClassA {

    @Autowired
    private ClassB classB;

    public ClassA(){
        System.out.println("ClassA实例化");
    }

    public ClassA(ClassB classB) {
        this.classB = classB;
    }

    public void setClassB(ClassB classB) {
        this.classB = classB;
    }

    public ClassB getClassB() {
        return classB;
    }

    public void sayHi(){
        System.out.println("我是classA");
    }
}

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ClassB {

    @Autowired
    private ClassA classA;

    public ClassB(){
        System.out.println("ClassB实例化");
    }

    public ClassB(ClassA classA) {
        this.classA = classA;
    }

    public ClassA getClassA() {
        return classA;
    }

    public void sayHi(){
        System.out.println(classA);
    }
}

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.util.ConcurrentReferenceHashMap;

import java.lang.reflect.Field;
import java.util.Map;

public class Demo {

    private static Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentReferenceHashMap<>(10);

    private static Map<String, Object> singletonObjects = new ConcurrentReferenceHashMap<>(10);

    public static void main(String[] args) throws Exception {

        loadBeanDefinition();

        for(String beanName : beanDefinitionMap.keySet()){
            getBean(beanName);
        }

        ClassA classA = (ClassA) getBean("classA");

        classA.sayHi();
    }

    private static void loadBeanDefinition() {
        //生成Bean定义
        RootBeanDefinition rootBeanDefinitionClassA = new RootBeanDefinition(ClassA.class);
        RootBeanDefinition rootBeanDefinitionClassB = new RootBeanDefinition(ClassB.class);

        //将类注册到Bean定义的Map里
        beanDefinitionMap.put("classA", rootBeanDefinitionClassA);
        beanDefinitionMap.put("classB", rootBeanDefinitionClassB);
    }

    @SuppressWarnings("")
    private static Object getBean(String beanName) throws Exception {

        //如果缓存里边有，直接返回
        if (singletonObjects.containsKey(beanName)){
            return singletonObjects.get(beanName);
        }

        //实例化
        RootBeanDefinition beanDefinition = (RootBeanDefinition) beanDefinitionMap.get(beanName);

        Class<?> beanClass = beanDefinition.getBeanClass();
        
        //缓存里没有的话，通过无参构造函数，将对象本身实例化
        Object beanInstance = beanClass.newInstance();

        //放入缓存
        singletonObjects.put(beanName,beanInstance);

        //属性赋值，解析Autowired
        //拿到所有的属性名
        Field[] declaredFields = beanClass.getDeclaredFields();

        //循环所有属性
        for (Field declaredField : declaredFields){
            declaredField.setAccessible(true);

            //从属性上拿到@Autowired
            Autowired annotation = declaredField.getAnnotation(Autowired.class);

            if (annotation != null){
                String name = declaredField.getName();
                Object fieldObject = getBean(name);
                declaredField.set(beanInstance,fieldObject);
            }
        }

        return  beanInstance;

    }

}

3.2 第二版

第一版实现完了，虽然在单线程下没有循环依赖的问题了，但是缓存只存入了还没有赋值的实例，即这个实例是不完整的，所以还需要用另一个缓存来存储不完整的实例，用以区分完整的和不完整的实例。

3.2.1 流程图

第二版

3.2.2 具体代码

在原有代码基础上，做了小的改动，并封装了一些方法。

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.util.ConcurrentReferenceHashMap;

import java.lang.reflect.Field;
import java.util.Map;

public class Demo {

    private static Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentReferenceHashMap<>(10);

    private static Map<String, Object> singletonObjects = new ConcurrentReferenceHashMap<>(10);

    private static Map<String, Object> earlySingletonObjects = new ConcurrentReferenceHashMap<>(10);

    public static void main(String[] args) throws Exception {

        loadBeanDefinition();

        for (String beanName : beanDefinitionMap.keySet()) {
            getBean(beanName);
        }

        ClassA classA = (ClassA) getBean("classA");

        classA.sayHi();
    }

    private static void loadBeanDefinition() {
        //生成Bean定义
        RootBeanDefinition rootBeanDefinitionClassA = new RootBeanDefinition(ClassA.class);
        RootBeanDefinition rootBeanDefinitionClassB = new RootBeanDefinition(ClassB.class);

        //将类注册到Bean定义的Map里
        beanDefinitionMap.put("classA", rootBeanDefinitionClassA);
        beanDefinitionMap.put("classB", rootBeanDefinitionClassB);
    }

    @SuppressWarnings("")
    private static Object getBean(String beanName) throws Exception {

        Object object = getSingletonObject(beanName);

        if (object != null) {
            return object;
        }

        Object beanInstance = createBeanInstance(beanName);

        //放入一级缓存
        singletonObjects.put(beanName, beanInstance);

        return beanInstance;

    }

    /**
     * 负责Bean的实例化
     * @param beanName 对象的名字
     * @return 对象的实例
     * @throws Exception 异常
     */
    private static Object createBeanInstance(String beanName) throws Exception {
        //实例化
        RootBeanDefinition beanDefinition = (RootBeanDefinition) beanDefinitionMap.get(beanName);

        Class<?> beanClass = beanDefinition.getBeanClass();

        //缓存里没有的话，通过无参构造函数，将对象本身实例化
        Object beanInstance = beanClass.newInstance();

        //放入二级缓存
        earlySingletonObjects.put(beanName, beanInstance);

        //属性赋值，解析Autowired
        //拿到所有的属性名
        Field[] declaredFields = beanClass.getDeclaredFields();

        //循环所有属性
        for (Field declaredField : declaredFields) {
            declaredField.setAccessible(true);

            //从属性上拿到@Autowired
            Autowired annotation = declaredField.getAnnotation(Autowired.class);

            if (annotation != null) {
                String name = declaredField.getName();
                Object fieldObject = getBean(name);
                declaredField.set(beanInstance, fieldObject);
            }
        }

        return beanInstance;
    }

    /**
     * 获取单例对象
     * @param beanName 对象名字
     * @return 对象实例
     */
    private static Object getSingletonObject(String beanName) {
        //先从一级缓存中拿
        Object bean = singletonObjects.get(beanName);

        //一级缓存没有，从二级缓存拿
        if (bean == null){
            bean = earlySingletonObjects.get(beanName);
            if (bean ==null){
                return null;
            }
        }

        return bean;
    }

}

至此，也算解决了单线程下的循环依赖问题，但是Spring作为一个开源框架，会有很多的扩展点以及使用场景，比如AOP、多线程环境下的使用，那么考虑这两点的话，上边代码就不足以解决这些问题了，敬请期待下篇。

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 215,463评论 6赞 497
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 91,868评论 3赞 391
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 161,213评论 0赞 351
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 57,666评论 1赞 290
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 66,759评论 6赞 388
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,725评论 1赞 294
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,716评论 3赞 415
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,484评论 0赞 270
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,928评论 1赞 307
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 37,233评论 2赞 331
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 39,393评论 1赞 345
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 35,073评论 5赞 340
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,718评论 3赞 324
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 31,308评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,538评论 1赞 268
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 47,338评论 2赞 368
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 44,260评论 2赞 352