Spring Boot -07 拦截器以及监听器

Spring Boot -07 拦截器以及监听器

监听器
监听器基本概念：
监听器专门用于监听另一个Java对象的方法调用或属性改变，当被监听对象发生指定的事件后，监听器某个方法将立即被执行。
常见监听器种类：应用启动监听器，会话监听器，请求监听器
主要分为三大类型
应用启动监听：ServletContextListener
会话监听：HttpSessionLisener
请求监听：ServletRequestListener
创建应用监听

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

// @WebListener注解的作用是标注这是一个监听器，会被Springboot扫描
@WebListener
// 应用上下文监听器
class ApplicationListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent servletContextEvent) {
        System.out.println("上下文监听初始化！");
    }

    @Override
    public void contextDestroyed(ServletContextEvent servletContextEvent) {
        System.out.println("上下文监听已销毁！");
    }
}

创建会话监听

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

@WebListener
// session监听器
class CustomSessionListener implements HttpSessionListener {
    @Override
    public void sessionCreated(HttpSessionEvent httpSessionEvent) {

        System.out.println("session监听初始化！");
    }
    @Override
    public void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        System.out.println("session监听已被销毁掉了！");
    }
}

创建请求监听

import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.annotation.WebListener;

@WebListener
// 请求监听器
class requestmonitor implements ServletRequestListener {
    @Override
    public void requestDestroyed(ServletRequestEvent servletRequestEvent) {
        System.out.println("request请求监听已被销毁！");

    }
    @Override
    public void requestInitialized(ServletRequestEvent servletRequestEvent) {
        System.out.println("request请求监听初始化");
    }
}

运行结果

拦截器
拦截器基本概念：
拦截用户的请求，在请求的前后添加处理逻辑，如执行功能检验、程序异常调试等工作。
步骤
(1)定义类实现WebMvcConfigurer接口
(2)根据idea快捷键重写方法

preHandle：调用Controller某个方法之前
postHandle：Controller之后调用，视图渲染之前，如果控制器Controller出现了异常，则不会执行此方法
afterCompletion：不管有没有异常，这个afterCompletion都会被调用，用于资源清理

按照顺序进行拦截，先注册先被拦截

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
// 拦截器配置类，实现WebMvcConfigurer接口

public class monitor implements WebMvcConfigurer {

        @Override
        // 注册LoginIntercepter拦截器，注意：先注册先被拦截
        public void addInterceptors(InterceptorRegistry registry) {
            // 配置拦截器所要拦截的路径，凡是pri下的都会拦截
            registry.addInterceptor(getLoginInterceptor()).addPathPatterns( "/monitor/*");
            // 注册另一个拦截器
            registry.addInterceptor(new TwoIntercepter()).addPathPatterns("/monitor/*");

            // 传入registry值
            WebMvcConfigurer.super.addInterceptors(registry);
        }

        @Bean
        // 添加LoginIntercepter拦截器
        public LoginIntercepter getLoginInterceptor(){
            return new LoginIntercepter();
        }
    }

monitor/Intercepter .java

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;

// 实现HandlerInterceptor接口
class Intercepter implements HandlerInterceptor {

    // 此处代码拷贝自filter/loginFilter.java
    // ObjectMapper用以序列化
    private static final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    // controller方法之前的拦截
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("这里是登录前的拦截，对登陆请求进行预处理");

        String token = request.getHeader("name");
        if (StringUtils.isEmpty(name)) {
            token = request.getParameter("name");
        }
        // 如果name不为空
        if (!StringUtils.isEmpty(name)) {
                return true;
        } else {
            Json jsonData =  Json.buildError("名称错误",-1);
            String jsonStr = objectMapper.writeValueAsString(jsonData);
            renderJson(response,jsonStr);
            return false;
        }
    }

    private void renderJson(HttpServletResponse response,String json) throws Exception{
        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json");
        // 输出流
        try(PrintWriter writer = response.getWriter()){
            writer.print(json);
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    @Override
    // 拦截业务逻辑
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("POST登录的拦截程序");
        HandlerInterceptor.super.postHandle(request,response,handler,modelAndView);
    }

    @Override
    // 请求完成之后的拦截，用于资源清理​
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("完成登录后的拦截");
        HandlerInterceptor.super.afterCompletion(request,response,handler,ex);
    }
}

使用顺序
LoginIntercepter的preHandle方法 >
TwoIntercepter的preHandle方法>
LoginIntercepter的preHandle方法>
TwoIntercepter的afterCompletion方法>
LoginIntercepter的afterCompletion方法

监听源码地址:https://download.csdn.net/download/qq_41781775/19148388
拦截器源码地址:https://download.csdn.net/download/qq_41781775/19148423