Spring4.3.x 容器中bean的创建过程（5）—— 注册bean的销毁方法

概述

在Spring4.3.x 容器中bean的创建过程（1）——走进初始化bean的主要战场一篇中我们找到了初始化bean的主要场所在AbstractAutowireCapableBeanFactory类中的doCreateBean方法中，在这个方法中首先调用createBeanInstance方法创建bean的实例；然后调用populateBean方法设置bean的属性；接着调用initializeBean方法执行Bean后处理器和InitializingBean对象的afterPropertiesSet方法以及init-method方法；最后调用registerDisposableBeanIfNecessary方法注册bean的销毁方法。它的每一步都比较繁琐，所以我把他们分开来探讨。在 Spring4.3.x 容器中bean的创建过程（2）——实例化Bean一篇中，已经探讨了第一步实例化bean。在 Spring4.3.x 容器中bean的创建过程（3）—— 初始化bean的属性值 中探讨了通过BeanWrapper对象设置bean的属性。在 Spring4.3.x 容器中bean的创建过程（4）—— 执行bean的初始化方法一篇探讨了Spring如何执行bean初始化方法。这一篇探讨bean创建过程中的最后一步——注册bean的销毁方法。

注册bean的销毁方法

AbstractAutowireCapableBeanFactory类中的doCreateBean方法调用它的registerDisposableBeanIfNecessary方法来执行与注册bean的销毁方法的操作，registerDisposableBeanIfNecessary方法的源码如下。

    protected void registerDisposableBeanIfNecessary(String beanName, Object bean, RootBeanDefinition mbd) {
        AccessControlContext acc = (System.getSecurityManager() != null ? getAccessControlContext() : null);
        // 检测bean是否需要注册消费方法
        if (!mbd.isPrototype() && requiresDestruction(bean, mbd)) {
            if (mbd.isSingleton()) {
                // 注册单例bean的销毁方法
                registerDisposableBean(beanName,
                        new DisposableBeanAdapter(bean, beanName, mbd, getBeanPostProcessors(), acc));
            } else {
                // 自定义的作用域
                Scope scope = this.scopes.get(mbd.getScope());
                if (scope == null) {
                    throw new IllegalStateException("No Scope registered for scope name '" + mbd.getScope() + "'");
                }
                // 在自定义作用域小注册销毁方法
                scope.registerDestructionCallback(beanName,
                        new DisposableBeanAdapter(bean, beanName, mbd, getBeanPostProcessors(), acc));
            }
        }
    }

对于作用域为prototype的，Spring不会为其注册销毁方法。另外registerDisposableBeanIfNecessary方法还会调用requiresDestruction方法检测bean是否需要注册销毁方法。如果bean需要注册消费方法，registerDisposableBeanIfNecessary把进一步根据作用域把bean分成两类，一类是singleton作用域的bean，另一类是自定义作用域的bean。

（1）检测bean是否需要注册销毁方法

registerDisposableBeanIfNecessary方法还会调用AbstractAutowireCapableBeanFactory类的requiresDestruction方法检测bean是否需要注册销毁方法。requiresDestruction方法的源码如下。

    protected boolean requiresDestruction(Object bean, RootBeanDefinition mbd) {
        return (bean != null &&
                (DisposableBeanAdapter.hasDestroyMethod(bean, mbd) || (hasDestructionAwareBeanPostProcessors() &&
                        DisposableBeanAdapter.hasApplicableProcessors(bean, getBeanPostProcessors()))));
    }

在requiresDestruction方法中，判断bean是否需要注册销毁方法，只需要满足以下两个条件之一。
a. 配置bean的时候，从bean的方法中选择了一个销毁方法
b. 容器中注册了能够处理被检测bean并实现了DestructionAwareBeanPostProcessor接口的bean后处理器。

a. requiresDestruction方法调用DisposableBeanAdapter的hasDestroyMethod方法判断bean是否有销毁方法，hasDestroyMethod方法源码如下。

    public static boolean hasDestroyMethod(Object bean, RootBeanDefinition beanDefinition) {
        // 检测bean是否实现了DisposableBean接口
        // JDK1.7以上版本的，检测bean是否实现了AutoCloseable接口
        if (bean instanceof DisposableBean || closeableInterface.isInstance(bean)) {
            return true;
        }

        // 获取配置的销毁方法
        String destroyMethodName = beanDefinition.getDestroyMethodName();
        // 定义有public static final String INFER_METHOD = "(inferred)";
        if (AbstractBeanDefinition.INFER_METHOD.equals(destroyMethodName)) {
            // 定义有CLOSE_METHOD_NAME = "close"
            // 定义有SHUTDOWN_METHOD_NAME = "shutdown"
            return (ClassUtils.hasMethod(bean.getClass(), CLOSE_METHOD_NAME) ||
                    ClassUtils.hasMethod(bean.getClass(), SHUTDOWN_METHOD_NAME));
        }
        return StringUtils.hasLength(destroyMethodName);
    }

