DelegatingFilterProxy的作用与用法

一、类结构

　　DelegatingFilterProxy类存在与spring-web包中，其作用就是一个filter的代理，用这个类的好处是可以通过spring容器来管理filter的生命周期，还有就是，可以通过spring注入的形式，来代理一个filter执行，如shiro，下面会说到；有上图我们可以看到，DelegatingFilterProxy类继承GenericFilterBean，间接实现了Filter这个接口，故而该类属于一个过滤器。那么就会有实现Filter中init、doFilter、destroy三个方法。

二、代理具体实现

　　首先我们看init方法，我们知道当filter初始化时会执行init方法，从源码中我们可以找到具体代码，该方法在GenericFilterBean类中实现，具体功能是，将该类封装成spring特有形式的类，方便spring维护，并且调用initFilterBean方法，该方法放在子类（DelegatingFilterProxy）实现，该方法主要目的是，找到在spring中维护的目标filter，具体实现看下面代码：

/**
 * Standard way of initializing this filter.
 * Map config parameters onto bean properties of this filter, and
 * invoke subclass initialization.
 * @param filterConfig the configuration for this filter
 * @throws ServletException if bean properties are invalid (or required
 * properties are missing), or if subclass initialization fails.
 * @see #initFilterBean
 */
@Override
public final void init(FilterConfig filterConfig) throws ServletException {
   Assert.notNull(filterConfig, "FilterConfig must not be null");
   if (logger.isDebugEnabled()) {
      logger.debug("Initializing filter '" + filterConfig.getFilterName() + "'");
   }
　　
   this.filterConfig = filterConfig;

   // Set bean properties from init parameters.
   try {
　　　　//将该类封装成spring特有的bean形式，方便spring维护
      PropertyValues pvs = new FilterConfigPropertyValues(filterConfig, this.requiredProperties);
      BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
      ResourceLoader resourceLoader = new ServletContextResourceLoader(filterConfig.getServletContext());
      bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, this.environment));
      initBeanWrapper(bw);
      bw.setPropertyValues(pvs, true);
   }
   catch (BeansException ex) {
      String msg = "Failed to set bean properties on filter '" +
         filterConfig.getFilterName() + "': " + ex.getMessage();
      logger.error(msg, ex);
      throw new NestedServletException(msg, ex);
   }

   // 该方法在子类中实现，我们可以到DelegatingFilterPoxy中去看看，具体完成了那些工作？
　　//1、找到要代理bean的id--》targetBeanName
　　//2、在spring，bean容器中找到具体被代理的filter--》delegate

   initFilterBean();

   if (logger.isDebugEnabled()) {
      logger.debug("Filter '" + filterConfig.getFilterName() + "' configured successfully");
   }
}

initFilterBean()该方法主要完成两个功能：

1、找到被代理类在spring中配置的id并赋值给targetBeanName。

2、使用找到的id从spring容器中找到具体被代理的类，并赋值给delegate

@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) {
　　　　　　 //找到要被代理的filter在spring中配置的id
            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) {
　　　　　　  //找到具体被代理的filter
            this.delegate = initDelegate(wac);
         }
      }
   }
}

getFilterName()该方法的作用是，获取被代理的filter在spring中配置的id

protected final String getFilterName() {
　　//找到被代理filter在spring中配置的id
   return (this.filterConfig != null ? this.filterConfig.getFilterName() : this.beanName);
}

initDelegate()该方法的作用是，从spring容器中获取到具体被代理的filter　

//找到被代理的filter
protected Filter initDelegate(WebApplicationContext wac) throws ServletException {
   Filter delegate = wac.getBean(getTargetBeanName(), Filter.class);
   if (isTargetFilterLifecycle()) {
      delegate.init(getFilterConfig());
   }
   return delegate;
}

到这里我们可以看出来，我们要代理的filter其实就是我们配置filter中的filter-name标签中的filterName了

<filter-name>filterName</filter-name>

我们在来看看doFilter方法具体实现，该方法主要是使用被代理的filter，并调用invokeDelegate方法，
执行被代理filter的doFilter方法，具体实现，请看下面源码：

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
      throws ServletException, IOException {

   // 得到被代理的filter
   Filter delegateToUse = this.delegate;
   if (delegateToUse == null) {
      synchronized (this.delegateMonitor) {
         if (this.delegate == null) {
            WebApplicationContext wac = findWebApplicationContext();
            if (wac == null) {
               throw new IllegalStateException("No WebApplicationContext found: no ContextLoaderListener registered?");
            }
            this.delegate = initDelegate(wac);
         }
         delegateToUse = this.delegate;
      }
   }

   // 执行被代理filter的doFilter方法
   invokeDelegate(delegateToUse, request, response, filterChain);
}

invokeDelegate方法的作用就是执行被代理filter的doFilter方法

protected void invokeDelegate(
      Filter delegate, ServletRequest request, ServletResponse response, FilterChain filterChain)
      throws ServletException, IOException {

   delegate.doFilter(request, response, filterChain);
}

看到这里我相信大家都明白DelegatingFilterPoxy是怎么回事了吧。下面我们看看spring+shiro是如何运用这个类的

三、运用
　　首先我们看web.xml具体配置，注意<filter-name>中配置的name，以name为id在spring的bean配置中找得到对应的bean

<!-- Shiro Security filter-->
　　<filter>
    　　<filter-name>shiroFilter</filter-name>
    　　<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
    　　<init-param>
        　　<param-name>targetFilterLifecycle</param-name>
        　　<param-value>true</param-value>
    　　</init-param>
　　</filter>
　　<filter-mapping>
    　　<filter-name>shiroFilter</filter-name>
    　　<url-pattern>/*</url-pattern>
    　　<dispatcher>REQUEST</dispatcher>
    　　<dispatcher>ERROR</dispatcher>
　　</filter-mapping>

　spring对于代理filter配置

<bean id="shiroFilter" class="com.auth.SpringShiroFilter"/>

来源：oschina

链接：https://my.oschina.net/u/582040/blog/3033201

标签

shiro

delegate

Spring