Javaweb-Filter-1-快速入门

Filter快速入门

开始学习Filter这个知识点，单词是过滤器和拦截器的作用。Filter是Javaweb中的过滤器，可以拦截所有访问web资源的请求或响应操作。Filter这个知识点很重要，在javaweb开发中，这个是我们需要重点掌握的一个知识点。

1.使用场景

使用Filter主要场景是拦截判断是否登录，权限管理，例如不同角色权限是不同，请求在这个角色之外的操作会被拦截。还有一个使用场景就是全局给项目中全部servlet都设置UTF-8编码，防止中文乱码的情况。

这里，我们来看线上产品，某一家公司的登录拦截，使用了Filter，我们看看效果。

本文出自51CTO博客作者凯哥Java（微信号：kaigejava），未经同意不得转载

浏览器打开

点击上图中，红圈的结构式检索，看看登录拦截效果。

立马就让你去登录，这个就是一个典型的使用Filter的场景。

这里简单来分析一下这个拦截过程：

1） 用户没有登录，点击结构式检索这个请求

2） 这个请求发送到服务器上对应的Servlet处理之前被Filter给拦截了

3） 在Filter中代码先从session中取出用户数据，看看用户是否存在

4） 如果用户是null，说明没有登录，需要拦截

5） 如果用户是数据库中存在用户，放开拦截，让请求继续下去

下面，我们来一个Filter快速入门的练习，体会一下这个拦截和放行的过程。

2.Filter快速入门步骤

1）创建一个类实现Filter接口

2）重写接口中方法，doFilter方法是真正过滤的。

3）在web.xml文件中配置

在Filter的doFilter方法内如果没有执行chain.doFilter(request,response),那么资源是不会被访问到的。

3.Filter入门练习

创建一个web项目

新建一个Servlet类，待会要用，模拟我们的上面这个结构式检索对应的Servlet。

import java.io.IOException;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

public class ServletDemo1 extends HttpServlet {

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

        System.out.println("ServletDemo1运行了");

    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

        doGet(request, response);

    }

}

新建一个Filter类，实现Filter接口

重写doFilter方法

package com.kaigejava.filter;

import java.io.IOException;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletException;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

public class MyFilter implements Filter {

    @Override

    public void destroy() {

    }

    @Override

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

            throws IOException, ServletException {

        System.out.println("doFilter执行了");

    }

    @Override

    public void init(FilterConfig filterConfig) throws ServletException {

    }

}

编辑web.xml，添加filter配置

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://java.sun.com/xml/ns/javaee" xsi:schemaLocation="https://java.sun.com/xml/ns/javaee https://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">

 <display-name>FilterDemo</display-name>

 <welcome-file-list>

   <welcome-file>index.html</welcome-file>

   <welcome-file>index.htm</welcome-file>

   <welcome-file>index.jsp</welcome-file>

   <welcome-file>default.html</welcome-file>

   <welcome-file>default.htm</welcome-file>

   <welcome-file>default.jsp</welcome-file>

 </welcome-file-list>

 <filter>

     <filter-name>MyFilter</filter-name>

     <filter-class>com.anthony.filter.MyFilter</filter-class>

 </filter>

 <filter-mapping>

     <filter-name>MyFilter</filter-name>

     <url-pattern>/*</url-pattern>

 </filter-mapping>

 <servlet>

   <description></description>

   <display-name>ServletDemo1</display-name>

   <servlet-name>ServletDemo1</servlet-name>

   <servlet-class>com.anthony.servlet.ServletDemo1</servlet-class>

 </servlet>

 <servlet-mapping>

   <servlet-name>ServletDemo1</servlet-name>

   <url-pattern>/servletDemo1</url-pattern>

 </servlet-mapping>

</web-app>

运行测试一下

添加到tomcat服务器管理，启动服务，浏览器访问下

发现只在控制台输出“doFilter执行了“，并没有执行/servlet/Demo1中的打印语句，这是为什么呢？

这里解释下，我们当前代码只做了拦截，请求无法往下走，所以servlet中的打印语句没有输出，这个时候，如果想要输出打印语句，就需要放行拦截。具体代码如下。

package com.kaigjava.filter;

import java.io.IOException;

import javax.servlet.Filter;

import javax.servlet.FilterChain;

import javax.servlet.FilterConfig;

import javax.servlet.ServletException;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

public class MyFilter implements Filter {

    @Override

    public void destroy() {

    }

    @Override

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

            throws IOException, ServletException {

        System.out.println("doFilter执行了");

        // 放行

        chain.doFilter(request, response);

    }

    @Override

    public void init(FilterConfig filterConfig) throws ServletException {

    }

}

注意上面chain.doFilter(request, response)这行代码，如果不写这行，就一直拦截，请求没法往下走。这个就像我们上面登录验证拦截一样，没有登录就没有放开拦截。

继续部署上面代码，再来访问测试下，控制台输出如下内容。

doFilter执行了

ServletDemo1运行了

4.FilterChain

上面我们在web.xml中配置的Filter中过滤url设置是/*，也就是全部请求都进行拦截。在代码放行中，出现了FilterChain对象，这里我们简单来了解下这个过滤链对象。

FilterChain是servlet容器为开发任意提供的对象，它提供了对某一资源的已经过滤请求调用链的视图。过滤器使用FilterChain调用链中的下一个过滤器。如果调用的过滤器是链中的最后一个过滤器，则调用链末尾的资源。

怎么可以形成一个Filter链？只要多个Filter对同一个资源进行拦截就可以形成Filter链？

怎么确定Filter的执行顺序？由<filter-mapping>中不同Filter写的先后顺序来决定。

这个过滤链中不同的Filter过滤先后顺序取决于，开发人员在web.xml中的<filter-mapping>写的先后顺序来决定，上面这个图就是先执行MyFilter这个过滤器，然后再执行MyFilter2这个过滤器.

总结，Filter就处于浏览器和服务器中间的位置，可以拦截任何来自浏览器的请求和任意来之服务器的响应。