首页手记 ignoreDependencyInterface和i...

ignoreDependencyInterface和ignoreDependencyType的作用?

标签：

Java Spring

什么是ignoreDependencyInterface和ignoreDependencyType?

相信看过Spring源码的读者一定在遇到过这么两个方法:

/**
* Ignore the given dependency interface for autowiring.
* 忽略给定依赖接口的自动装配 
* @see org.springframework.context.ApplicationContextAware
*/
void ignoreDependencyInterface(Class&lt;?&gt; ifc);

/**
* Ignore the given dependency type for autowiring:
* 忽略给定依赖类型的自动装配
* @param type the dependency type to ignore
*/
void ignoreDependencyType(Class&lt;?&gt; type);

只看官方文档的解释很可能理解错误,作者也去查阅了一些文章,但是描述的还是有点难以理解,于是自己实验证实了一下,话不多说,本文直接通过例子给大家详细证明这两个接口的意思和使用方法.

准备用来实验注入spring容器的bean

首先我们需要准备五个model,作为实验注入Spring容器中的实例对象,如下:

public class User {
    }
    //这个接口类用来测试ignoreDependencyInterface方法，看能否注入User
    public interface UserAware {
        void setUser(User user);
    }

    //这个用来测试ignoreDependencyType方法
    public class Admin {
    }

    //这个就是和上面的做对比，不对它做任何处理
    public class Role {
    }

    //实现了上面的UserAware接口并实现setUser方法，
    //并且将User、Admin、Role属性注入
   public class Person implements UserAware{
    private User user;
    private Admin admin;
    private Role role;

    public User getUser() {
        return user;
    }
    //实现了UserAwre接口的setUser方法
    public void setUser(User user) {
        this.user = user;
    }

    public Admin getAdmin() {
        return admin;
    }
    public void setAdmin(Admin admin) {
        this.admin = admin;
    }

    public Role getRole() {
        return role;
    }
    public void setRole(Role role) {
        this.role = role;
    }
}

上面代码中各个对象之间的关系如下:

其中User、Admin、Role都是空的实例对象,UserAware是个接口,里面有一个setUser(User user)方法,Person类中有User、Admin、Role三个对象属性,并且实现了UserAwre接口和它的方法,然后对所有的属性添加get、set方法.

配置spring注入属性的xml文件

我们需要将上面的实例bean注入到Spring容器中,所以我们配置一个xml,以xml的方式将bean注入到spring容器中,如下:

&lt;?xml version="1.0" encoding="UTF-8"?&gt;

配置启动类

    @Test
    public void testSimpleLoad(){

        XmlBeanFactory beanFactory=new XmlBeanFactory(new ClassPathResource("ignore/beanFactoryTest.xml"));
        //beanFactory.ignoreDependencyInterface(UserAware.class);//测试ignoreDependencyInterface方法作用
        //beanFactory.ignoreDependencyType(Admin.class);//测试ignoreDependencyType方法作用
        Person person = beanFactory.getBean("person", Person.class);
        System.out.println("person"+person);
    }

好了,所需要测试条件,我们都准备好,接下来我们按照下面5条的流程进行测试,每条我都会截图运行结果,我们通过结果就可以分析出最终的结果.

先测试不开启ignoreDependencyInterface方法和ignoreDependency方法的时候,获取person中的属性值有些哪些?
测试开启上面代码第五行,启动ignoreDependencyInterface(UserAware.class)方法后,获取person中的属性值有哪些?
测试关闭上面第五行,开启上面代码第六行,启动ignoreDependency(Admin.class)方法后,获取person中的属性值有哪些?
测试同时启用ignoreDependencyInterface方法和ignoreDependency方法后,获取的person中的属性值有哪些?
上面4的测试是依赖xml配置中default-autowire="byType"测试的,我们把它改成default-autowire="byName"后在测试一次第4条,结果又如何?

测试开始

先测试不开启ignoreDependencyInterface方法和ignoreDependency方法的时候,获取person中的属性值有些哪些?运行结果截图如下:

图中我们可以看出,person中的三个属性值都能获取到.

测试只开启ignoreDependencyInterface(UserAware.class)方法后,运行结果如下图:

上图中我们可以看到person对象中的user属性值为空,说明user属性值在开启了ignoreDependencyInterface(UserAware.class)方法后并不能自动装配到person中(注意,user只是不能自动注入到person对象中,Spring容器中依然有user实例),到这里我们可以得到一个小结论:ignoreDependencyInterface方法是忽略指定接口(UserAwre)的set方法的自动装配!

3.接下来测试只开启ignoreDependency(Admin.class)方法,运行结果如下图:

通过运行结果可以发现,person对象中的admin属性没有被自动装配到person对象中,所以我们得出一个小结论**:ignoreDependency方法忽略指定依赖类型的自动装配,ignoreDependency和ignoreDependencyInterface不同的是一个前者按照class类型进行忽略自动装配,后者按照接口中的set方法进行忽略自动装配.**

4.接下来我们同时开启ignoreDependency和ignoreDependencyInterface方法,运行截图如下: