Spring如何解决循环依赖

Cycle Dependency in Spring

Posted by S.L on August 23, 2020

本文主要总结Spring依赖注入的循环依赖问题。

基本概念

1.通常来说,如果问Spring内部如何解决循环依赖,一定是单默认的单例Bean中,属性互相引用的场景。

2.原型(Prototype)的场景是不支持循环依赖的,通常会走到AbstractBeanFactory类中下面的判断,抛出异常。

if (isPrototypeCurrentlyInCreation(beanName)) {
    throw new BeanCurrentlyInCreationException(beanName);
}

Spring会抛出BeanCurrentlyInCreationException而不会导致OOM或者StackOverflow。

3.解决循环依赖一定是不能基于构造器实现的,因为构造器是构造对象的基本,无法跨过循环依赖这个坑。

Spring如何解决

在Spring的DefaultSingletonBeanRegistry类中,有三个Map:

  • singletonObjects 俗称“单例池”、“容器”,缓存创建完成单例Bean的地方
  • singletonFactories 映射创建Bean的原始工厂
  • earlySingletonObjects 映射Bean的早期引用,也就是说在这个Map里的Bean不是完整的,甚至还不能称之为“Bean”,只是一个Instance

形象的比喻:Spring准备了两个杯子,即singletonFactoriesearlySingletonObjects 来回“倒腾”几番,把热水晾成“凉白开”放到singletonObjects中。

伪代码

下面的代码来自Vt,很好的展示了从创建实例到暂存实例对象、再到注入自身依赖的属性实例的过程,通过递归实例化,以及缓存中间的「半成品」 实例的引用来完成最后全部的实例都完全实例化的过程:


    /**
     * 放置创建好的bean Map
     */
    private static Map<String, Object> cacheMap = new HashMap<>(2);

    public static void main(String[] args) {
        // 假装扫描出来的对象
        Class[] classes = {A.class, B.class};
        // 假装项目初始化实例化所有bean
        for (Class aClass : classes) {
            getBean(aClass);
        }
        // check
        System.out.println(getBean(B.class).getA() == getBean(A.class));
        System.out.println(getBean(A.class).getB() == getBean(B.class));
    }

    @SneakyThrows
    private static <T> T getBean(Class<T> beanClass) {
        // 本文用类名小写 简单代替bean的命名规则
        String beanName = beanClass.getSimpleName().toLowerCase();
        // 如果已经是一个bean,则直接返回
        if (cacheMap.containsKey(beanName)) {
            return (T) cacheMap.get(beanName);
        }
        // 将对象本身实例化
        Object object = beanClass.getDeclaredConstructor().newInstance();
        // 放入缓存
        cacheMap.put(beanName, object);
        // 把所有字段当成需要注入的bean,创建并注入到当前bean中
        Field[] fields = object.getClass().getDeclaredFields();
        for (Field field : fields) {
            field.setAccessible(true);
            // 获取需要注入字段的class
            Class<?> fieldClass = field.getType();
            String fieldBeanName = fieldClass.getSimpleName().toLowerCase();
            // 如果需要注入的bean,已经在缓存Map中,那么把缓存Map中的值注入到该field即可
            // 如果缓存没有属性的实例 继续创建
            field.set(object, cacheMap.containsKey(fieldBeanName)
                    ? cacheMap.get(fieldBeanName) : getBean(fieldClass));
        }
        // 属性填充完成,返回
        return (T) object;
    }

引申

通过这种暂存的思路,可以想到有很多题目都是基于该思路的,如2sum问题,这道题的优解是,一次遍历+HashMap:

class Solution {
    public int[] twoSum(int[] nums, int target) {
        Map<Integer, Integer> map = new HashMap<>();
        for (int i = 0; i < nums.length; i++) {
            int complement = target - nums[i];
            if (map.containsKey(complement)) {
                return new int[] { map.get(complement), i };
            }
            map.put(nums[i], i);
        }
        throw new IllegalArgumentException("No two sum solution");
    }
}

Reference

本文首次发布于 S.L’s Blog, 作者 @stuartlau , 转载请保留原文链接.