12- Filter 过滤器

Filter 过滤器介绍

  • Filter 过滤器它是 JavaWeb 的三大组件之一。三大组件分别是Servlet 程序、Listener 监听器、Filter 过滤器。
  • Filter 过滤器它是 JavaEE 的规范，也就是一个接口。
  • Filter 过滤器它的作用是拦截请求和过滤响应。拦截请求常见的应用场景有权限检查、日记操作、事务管理等等。例如:登录验证,统一编码处理,敏感字符过滤~~

核心方法


image.png

配置方式
1.注解方式
@WebFilter(拦截路径)
2.配置文件
添加<filter>和<filter-mapping>标签

FilterChain 介绍

  • FilterChain 是一个接口,代表过滤器链对象,由Servlet容器提供实现类对象,直接使用即可
  • 过滤器可以定义多个,就会组成过滤器链

    核心方法
    image.png

  • Filter 链的拦截过程如图 1 所示。


    image.png

    在图 1 中，当浏览器访问 Web 服务器中的资源时，需要经过两个过滤器 Filter1 和 Filter2。首先 Filter1 会对这个请求进行拦截，在 Filter1 中处理完请求后，通过调用 Filter1 的 doFilter() 方法将请求传递给 Filter2，Filter2 处理用户请求后同样调用 doFilter() 方法，最终将请求发送给目标资源。当 Web 服务器对这个请求做出响应时，也会被过滤器拦截，但这个拦截顺序与之前相反，最终将响应结果发送给客户端浏览器。

过滤器使用

  • 需求说明
    通过Filter 过滤器解决多个资源写出中文乱码的问题
  • 实现步骤
    1.创建一个web项目
    2.创建两个Servlet功能类,都向客户端写出中文数据
    3.创建一个Filter 过滤器实现类,重写doFilter核心方法
    4.在方法内解决中文乱码,并放行
    5.部署启动项目,并通过浏览器测试


实现代码1:

package com.itheima.servlet;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebServlet("/servletdemo1")
public class ServletDemo1  extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("servletdemo1执行了~~~~");
        resp.getWriter().write("servletdemo1执行了~~~~");
    }
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

        doGet(req, resp);
    }
}


实现代码2:

package com.itheima.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

// 过滤器的基本使用
@WebFilter("/*")
public class filterDemo1 implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo1执行了~~~");
        //处理乱码问题
        servletResponse.setContentType("text/html;charset=UTF-8");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);
    }
}

注意: 访问测试时servletdemo1时,请求首先会被filter处理,然后放行给servlet处理

Filter 使用细节 通过web.xml配置文件方式

代码实现:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
<!--设置filter 名称-->
    <filter>
        <filter-name>filterdemo1</filter-name>
        <filter-class>com.itheima.filter.filterDemo1</filter-class>
    </filter>
    <!--添加映射和路径-->
    <filter-mapping>
        <filter-name>filterdemo1</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>


多个过滤器使用顺序
如果有多个过滤器,取决于过滤器映射的顺序,也就是web.xml中的filter顺序
代码实现3:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
<!--设置第一个filter 名称-->
<filter>
    <filter-name>filterdemo1</filter-name>
    <filter-class>com.itheima.filter.filterDemo1</filter-class>
</filter>
<!--添加第一个映射和路径-->
<filter-mapping>
    <filter-name>filterdemo1</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<!--设置第二个filter 名称-->
<filter>
    <filter-name>filterdemo2</filter-name>
    <filter-class>com.itheima.filter.filterDemo2</filter-class>
</filter>
<!--添加第二个映射和路径-->
<filter-mapping>
    <filter-name>filterdemo2</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
image.png

过滤器生命周期

  • 创建
    当应用加载时实例化对象并执行init初始化方法
  • 服务
    对象提供服务的过程,执行doFilter方法
  • 销毁
    当应用卸载时或者服务器停止时对象销毁,执行destroy

实现代码4:

package com.itheima.filter;
import javax.servlet.*;
import java.io.IOException;

//过滤器的生命周期
//@WebFilter("/*")
public class filterDemo3 implements Filter {
    //初始化方法
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("对象初始化成功!!");
    }

    //对象服务的过程
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo3执行了~~~");
        //处理乱码问题
        servletResponse.setContentType("text/html;charset=UTF-8");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);
    }

    //对象销毁的过程
    @Override
    public void destroy() {
        System.out.println("对象销毁的过程!!!");
    }
}
image.png

