总:FactoryBean的实现原理与作用

FactoryBean与BeanFactory:

这俩货在拼写上很是相似,很多同学在看IOC源码或者其他地方并不能分清有啥区别,前面的IOC源码中我简单说过,现在统一简单来讲一下:

  • FactoryBean:是一个Java Bean,但是它是一个能生产对象的工厂Bean,它的实现和工厂模式及修饰器模式很像。比如下:我们把bean比作 是人,那么FactoryBean可以算是一个女人,首先它本身也是一个人,但它能够生产人。

  • BeanFactory: 这就是一个Factory,是一个IOC容器或者叫对象工厂,它里面存着很多的bean。还用上面那个比如:如果bean是人,那么它可以理解成学校,学校里面很多人,学校管理这么多的人。

FactoryBean在IOC的应用:

前面我们在看IOC源码的时候,发现即使我们已经创建出来了对象的实例,还是要走一个方法再处理下,这里就是对FactoryBean的处理,因为它可以产生对象,所以你getBean的时候取到的不是它本身,而是通过它生成的产品。[如果要取它本身,getBean(&+beanName)]我们先来回忆下IOC源码中那个处理FactoryBean的简略代码:

AbstractBeanFactory类的dogetBean方法

protected <T> T doGetBean(
            final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly)
            throws BeansException {

        final String beanName = transformedBeanName(name);
        Object bean;

        // Eagerly check singleton cache for manually registered singletons.
        Object sharedInstance = getSingleton(beanName);
        if (sharedInstance != null && args == null) {
            if (logger.isDebugEnabled()) {
                if (isSingletonCurrentlyInCreation(beanName)) {
                    logger.debug("Returning eagerly cached instance of singleton bean '" + beanName +
                            "' that is not fully initialized yet - a consequence of a circular reference");
                }
                else {
                    logger.debug("Returning cached instance of singleton bean '" + beanName + "'");
                }
            }
            bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
        }

        else {
            // Fail if we're already creating this bean instance:
            // We're assumably within a circular reference.
            if (isPrototypeCurrentlyInCreation(beanName)) {
                throw new BeanCurrentlyInCreationException(beanName);
            }

            // Check if bean definition exists in this factory.
            BeanFactory parentBeanFactory = getParentBeanFactory();
            if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
                // Not found -> check parent.
                String nameToLookup = originalBeanName(name);
                if (args != null) {
                    // Delegation to parent with explicit args.
                    return (T) parentBeanFactory.getBean(nameToLookup, args);
                }
                else {
                    // No args -> delegate to standard getBean method.
                    return parentBeanFactory.getBean(nameToLookup, requiredType);
                }
            }

            if (!typeCheckOnly) {
                markBeanAsCreated(beanName);
            }

            try {
                final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
                checkMergedBeanDefinition(mbd, beanName, args);

                // Guarantee initialization of beans that the current bean depends on.
                String[] dependsOn = mbd.getDependsOn();
                if (dependsOn != null) {
                    for (String dep : dependsOn) {
                        if (isDependent(beanName, dep)) {
                            throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                    "Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
                        }
                        registerDependentBean(dep, beanName);
                        getBean(dep);
                    }
                }

                // Create bean instance.
                if (mbd.isSingleton()) {
                    sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
                        @Override
                        public Object getObject() throws BeansException {
                            try {
                                return createBean(beanName, mbd, args);
                            }
                            catch (BeansException ex) {
                                // Explicitly remove instance from singleton cache: It might have been put there
                                // eagerly by the creation process, to allow for circular reference resolution.
                                // Also remove any beans that received a temporary reference to the bean.
                                destroySingleton(beanName);
                                throw ex;
                            }
                        }
                    });
                    bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
                }

                else if (mbd.isPrototype()) {
                    // It's a prototype -> create a new instance.
                    Object prototypeInstance = null;
                    try {
                        beforePrototypeCreation(beanName);
                        prototypeInstance = createBean(beanName, mbd, args);
                    }
                    finally {
                        afterPrototypeCreation(beanName);
                    }
                    bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
                }

                else {
                    String scopeName = mbd.getScope();
                    final Scope scope = this.scopes.get(scopeName);
                    if (scope == null) {
                        throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
                    }
                    try {
                        Object scopedInstance = scope.get(beanName, new ObjectFactory<Object>() {
                            @Override
                            public Object getObject() throws BeansException {
                                beforePrototypeCreation(beanName);
                                try {
                                    return createBean(beanName, mbd, args);
                                }
                                finally {
                                    afterPrototypeCreation(beanName);
                                }
                            }
                        });
                        bean = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
                    }
                    catch (IllegalStateException ex) {
                        throw new BeanCreationException(beanName,
                                "Scope '" + scopeName + "' is not active for the current thread; consider " +
                                "defining a scoped proxy for this bean if you intend to refer to it from a singleton",
                                ex);
                    }
                }
            }
            catch (BeansException ex) {
                cleanupAfterBeanCreationFailure(beanName);
                throw ex;
            }
        }

        // Check if required type matches the type of the actual bean instance.
        if (requiredType != null && bean != null && !requiredType.isInstance(bean)) {
            try {
                return getTypeConverter().convertIfNecessary(bean, requiredType);
            }
            catch (TypeMismatchException ex) {
                if (logger.isDebugEnabled()) {
                    logger.debug("Failed to convert bean '" + name + "' to required type '" +
                            ClassUtils.getQualifiedName(requiredType) + "'", ex);
                }
                throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
            }
        }
        return (T) bean;
    }

