黑猴子的家：JavaWeb 之 Servlet 过滤器

request.setCharacterEncoding("UTF-8");// 重复性代码
response.setContentType("text/html;charset=UTF-8");
像字符编码这种代码，每个Servlet都需要编码，就属于冗余代码，可以抽取出来放到拦截器里面

1、Filter简介

Filter翻译为中文是过滤器的意思。
Filter是JavaWeb的三大web组件之一Servlet、Filter、Listener
Filter的作用是在请求到达WEB资源（HTML、CSS、Servlet、JSP）之前进行拦截。
Filter需要交给Tomcat访问器来管理
Filter的作用：
    1）Filter可以在请求到达目标资源之前进行拦截
    2）Filter也可以放行请求
    3）Filter可以在响应到达浏览器之前做一个预处理

2、Filter的HelloWorld

步骤：
1）创建一个类实现Filter接口
2）在web.xml文件中对Filter进行配置

<filter>
    <filter-name>Filter的别名</filter-name>
    <filter-class>Filter的全类名</filter-class>
</filter>
<filter-mapping>
    <filter-name>别名</filter-name>
    <url-pattern>需要Filter拦截的资源地址</url-pattern>
</filter-mapping>

3、Filter的生命周期

一个请求的发送，到响应返回是一个线程。
Filter的生命周期，指的是Filter对象由被创建到被销毁的过程。
Filter的生命周期方法：
     - 构造器：Filter的构造器在服务器启动时调用。 构造器只会调用一次，说明Filter也是单例多线程的。
     - init()：在构造器被调用后，紧接着被调用。作用：用来初始化Filter。
    - doFilter()：每一次拦截请求时都会调用。
        参数
            ServletRequest request
        请求报文
            ServletResponse response
        响应报文
            FilterChain chain
        该对象的作用就是放行请求：
            可以通过 chain.doFilter(request,response) 放行请求。
            当调用chain.doFilter()就相当于调用目标的资源的service方法。
    - destroy方法在项目停止时调用，用来在对象被销毁前做一些收尾工作。

url-pattern的设置规则
    1）精确匹配：只有当目标资源的地址和url-pattern的地址一模一样时，Filter才会拦截资源
        例子：/2.jsp , 只有当浏览器访问项目根目录下的2.jsp时，才会调用Filter

    2）路径匹配：当访问的资源在url-pattern配置的路径下时，Filter就会拦截资源。
        例子1：/hello/* ， 只要访问项目根目录下hello下的资源，就会调用Filter。
        例子2：/* , 会拦截项目根目录下所有资源

    3）后缀匹配：只要访问的资源地址和url-pattern的后缀一样就会调用Filter
        例子：*.jsp 只要是以jsp结尾的请求都会拦截
        - 以上规则适用于Servlet的url-pattern配置
         - 当使用Filter拦截一个Servlet时，可以将Filter的url-pattern和Servlet的url-pattern一样
        这样Filter就会拦截发送到Servlet的请求。
         - 也可以通过在filter-mapping中添加一个servlet-name标签来设置要拦截的Servlet的name

4、Filter的执行顺序

我们可以为一个资源设置多个过滤器
当我们为一个资源设置了多个过滤器时，这些过滤器就组成一个Filter链的结构。
当我们去掉用chain.doFilter(),如果该过滤器后边还有其他的过滤，
相当于调用了下一个过滤器doFilter()方法
如果过滤器后没有其他的过滤器，我们调用chain.doFilter()
相当于调用了目标资源的service()方法。
多个Filter的执行顺序，有filter-mapping标签的配置顺序决定，
filter-mappint靠前，则filter先执行，靠后则后执行。
我们可以通过修改filter-mapping的顺序来修改Filter的执行顺序，
但是注意，filter-mapping不能写在filter标签的前边。

5、code

1）CharacterEncodingFilter

package com.alex.web.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;

/**
 * 来解决  POST 请求中文乱码问题
 * 拦截器的作用
 *   解决那些问题：
 *       密码加密
 *       对请求参数值进行非法字符过滤
 *       权限控制
 *       登陆验证
 */
public class CharacterEncodingFilter implements Filter{

    String filename;
    
    @Override
    public void destroy() {
        System.out.println("destroy ... ...");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
        throws IOException, ServletException { 
        System.out.println("doFilter  前... ...");
        request.setCharacterEncoding("UTF-8");// 重复性代码
        //这个编码设置，一定是获取输出流之前，在获取输出流之后在设置就不管用了
        response.setContentType("text/html;charset=UTF-8");
        chain.doFilter(request, response);//放行- 执行后续过滤器，执行目标程序
        //狸猫换太子
        String name = (String)request.getAttribute("name");
        request.setAttribute("name", name + "22");
        System.out.println("doFilter  后   ... ...");
    }

    //获取web.xml中filter配置的初始化参数
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("init ... ...");
        filename = filterConfig.getInitParameter("filename");
    }
}

2）LoginServlet

package com.alex.web.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 LoginServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;

    // 处理请求使用的
    @Override
    public void service(HttpServletRequest request, HttpServletResponse response) 
        throws ServletException, IOException {

        request.setCharacterEncoding("UTF-8");// 重复性代码
        response.setContentType("text/html;charset=UTF-8");

        String username = request.getParameter("username");
        String passwd = request.getParameter("passwd");

        if ("admin".equals(username) && "123".equals(passwd)) {
            request.setAttribute("name", "admin");
            request.setAttribute("age", 20);
            request.getSession().setAttribute("name", "Tom");
            request.getSession().getServletContext().setAttribute("name", "alex");
            request.getRequestDispatcher("/success.jsp").forward(request, response);
        } else { 
            response.sendRedirect(request.getContextPath() + "/failure.jsp");
        }
    }
}

3）web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
    id="WebApp_ID" version="3.1">
    <display-name>web_filter</display-name>

    <!-- 过滤器：是单例的，服务器启动时被创建，别初始化 -->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>com.alex.web.filter.CharacterEncodingFilter</filter-class>
        <!-- 可以设置多个参数，后期用框架的时候，像这种字符编码的过滤器，
        根本不需要我们自己写，只需要配置上就可以了 -->
        <init-param>
            <param-name>filename</param-name>
            <param-value>D:/temp/log.txt</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <!-- 路径匹配规则：
         精确匹配：
        <url-pattern>/LoginServlet</url-pattern>
        路径匹配：
        <url-pattern>/yyy/*</url-pattern>
        扩展匹配：
        <url-pattern>*.jsp</url-pattern>
        <url-pattern>*.action</url-pattern>
         -->
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <servlet>
        <servlet-name>LoginServlet</servlet-name>
        <servlet-class>com.alex.web.servlet.LoginServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>LoginServlet</servlet-name>
        <url-pattern>/LoginServlet</url-pattern>
    </servlet-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

6、多个拦截器的拦截顺序

1）拦截的路径一样

<filter-mapping>
    <filter-name>CharacterEncodingFilter1</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>CharacterEncodingFilter2</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

拦截路径一样，拦截器的顺序，就看web.xml的配置顺序，从上到下依次

2）拦截的路径不一样

<filter-mapping>
    <filter-name>CharacterEncodingFilter3</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
<filter-name>CharacterEncodingFilter4</filter-name>
    <url-pattern>*.jsp</url-pattern>
</filter-mapping>

如何都能拦截，那么这两个拦截器都会拦截一下，那么谁是第一个拦截器呢？？ 最精准匹配的，就是第一个拦截器