b. requiresDestruction方法调用DisposableBeanAdapter的hasApplicableProcessors方法判断是否有bean后处理器来处理bean的销毁，hasApplicableProcessors方法的源码如下。

    public static boolean hasApplicableProcessors(Object bean, List<BeanPostProcessor> postProcessors) {
        if (!CollectionUtils.isEmpty(postProcessors)) {
            for (BeanPostProcessor processor : postProcessors) {
                if (processor instanceof DestructionAwareBeanPostProcessor) {
                    DestructionAwareBeanPostProcessor dabpp = (DestructionAwareBeanPostProcessor) processor;
                    try {
                        if (dabpp.requiresDestruction(bean)) {
                            return true;
                        }
                    } catch (AbstractMethodError err) {
                        // Spring4.3之前版本的第三方DestructionAwareBeanPostProcessor
                        return true;
                    }
                }
            }
        }
        return false;
    }

（2）为singleton的bean注册销毁方法

registerDisposableBeanIfNecessary方法还会调用AbstractAutowireCapableBeanFactory类的registerDisposableBean方法检测bean是否需要注册销毁方法。registerDisposableBean方法的源码如下。

    public void registerDisposableBean(String beanName, DisposableBean bean) {
        synchronized (this.disposableBeans) {
            this.disposableBeans.put(beanName, bean);
        }
    }

（3）为自定义作用域的bean注册销毁方法

registerDisposableBeanIfNecessary方法还会调用Scope 对象的registerDestructionCallback方法检测bean是否需要注册销毁方法。这里我们以作用域为request为例，request作用域的处理类为RequestScope，它的registerDestructionCallback方法继承自AbstractRequestAttributesScope抽象类，的源码如下。

    @Override
    public void registerDestructionCallback(String name, Runnable callback) {
        RequestAttributes attributes = RequestContextHolder.currentRequestAttributes();
        attributes.registerDestructionCallback(name, callback, getScope());
    }

下面是ServletRequestAttributes类实现的registerDestructionCallback方法

    @Override
    public void registerDestructionCallback(String name, Runnable callback, int scope) {
        if (scope == SCOPE_REQUEST) {
            // 注册request作用域的销毁方法
            registerRequestDestructionCallback(name, callback);
        } else {
            // 注册session作用域的销毁方法
            registerSessionDestructionCallback(name, callback);
        }
    }

下面的代码是注册request作用域的销毁方法的源码。

    protected final void registerRequestDestructionCallback(String name, Runnable callback) {
        Assert.notNull(name, "Name must not be null");
        Assert.notNull(callback, "Callback must not be null");
        synchronized (this.requestDestructionCallbacks) {
            this.requestDestructionCallbacks.put(name, callback);
        }
    }

下面的代码是注册session作用域的销毁方法的源码。

    public static final String DESTRUCTION_CALLBACK_NAME_PREFIX =
            ServletRequestAttributes.class.getName() + ".DESTRUCTION_CALLBACK.";

    protected void registerSessionDestructionCallback(String name, Runnable callback) {
        HttpSession session = getSession(true);
        session.setAttribute(DESTRUCTION_CALLBACK_NAME_PREFIX + name,
                new DestructionCallbackBindingListener(callback));
    }

总结

从AbstractAutowireCapableBeanFactory类的requiresDestruction方法中，我们可以总结出通过以下方式之一可以为bean提供销毁方法。

（1）在xml配置中通过destroy-method属性或者在java代码中通过@PreDestroy注解指定销毁方法

（2）在xml配置中通过destroy-method=”(inferred)”指定销毁方法为shutdown()方法或者close()方法。当然如果这两个方法同时存在，那么最终选择的销毁方法为close()方法。

（3）通过实现DisposableBean接口或者实现AutoCloseable接口（JDK1.7以上）提供销毁方法

（4）通过实现DestructionAwareBeanPostProcessor接口的bean后处理器提供销毁逻辑