我们可以看到,无论是直接取单例的bean,还是创建单例、多例、自定义生命周期的bean,都会经过bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);这个方法,我们现在就来看看这里到底做了什么:

AbstractBeanFactory类的getObjectForBeanInstance方法

    protected Object getObjectForBeanInstance(
            Object beanInstance, String name, String beanName, RootBeanDefinition mbd) {

        // Don't let calling code try to dereference the factory if the bean isn't a factory.
        if (BeanFactoryUtils.isFactoryDereference(name) && !(beanInstance instanceof FactoryBean)) {
            throw new BeanIsNotAFactoryException(transformedBeanName(name), beanInstance.getClass());
        }

        // Now we have the bean instance, which may be a normal bean or a FactoryBean.
        // If it's a FactoryBean, we use it to create a bean instance, unless the
        // caller actually wants a reference to the factory.
        if (!(beanInstance instanceof FactoryBean) || BeanFactoryUtils.isFactoryDereference(name)) {
            return beanInstance;
        }

        Object object = null;
        if (mbd == null) {
            object = getCachedObjectForFactoryBean(beanName);
        }
        if (object == null) {
            // Return bean instance from factory.
            FactoryBean<?> factory = (FactoryBean<?>) beanInstance;
            // Caches object obtained from FactoryBean if it is a singleton.
            if (mbd == null && containsBeanDefinition(beanName)) {
                mbd = getMergedLocalBeanDefinition(beanName);
            }
            boolean synthetic = (mbd != null && mbd.isSynthetic());
            object = getObjectFromFactoryBean(factory, beanName, !synthetic);
        }
        return object;
    }

这里有必要单独说一下解引用:
Dereference(解引用):一个在C/C++中应用的比较多术语,在C++中, "*"是解引用符号,"&"是引用符号。

解引用:变量所指向的是所引用对象的本身数据,而不是对象的内存地址。

上面的代码可以看到,对于大多数bean的getBean,一般走到第二步就返回了,也就是说我们创建的Bean对象就是想要的bean,但对于FactoryBean的创建,如果是对内存地址的引用,那么取到的是它生产的bean,而不是它本身。所以我们继续看怎么取到生产的对象的:

FactoryBeanRegistrySupport类的getObjectFromFactoryBean方法

protected Object getObjectFromFactoryBean(FactoryBean factory,  
        String beanName, boolean shouldPostProcess) {  
    // Bean工厂是单态模式,并且Bean工厂缓存中存在指定名称的Bean实例对象  
    if (factory.isSingleton() && containsSingleton(beanName)) {  
        synchronized (getSingletonMutex()) {  
            // 直接从Bean工厂缓存中获取指定名称的Bean实例对象  
            Object object = this.factoryBeanObjectCache.get(beanName);  
            // Bean工厂缓存中没有指定名称的实例对象,则生产该实例对象  
            if (object == null) {  
                // 调用Bean工厂的getObject方法生产指定Bean的实例对象  
                object = doGetObjectFromFactoryBean(factory, beanName,  
                        shouldPostProcess);  
                // 将生产的实例对象添加到Bean工厂缓存中  
                this.factoryBeanObjectCache.put(beanName,  
                        (object != null ? object : NULL_OBJECT));  
            }  
            return (object != NULL_OBJECT ? object : null);  
        }  
    }  
    // 调用Bean工厂的getObject方法生产指定Bean的实例对象  
    else {  
        return doGetObjectFromFactoryBean(factory, beanName,  
                shouldPostProcess);  
    }  
}  

