Java研学-过滤与监听

一过滤器 Filter

1 介绍

Java Web 组件之一(Servlet 的功能)，可改变一个request和修改一个response。Filter不是Servlet，不能产生一个response，它是在一个request 到达Servlet之前预处理 request，也可以在response离开Servlet 后处理 response。
Filter流程
过滤器通常使用在字符编码处理；登录校验；论坛敏感字过滤；做前端框架的分发器等场景

2 语法

// 类似Servlet 定义类实现Filter接口 覆盖其中三个方法
void destroy()
// 处理请求响应
void doFilter(ServletRequest req,ServletResponse resp,FilterChain chain)
void init(FilterConfig filterConfig)
// 编辑完成后交给Tomcat管理

3 demo

① HelloFilter

public class HelloFilter implements Filter {
    // 初始化方法
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    // 过滤方法
    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("This Filter");
        filterChain.doFilter(req,resp);
    }
    // 销毁方法
    @Override
    public void destroy() {
    }
}

② web.xml配置

	<filter>
        <filter-name>HelloFilter</filter-name>
        <filter-class>cn.tj.web.servlet.HelloFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HelloFilter</filter-name>
        <url-pattern>/hello</url-pattern>
    </filter-mapping>

4 过滤路径

不同于 Servlet 的 url-pattern，过滤器的url-pattern 是指 Filter 对哪些资源做过滤操作。
Servlet 的 url-pattern：为当前Servlet起一个资源名称，可通过该名字找到对应的Servlet 对象。

Filter 的 url-pattern：指定对哪些资源做过滤，配置过滤器路径。

//当前 Filter 只会对/hello 做拦截/过滤。
/hello
//当前 Filter 只会对/employee 资源做过滤
/employee
//当前 Filter 只会对以/system/作为前缀的资源路径做拦截。
/system/*
//当前Filter 会对所有资源访问进行拦截
/*

5 Filter生命周期

Filter的生命周期：指Filter从创建到销毁的整个过程。

对象创建：启动服务器时创建所有Filter对象

init方法执行：启动服务器时调用 Filter对象中的init方法。

doFilter方法执行：每次请求对应的资源时都会执行，只要路径符合。

destroy方法执行：正常关闭服务器的时候，执行销毁操作，非正常关闭不会执行。

执行顺序：创建对象（1次）→init方法（1次）→doFilter方法（N次）→destroy方法（1次／0次）

public class HelloFilter implements Filter {
    public HelloFilter(){
        System.out.println("Filter is ok");
    }
    // 初始化方法
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 通常用来获取配置初始化参数
        System.out.println("This Filter init");
    }
    // 过滤方法
    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain filterChain) throws IOException, ServletException {
        // 执行过滤操作
        System.out.println("This doFilter");
        // 放行
        filterChain.doFilter(req,resp);
    }
    // 销毁方法
    @Override
    public void destroy() {
        System.out.println("clean");
    }
}

6 FilterChain（过滤器链）

配置多个过滤器时，多个过滤器按照一定的顺序，排列组合在一起都形成一个Filter链，使用FilterChain对象来做牵引关联。
过滤器链
多个过滤器的先后执行顺序

① 由在web.xml中配置的＜filter-mapping＞的先后顺序来决定

② 注解配置时则是由Filter的名称的字母先后顺序来决定

7 过滤方式

过滤器默认只对请求操作做过滤，转发是没有做过滤的，若对转发方式等做过滤，需设置过滤方式。

REQUEST：一次全新的请求，只有全新的请求才会经过过滤器（默认）。
FORWARD：请求转发。
ERROR：错误页面跳转。

// 例如
    <filter>
        <filter-name>HelloFilter</filter-name>
        <filter-class>cn.tj.web.servlet.HelloFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HelloFilter</filter-name>
        <url-pattern>/hello</url-pattern>
        <dispatcher>FORWARD</dispatcher>
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>ERROR</dispatcher>
    </filter-mapping>

8 过滤器错误

web目录下创建404.jsp，实现错误页面的转发，根据报错信息给予页面提示

// web.xml
<error-page>
	<error-code>404</error-code>
	<location>/404.jsp</location>
</error-page>
<filter>
	<filter-name>HelloFilter</filter-name>
	<filter-class>cn.tj.web.servlet.HelloFilter</filter-class>
</filter>
<filter-mapping>
	<filter-name>HelloFilter</filter-name>
	<url-pattern>/hello</url-pattern>
	<dispatcher>FORWARD</dispatcher>
	<dispatcher>REQUEST</dispatcher>
	<dispatcher>ERROR</dispatcher>
</filter-mapping>

// 404.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<span>错误页面</span>
</body>
</html>

9 字符编码过滤器 – CharacterEncodingFilter

将编码格式的设置从Servlet拿到Filter中

@WebFilter("/*")
public class CharacterEncodingFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    /*设置请求和响应的编码格式*/
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //创建http请求和响应对象
        HttpServletRequest req= (HttpServletRequest) servletRequest;
        HttpServletResponse resp= (HttpServletResponse) servletResponse;
        //设置请求响应编码
        req.setCharacterEncoding("utf-8");
        resp.setContentType("text/html;charset=utf-8");
        //放行
        filterChain.doFilter(req,resp);
    }
    @Override
    public void destroy() {
    }
}

