Servlet-Filter过滤器

Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。

可以将一个或多个 Servlet 过滤器附加到一个 Servlet 或一组 Servlet。Servlet 过滤器也可以附加到 JavaServer Pages (JSP) 文件和 HTML 页面。调用 Servlet 前调用所有附加的 Servlet 过滤器。

Servlet 过滤器是可用于 Servlet 编程的 Java 类，可以实现以下目的：

• 在客户端的请求访问后端资源之前，拦截这些请求。
• 在服务器的响应发送回客户端之前，处理这些响应。

过滤器的应用场景

1、场景1
用户表单提交参数，使用POST方法提交，编写Servlet，接收参数： request.getParameter() /getParameterValues() 如果在客户端提交汉字而不做任何处理，就出现中文乱码的问题。

解决编码问题： request.setCharacterEncoding(“utf-8”);

Ø 问题：如果在项目中的每一个Servlet都加上request.setCharacterEncoding(“utf-8”);

代码重复，而且后期维护也不方便。能不能把这部分公共代码抽取处理，放在一个地方执行？

2、场景2
登录 -> 输入信息 -> 登录成功 -> 看到用户主页（欢迎xxx回来。。。）

用于验证用户是否登录成功代码：

    HttpSession session = request.getSession()

    Object obj = session.getAttribute("loginInfo");

    if(obj==null){

      //没有登录标记，代表没有登录

    }else{

      ///已经登录了，继续访问此功能

    }

如果用户不登录，直接访问用户主页，跳转到登录页面，在其他需要登录才能访问的页面中，同样也需要加上验证用户是否登录成功代码。

Ø 问题： 能不能把这部分公共验证用户是否登录成功代码抽取处理，在一个地方执行？

3. 结论
以上两种场景出现的问题，可以使用过滤器（Filter）解决（若使用Struts2框架也可使用拦截器拦截Action，拦截器只能针对Action）！

过滤器的作用

通过Filter技术，对Web服务器管理的所有Web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，并且添加功能，从而实现一些“共同”的功能。
例如：

1. 实现URL级别的权限访问控制
2. 过滤敏感词汇
3. 自动登录
4. 压缩响应信息等一些功能。

过滤器编写步骤

特点：过滤器不是用户主动调用的，而是根据规则自己执行。

过滤器是一个实现了 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三个方法
步骤：
1.编写一个java类，实现Filter接口，并实现其中的所有方法

2.在web.xml文件中配置Filter

   <!-- 过滤器配置 -->
    <filter>
      <!-- 内部名称 -->
      <filter-name>HelloFilter</filter-name>
      <!-- 类全名：包+简单类名 -->
      <filter-class>org.newboy.filter.HelloFilter</filter-class>
    </filter>
    <!-- 过滤器映射配置 -->
    <filter-mapping>
      <!-- 内部名称名称，和上面的名称保持一致！ -->
      <filter-name>HelloFilter</filter-name>
      <!-- 需要拦截的路径 -->
      <url-pattern>/*</url-pattern>
    </filter-mapping>

3.把Filter部署到tomcat服务器运行

示例

创建一个过滤器HelloFilter，在运行HelloServlet前和后分别输出一句话，在HelloServlet中也输出一句话，观察控制台的运行效果。

1)过滤器类

public class HelloFilter implements Filter{

	public void destroy() {
		
	}

	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		System.out.println("1.请求的时候运行一次过滤器");
		chain.doFilter(request, response);
		System.out.println("3.响应的时候运行一次过滤器");
	}

	public void init(FilterConfig arg0) throws ServletException {
		
	}

}

2) web.xml中的配置

<!-- 过滤器的配置 -->
      <filter>
        <!-- 过滤器的内部名字 -->
        <filter-name>hello</filter-name>
        <filter-class>org.newboy.filter.HelloFilter</filter-class>
      </filter>
      
      <!-- 映射路径 -->
      <filter-mapping>
        <filter-name>hello</filter-name>
        <!-- 过滤的Web资源路径 -->
        <url-pattern>/*</url-pattern>
      </filter-mapping>

3)HelloServlet类

      public class HelloServlet extends HttpServlet {
      
        public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
          System.out.println("2.执行了目标资源：HelloServlet被执行");
        }

        public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
          doGet(request, response);
        }
      }

4) 运行结果

1. 请求的时候运行一次过滤器
2. 运行了Web资源
3. 响应的时候运行一次过滤器

Filter是如何实现拦截的？

Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个Web资源进行拦截后，Web服务器每次在调用Web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

1)调用目标资源之前，执行一段代码，request执行过滤任务。

2)是否调用目标资源（即是否让用户访问Web资源）。
Web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则Web服务器就会调用Web资源的service方法，即Web资源就会被访问，否则Web资源不会被访问。

3)调用目标资源之后，执行一段代码，response执行过滤任务。

过滤器的生命周期

1.过滤器加载的时机：

过滤器在Web服务器启动的时候就加载了，因为要拦截Web资源，所以必须在所有Web资源启动之前就加载过滤器。

2.生命周期的方法：

1). init方法：

在创建完过滤器对象之后被调用。只执行一次

注：过滤器在Web服务器中也是单例模式

2).doFilter方法：

执行过滤任务方法。执行多次。

3).destroy方法：

Web服务器停止或者Web应用重新加载，销毁过滤器对象。

还有更多关于过滤器的用法参考以下两篇文章：
https://blog.csdn.net/chenkun2016/article/details/79498618
https://www.runoob.com/servlet/servlet-writing-filters.html