DelegatingFilterProxy详解

发布时间：2023-05-18

一、什么是DelegatingFilterProxy

在Java Web开发中，filter是对web请求进行预处理和后处理的一种机制。在应用启动时，filter就被初始化，在整个应用程序的生命周期中，每个请求都会经过filter。在原有的filter机制下，每个filter都需要定义一个具体的实现类，这样就会造成代码过多、难以维护等问题。DelegatingFilterProxy是SpringMVC中所提出的一个机制，它可以将具体的filter交由Spring容器来管理，从而使得开发者可以更加便捷地进行filter的管理、维护。

二、 DelegatingFilterProxy的作用

1、初始化及销毁

DelegatingFilterProxy是一个代理类，用于代替具体的filter实现类。在使用DelegatingFilterProxy时，需要在web.xml配置文件中注册filter，并且给filter指定一个beanName，在SpringMVC容器中以该beanName注册一个filter Bean。

2、控制执行顺序

DelegatingFilterProxy可以控制多个filter的执行顺序。在web应用的过滤器链中，每个filter都需要指定一个url-pattern，该url-pattern指定了哪些请求需要被该filter拦截。在多个filter的情况下，如果filter之间存在依赖关系，需要按照一定的顺序执行，否则会出现错误。DelegatingFilterProxy可以通过简单的配置来控制filter的执行顺序。

3、提供更多的配置选项

DelegatingFilterProxy还提供了更多的基于Spring的配置选项。Spring框架提供了大量的扩展选项，DelegatingFilterProxy使得这些扩展选项可以与filter机制进行整合。

三、DelegatingFilterProxy的使用示例

以下代码演示了如何在web.xml文件中声明一个DelegatingFilterProxy，并在SpringMVC配置文件中进行配置：

1、在web.xml文件中声明一个DelegatingFilterProxy

<filter>
    <filter-name>demoFilter</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
    <init-param>
        <param-name>targetBeanName</param-name>
        <param-value>demoFilterBean</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>demoFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

2、在SpringMVC配置文件中注册DelegatingFilterProxy Bean

<bean id="demoFilterBean" class="com.demo.filter.DemoFilterImpl" />

3、在具体的filter实现类中进行配置

public class DemoFilterImpl implements Filter {
    private FilterConfig filterConfig;
    public void destroy() {
        // TODO Auto-generated method stub
        System.out.println("DemoFilter：destroy.");
    }
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("DemoFilter：doFilter.");
        chain.doFilter(request, response);
    }
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
        System.out.println("DemoFilter：init.");
    }
}

四、DelegatingFilterProxy的执行顺序控制

DelegatingFilterProxy还提供了一些控制执行顺序的配置选项。如下代码演示了如何通过DelegatingFilterProxy来控制多个filter的执行顺序：

1、在web.xml文件中声明DelegatingFilterProxy并指定init-param

<filter>
    <filter-name>demoFilter1</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
    <init-param>
        <param-name>targetBeanName</param-name>
        <param-value>demoFilter1Bean</param-value>
    </init-param>
</filter>
<filter>
    <filter-name>demoFilter2</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
    <init-param>
        <param-name>targetBeanName</param-name>
        <param-value>demoFilter2Bean</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>demoFilter1</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>demoFilter2</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

2、在SpringMVC配置文件中注册Filter Bean

<bean id="demoFilter1Bean" class="com.demo.filter.DemoFilter1Impl" />
<bean id="demoFilter2Bean" class="com.demo.filter.DemoFilter2Impl" />

3、在具体Filter实现类中加入@WebFilter注解并指定filterName

在具体的Filter实现类中加入@WebFilter注解并指定filterName。filterName的名称需要与在web.xml中配置的filterName一致。这个配置可以控制filter的执行顺序。

@WebFilter(filterName="demoFilter1")
public class DemoFilter1Impl implements Filter {
    private FilterConfig filterConfig;
    public void destroy() {
        // TODO Auto-generated method stub
        System.out.println("DemoFilter1：destroy.");
    }
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("DemoFilter1：doFilter.");
        chain.doFilter(request, response);
    }
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
        System.out.println("DemoFilter1：init.");
    }
}

@WebFilter(filterName="demoFilter2")
public class DemoFilter2Impl implements Filter {
    private FilterConfig filterConfig;
    public void destroy() {
        // TODO Auto-generated method stub
        System.out.println("DemoFilter2：destroy.");
    }
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        System.out.println("DemoFilter2：doFilter.");
        chain.doFilter(request, response);
    }
    public void init(FilterConfig filterConfig) throws ServletException {
        this.filterConfig = filterConfig;
        System.out.println("DemoFilter2：init.");
    }
}

五、DelegatingFilterProxy的优缺点

1、优点

DelegatingFilterProxy可以将filter代理给Spring容器进行管理，使得开发者可以更加便捷地进行filter的管理、维护。同时也提供了更多的基于Spring的配置选项，使得扩展性更加强。

2、缺点

DelegatingFilterProxy只能代理实现Filter接口的类，无法代理实现javax.servlet.http.HttpServlet的类。另外，由于需要在web.xml中进行配置，对于大型项目来说这可能会导致web.xml文件过于臃肿，不太方便管理。

六、总结

DelegatingFilterProxy是SpringMVC中一个非常重要的机制，通过DelegatingFilterProxy可以将filter交由SpringMVC容器来进行管理。DelegatingFilterProxy提供了多种配置选项，可以控制filter的执行顺序、提供更多的基于Spring的扩展选项等。但是需要注意，由于需要在web.xml中进行配置，可能会导致web.xml文件过于臃肿。

推荐文章