Spring源码分析(一)——DelegatingFilterProxy

在开发web项目时,经常需要添加自己的filter,在web.xml文件中一般都这么定义自己的filter,filter的name是自己定义的beanName,class一般都是使用org.springframework.web.filter.DelegatingFilterProxy。 配置如下:

<filter>
    <filter-name>userInfoFilter</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>

<filter-mapping>
    <filter-name>userInfoFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

DelegatingFilterProxy 是Spring的一个类,它实现了GenericFilterBean,而GenericFilterBean又实现了javax.servlet.Filter接口,并对Filter的init方法进行了重写,而Filter的doFilter交给其子类去实现。而GenericFilterBean的init方法内部调用了GenericFilterBean的initFilterBean方法。该方法的默认实现为空,其采用了模板方法的设计模式交给其子类去实现initFilterBean的具体逻辑。

public final void init(FilterConfig filterConfig) throws ServletException {
    //...此处省略部分代码
    // Let subclasses do whatever initialization they like
    initFilterBean();
    //...此处省略部分代码
}

现在,来看看DelegatingFilterProxy的initFilterBean的现实代码

@Override
protected void initFilterBean() throws ServletException {
    synchronized (this.delegateMonitor) {
        if (this.delegate == null) {
            // If no target bean name specified, use filter name.
            if (this.targetBeanName == null) {
                this.targetBeanName = getFilterName();
            }
            // Fetch Spring root application context and initialize the delegate early,
            // if possible. If the root application context will be started after this
            // filter proxy, we'll have to resort to lazy initialization.
            WebApplicationContext wac = findWebApplicationContext();
            if (wac != null) {
                this.delegate = initDelegate(wac);
            }
        }
    }
}

该方法中有两处关键的地方this.targetBeanName = getFilterName()与WebApplicationContext wac = findWebApplicationContext()。前者得到web.xml中filter对应的名字,将其赋予为targetBeanName;后者 得到一个WebApplicationContex对象,这个接口大家应该很熟悉其续承了ApplicationContext,而通过其getBean方法我们便可以得到在application-context.xml配置文件中配置的bean。 先来看看 initDelegate对应的代码:

protected Filter initDelegate(WebApplicationContext wac) throws ServletException {
    Filter delegate = wac.getBean(getTargetBeanName(), Filter.class);
    if (isTargetFilterLifecycle()) {
        delegate.init(getFilterConfig());
    }
    return delegate;
}

Filter delegate = wac.getBean(getTargetBeanName(), Filter.class),便是利用我们在web.xml配置文件设置的<filter-name>userInfoFilter</filter-name>去application-context.xml配置文件中找到具体的实现类。 所以,在application-context.xml文件中bean对应的id一定要与web.xml中的filter-name一致。