10 登录校验过滤器 – LoginFilter

判断用户是否登录，登录则放开资源，未登录则跳转到登录页面

@WebFilter("/check/*")
public class LoginFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    /*登录权限的验证*/
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest req= (HttpServletRequest) servletRequest;
        HttpServletResponse resp= (HttpServletResponse) servletResponse;
        /*判断是否拦截请求路径：index.jsp  login.jsp /user?cmd=login /*/
        String uri = req.getRequestURI();
        System.out.println(uri);
        if (uri.equals("/")||uri.equals("/index.jsp")||uri.equals("/login.jsp")){
            //如果是不需要拦截的路径，直接放行
            filterChain.doFilter(req,resp);
        }
        /*判断是否登录*/
        HttpSession session = req.getSession();
        Users users = (Users) session.getAttribute("USER_IN_SESSION");
        if (users==null){//如果没有登录，跳转登录页面，给出提示
            req.setAttribute("msg","请先登录再操作！");
            req.getRequestDispatcher("/login.jsp").forward(req,resp);
            return;
        }else{
            filterChain.doFilter(req,resp);
        }
    }
    @Override
    public void destroy() {
    }
}

@WebFilter(“/check/*”)将需要受登录校验检查的资源放在check路径下，保证资源安全性，若对所有资源进行校验，会导致匿名资源不可被访问到
匿名资源指不需登录也可以访问的资源，/login.jsp，/login，静态资源等等

二监听器 Listener

Java Web组件之一，用于监听作用域对象的创建和销毁动作以及作用域属性值的改变动作。触发动作，执行相应的的监听器操作。

1 介绍

① 监听的对象：
作用域对象
作用域属性
② 监听的动作：
作用域对象的创建和销毁
作用域属值的增删改
③ 监听器分类
按作用域对象：
ServletRequestListener
HttpSessionListener
ServletContextListener
按作用域属性分：
ServletRequestAttributeListener
HttpSessionAttributeListener
ServletContextAttributeListener

2、开发监听器的步骤

① 创建java类，根据需求实现对应的接口。
② 实现其中的方法。
③ 将监听器交给Tomcat管理。

3 demo

// 假设每个新会话对应一个新游客
// 每打开关闭一个会话 游客数+1
@WebListener
public class VisitorListener implements HttpSessionListener {
    /*初始化游客数量*/
    int total=0;
    /*session创建*/
    @Override
    public void sessionCreated(HttpSessionEvent se) {
        total++;
        System.out.println("游客数量："+total);
    }
    /*session销毁*/
    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
       total--;
        System.out.println("游客退出了，游客数量："+total);
    }
}