//调用Bean工厂的getObject方法生产指定Bean的实例对象    
   private Object doGetObjectFromFactoryBean(    
           final FactoryBean factory, final String beanName, final boolean shouldPostProcess)    
           throws BeanCreationException {    
       Object object;    
       try {    
           if (System.getSecurityManager() != null) {    
               AccessControlContext acc = getAccessControlContext();    
               try {    
                   //实现PrivilegedExceptionAction接口的匿名内置类    
                   //根据JVM检查权限,然后决定BeanFactory创建实例对象    
                   object = AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() {    
                       public Object run() throws Exception {    
                               //调用BeanFactory接口实现类的创建对象方法    
                               return factory.getObject();    
                           }    
                       }, acc);    
               }    
               catch (PrivilegedActionException pae) {    
                   throw pae.getException();    
               }    
           }    
           else {    
            //调用BeanFactory接口实现类的创建对象方法    
               object = factory.getObject();    
           }    
       }    
       catch (FactoryBeanNotInitializedException ex) {    
           throw new BeanCurrentlyInCreationException(beanName, ex.toString());    
       }    
       catch (Throwable ex) {    
           throw new BeanCreationException(beanName, "FactoryBean threw exception on object creation", ex);    
       }    
       //创建出来的实例对象为null,或者因为单态对象正在创建而返回null    
       if (object == null && isSingletonCurrentlyInCreation(beanName)) {    
           throw new BeanCurrentlyInCreationException(    
                   beanName, "FactoryBean which is currently in creation returned null from getObject");    
       }    
       //为创建出来的Bean实例对象添加BeanPostProcessor后置处理器    
       if (object != null && shouldPostProcess) {    
           try {    
               object = postProcessObjectFromFactoryBean(object, beanName);    
           }    
           catch (Throwable ex) {    
               throw new BeanCreationException(beanName, "Post-processing of the FactoryBean's object failed", ex);    
           }    
       }    
       return object;    
   }

第一个方法就是区分单例还是多例,第二个方法是真真的调用getObject的方法获得FactoryBean生产的对象。从代码中可以看到,具体产生Bean的地方时这个getObject方法,Spring为这个FactoryBean提供了70多个实现,比如Poxy、JDNI、RMI等等。所以我们不再举例,看个截图,下面我们将自己动手实现一个FactoryBean。

FactoryBean的举例理解

我们先来看下FactoryBean的接口定义:

public interface FactoryBean<T> {
    T getObject() throws Exception;
    Class<?> getObjectType();
    boolean isSingleton();
}

所以:FactoryBean的核心就在于能过getObject方法可以获取的是它所生产的对象,所以我们在Proxy创建代理对象的时候就比较方便。还有一些bean,如果通过配置的方式,会显得比较麻烦和复杂,那么这时候适当的采用编码方式在某些场合下还是挺不错的。

我们下面就通过一个简单的例子来体验下getObject方法[讲道理,这里实际意义不多,重在理解方法含义]
假如:我们有个Person对象,里面包含name, address, age属性

public class Person {  
    private String name;  
    private String address;  
    private int age;  
}

那如果我们要在Spring中配置该对象的话,需要这么配置:

<bean id="personBean" class="com.gh.MavenTest.Person">  
    <property name="name" value="gh1" />  
    <property name="address" value="address1" />  
    <property name="age" value="28" />  
</bean>

那么现在我们可以通过getBean("personBean")来获取该对象。那么我们来看下如果通过实现FactoryBean以后该怎么写呢?来看下我们的PersonFactory的代码:

public class PersonFactoryBean implements FactoryBean<Person>{  

    private String personInfo;  

    public Person getObject() throws Exception {  
        Person person =  new  Person () ;      
        String []  infos =  personInfo.split ( "," ) ;  
        person.setName(infos[0]);  
        person.setAddress(infos[1]);  
        person.setAge(Integer.parseInt(infos[2]));  
        return person;  
    }  

    public Class<Person> getObjectType() {  
        return Person.class;  
    }  

    public boolean isSingleton() {  
        return true;  
    }  
}

我们看到,这里PersonFactoryBean实现了FactoryBean接口,那么自然也要实现它定义的方法。这里我们是通过personInfo字符串解析得到Person对象,那么我们在配置Spring的时候就可以这么配置:

<bean id="personFactory" class="com.hik.MavenTest.PersonFactory">  
    <property name="personInfo" value="gh2,address2,22"></property>  
</bean>

OK,那么这个时候我们getBean("personFactory")得到的就是Person对象而不是PersonFactoryBean对象。具体原理参考上面在IOC的应用,我们通过bean = getObjectForBeanInstance(sharedInstance, name, beanName, null)这个方法,具体调用到了getObject方法,所以结果很明显。

通过上面的小案例的代码,我们可以看到如果一个类实现了FactoryBean接口,那么getBean得到的不是他本身了,而是它所生产的对象,如果我们希望得到它本身,只需要加上&符号即可。至于FactoryBean的实际应用,需要大家去发现理解,后面如果有机会继续聊聊这个东西。

results matching ""

    No results matching ""