过滤器和监听器

过滤器和监听器

1.过滤器

Filter 即为过滤，用于在 Servlet 之外对 Request 或者 Response 进行修改。
它主要用于对用户请求进行预处理，也可以对 HttpServletResponse 进行后处理。
使用 Filter 的完整流程： 
	Filter 对用户请求进行预处理，接着将请求交给Servlet 进行处理并生成响应，最后 Filter 再 对服务器响应进行后处理。
	在一个 web 应用中，可以开发编写多个Filter，这些 Filter 组合 起来称之为一个 Filter 链。

若是一个过滤器链：
先配置先执行(请求时的执行顺序)；
响应时: 以相反的顺序执行。

Filter 的实现只需要两步：
Step1: 编写 java 类实现 Filter 接口，并实现其 doFilter 方法。
Step2: 通过@WebFilter注解设置它所能拦截的资源。

@WebFilter("/*") // 拦截所有的请求
public class Filter01 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化...");
    }
    /**
     * 被拦截的资源会执行该方法
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // doFilter方法之前的代码会在请求时执行  对资源的请求进行拦截
        System.out.println("Filter01请求拦截...");

        // 放行资源
        filterChain.doFilter(servletRequest, servletResponse);

        // doFilter方法之后的代码会在响应时执行
        System.out.println("Filter01响应拦截...");
    }
    @Override
    public void destroy() {
        System.out.println("销毁...");
    }
}

@WebFilter("/ser01")
public class Filter02 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化...");
    }
    /**
     * 被拦截的资源会执行该方法
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Filter02请求拦截...");
        // 处理乱码
        // 放行资源
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("Filter02响应拦截...");
    }
    @Override
    public void destroy() {
        System.out.println("销毁...");
    }
}

@WebFilter("/*")
public class EncodeFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化...");
    }

    /**
     * 被拦截的资源会执行该方法
     * @param servletRequest
     * @param servletResponse
     * @param filterChain
     * @throws IOException
     * @throws ServletException
     */
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
       // 处理请求乱码
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        request.setCharacterEncoding("UTF-8");
        // 放行资源
        filterChain.doFilter(request, response);
    }
    @Override
    public void destroy() {
        System.out.println("销毁...");
    }
}

2.监听器

web 监听器是Servlet 中一种的特殊的类，能帮助开发者监听 web 中的特定事件。
比如 ServletContext， HttpSession，ServletRequest 的创建和销毁；变量的创建、销毁和修改等。
可以在某些动作前后增加处理，实现监控。
例如可以用来统计在线人数等。

2.1实现

监听器有三类8种：
⑴ 监听生命周期：
ServletRequestListener
HttpSessionListener
ServletContextListener
⑵ 监听值的变化：
ServletRequestAttributeListener
HttpSessionAttributeListener
ServletContextAttributeListener
⑶ 针对 session 中的对象:
监听 session 中的 java 对象(javaBean) ，是 javaBean 直接实现监听器 的接口。

2.2编码示例

import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;

@WebListener
public class Listener01 implements HttpSessionListener {
    /**
     * 创建Session对象时执行
     * @param httpSessionEvent
     */
    @Override
    public void sessionCreated(HttpSessionEvent httpSessionEvent) {
        System.out.println("Session对象被创建了...");
    }
    /**
     * 销毁session对象时执行
     * @param httpSessionEvent
     */
    @Override
    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        System.out.println("Session对象被销毁了...");
    }
}

做一个对在线人数的监控。
实现步骤：
Step1：创建一个监听器，需要实现某种接口，根据需求选取 HttpSessionListener Step2：通过@WebListener注解配置该监听器
创建一个类，并实现 HttpSessionListener 接口，用来检测 Session 的创建和销毁

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("/ser01")
public class Servlet01 extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("Servlet01...");
    }
}

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 javax.servlet.http.HttpSession;
import java.io.IOException;

@WebServlet("/ser02")
public class Servlet02 extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 创建session对象
        HttpSession session = req.getSession();
    }
}

import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;

/**
 * 在线人数统计
 *      当有新用户访问时（创建session），人数+1
 *      当有用户退出时（销毁session），人数-1
 */
@WebListener
public class OnlineListener implements HttpSessionListener {

    // 在线人数
    private Integer onlineNumber = 0;

    /**
     * 当有新用户访问时（创建session），人数+1
     * @param httpSessionEvent
     */
    @Override
    public void sessionCreated(HttpSessionEvent httpSessionEvent) {
        // 人数+1
        onlineNumber++;
        // 存session作用域
        // httpSessionEvent.getSession().setAttribute("onlineNumber",onlineNumber);

        // servletContext作用域
        httpSessionEvent.getSession().getServletContext().setAttribute("onlineNumber",onlineNumber);
    }

    /**
     * 当有用户退出时（销毁session），人数-1
     * @param httpSessionEvent
     */
    @Override
    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        // 人数-1
        onlineNumber--;
        // 存session作用域
        // httpSessionEvent.getSession().setAttribute("onlineNumber",onlineNumber);

        // servletContext作用域
        httpSessionEvent.getSession().getServletContext().setAttribute("onlineNumber",onlineNumber);
    }
}