Servlet-过滤器

过滤器

过滤器是Servlet2.3规范中定义的一种小型的、可插入的Web组件。

• 用来拦截Servlet容器的请求与响应
• 过滤器封装了一些组件，但有没有不会影响主体功能

如，利用过滤器记录请求和相应的数据、管理会话属性、管理评论。

如何编写过滤器

要实现一个过滤器需要以下步骤操作：
1. 实现javax.servlet.Filter接口
2. 在doFilter方法中实现拦截处理逻辑
3. 配置web.xml文件

下面以druid数据库连接池的过滤器为例：

实现Filter接口

//类WebStatFilter 实现Filter接口，包含三个实现方法
public class WebStatFilter extends AbstractWebStatImpl implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        //web容器创建实例后，执行该init方法,只执行一次
        //获取配置参数 exclusions
      String exclusions = config.getInitParameter("exclusions");
        if (exclusions != null && exclusions.trim().length() != 0) {
            excludesPattern = new  HashSet<String>(Arrays.asList(exclusions.split("\\s*,\\s*")));
        }
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //业务处理方法
        for (String pattern : excludesPattern) {
            if (pathMatcher.matches(pattern, requestURI)) {
                //这里是指，当请求路径是在拦截之外的，则直接转到下一过滤器
                chain.doFilter(request, response);
                return;
            }
        }

    }

    @Override
    public void destroy() {
        //web容器删除过滤器之前调用该方法，只执行一次
    }

    //请求url判断
    public boolean isExclusion(String requestURI) {
        //如果是 excludesPattern 中的请求路径，直接返回true
        for (String pattern : excludesPattern) {
            if (pathMatcher.matches(pattern, requestURI)) {
                return true;
            }
        }

        return false;
    }
}

• init方法：

在init方法中的 FilterConfig可以获取参数初始化的信息，可以获取web.xml中的配置参数，我们可以对这些参数进行一些操作;

• doFilter方法：

在doFilter方法中，参数FilterChain被称为过滤链，用来将请求交给下一个过滤器或servlet组件,其工作方式是由web容器自动传入;

• destroy方法：
  在destroy方法中，我们可能会移除一些状态标识等操作;

配置到web.xml文件中

添加Filter

<filter>
<!-- filterName自定义单需唯一-->
<filter-name>DruidWebStatFilter</filter-name>
<filter-class>com.alibaba.druid.support.http.WebStatFilter</filter-class>
<!-- param参数，这里是druid不需要拦截的静态资源-->
<init-param>
  <param-name>exclusions</param-name>
  <param-value>>*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*</param-value>
</init-param>
</filter>

<!-- 拦截路径-->
<filter-mapping>
<filter-name>DruidWebStatFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>

解析 DruidWebStatFilter 实现 ：
1. 在实现类WebStatFilter实现了Filter接口；
2. 在init方法中获取web.xml的中的exclusions的值，组装到excludesPattern(HashSet)中；
3. 在doFilter方法中，我们看到根据组装的url请求集合，来判断当前请求是否是静态资源，如果是则直接返回true
4. 在destroy方法中，druid移除了当前请求(不需要拦截的静态资源)的记录状态

注：

当存在多个过滤器时，其优先级是根据的先后顺序来调用各个过滤器的。