FilterConfig 介绍

  • FilterConfig是一个接口,代表过过滤器的配置对象,可以加载一些初始化参数

  • 核心方法


    image.png

实现代码5:

package com.itheima.filter;
import javax.servlet.*;
import java.io.IOException;

//过滤器的配置对象的使用
//@WebFilter("/*")
public class filterDemo4 implements Filter {
    //初始化方法
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("对象初始化成功!!");
        //获取过滤器名称
        String filterName = filterConfig.getFilterName();
        System.out.println(filterName);

        //根据name获取value
        String username = filterConfig.getInitParameter("username");
        System.out.println(username);
    }

    //对象服务的过程
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo4执行了~~~");
        //处理乱码问题
        servletResponse.setContentType("text/html;charset=UTF-8");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);
    }

    //对象销毁的过程
    @Override
    public void destroy() {
        System.out.println("对象销毁的过程!!!");
    }
}

实现代码web.xml配置

    <!--测试FilterConfig配置-->
    <filter>
        <filter-name>filterdemo4</filter-name>
        <filter-class>com.itheima.filter.filterDemo4</filter-class>
        <init-param>
            <param-name>username</param-name>
            <param-value>zhangsan</param-value>
        </init-param>
    </filter>
    <!--添加第四个映射和路径-->
    <filter-mapping>
        <filter-name>filterdemo4</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

测试结果


image.png

拦截器五种拦截行为

  • Filter 过滤器默认拦截的是请求,但是在实际的开发中,我们还有请求转发和请求包含,以及由服务器出发调用的全局错误页面.默认情况下过滤器是不参与过滤的,想要使用,就需要我们配置
  • 拦截方式

实现代码6: 在web.xml中添加此配置

    <!--过滤器的拦截行为-->
    <filter>
        <filter-name>filterdemo5</filter-name>
        <filter-class>com.itheima.filter.filterDemo5</filter-class>
        <!--配置开启异步支持,当dispatcher配置ASYNC时,需要配置此行-->
    </filter>
    <filter-mapping>
        <filter-name>filterdemo5</filter-name>
        <url-pattern>/index.jsp</url-pattern>
        <!--过滤请求: 默认值-->
        <dispatcher>REQUEST</dispatcher>

        <!--过滤全局错误页面:当由服务器调用全局错误页面时,过滤器工作-->
        <dispatcher>ERROR</dispatcher>

        <!--过滤请求转发: 当请求转发时,过滤器工作-->
        <dispatcher>FORWARD</dispatcher>

        <!--过滤请求包含: 当请求包含时,过滤器工作,它只能过滤动态包含,jsp的include指令时静态指令,过滤器不会过滤-->
        <dispatcher>INCLUDE</dispatcher>

        <!--过滤异步类型,它要求我们在filter标签中配置开启异步支持-->
        <dispatcher>ASYNC</dispatcher>
    </filter-mapping>

    <!--配置全局错误页面-->
    <error-page>
        <exception-type>java.lang.Exception</exception-type>
        <location>/error.jsp</location>
    </error-page>
    <error-page>
        <error-code>404</error-code>
        <location>/error.jsp</location>
    </error-page>

实现代码7: 此代码配合web.xml 测试开启拦截器和不开启拦截器有什么区别

package com.itheima.servlet;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/servletdemo3")
public class ServletDemo3 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("servletdemo3执行了~~~~");
//        int i = 1 / 0;
       /* //请求转发
        req.getRequestDispatcher("/index.jsp").forward(req, resp);*/

        //请求包含
        req.getRequestDispatcher("/index.jsp").include(req,resp);
    }
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

        doGet(req, resp);
    }
}

注意: Servlet 主要是测试请求转发和请求包含,全局错误页面使用

实现代码8: 自定义一个error.jsp 测试全局错误页面配置

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>自定义错误页面</title>
</head>
<body>
不好意思出错了~~~~
</body>
</html>

实现代码9: 创建一个拦截器.配合web.xml测试

package com.itheima.filter;
import javax.servlet.*;
import java.io.IOException;

//过滤器的拦截行为
//@WebFilter("/*")
public class filterDemo5 implements Filter{
    //对象服务的过程
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo5执行了~~~");
        //处理乱码问题
        servletResponse.setContentType("text/html;charset=UTF-8");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);
    }
}

注意: 在访问测试时,开启web.xml里的拦截模式时,看拦截器有没有同时在控制台打印servlet和filter的输出语句!

©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容