java拦截器

昨天写了一篇关于我在学习java过滤器Filter过程中的心得体会,有兴趣的小伙伴
们可以参考:
https://blog.csdn.net/qq_43019156/article/details/120163368
欢迎交流哟~~~

今天我们继续来学习一下java拦截器Interceptor

同学习javaFilter过程一样,要学习java拦截器首先也要了解java拦截器是什么

拦截器简介

java拦截器又称为Interceptor,它可以动态的拦截action调用的对象,
它提供了一种机制可以让开发者在被拦截的action执行的前后执行一段代码,
也可以在这个action执行前阻止它的执行,更重要的是它还提供了一种可以获
取到这个action中可重用代码的方式.
在面向切面编程(AOP)中,拦截器通常用于某个方法或者字段被访问之前对其进
行拦截,然后在访问之前或者之后可以添加我们自定义的一些操作.
目前,我们所需要掌握的是spring拦截器.至于struts拦截器知道即可.

接下来了解一下java拦截器的应用场景

拦截器的应用场景

应用场景
1、日志记录，可以记录请求信息的日志，以便进行信息监控、信息统计等。
2、权限检查：如登陆检测，进入处理器检测是否登陆，如果没有直接返回到登陆页面。
3、性能监控：典型的是慢日志。

然后我们来分析一下拦截器的工作原理:字比较多,告诉自己耐心点~

(1) preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，
顾名思义，该方法将在请求处理之前进行调用。
SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个
请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的
声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，
所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，
也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返
回值是布尔值Boolean 类型的，当它返回为false 时，表示请求结束，后续的
Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调
用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor
的时候就会是调用当前请求的Controller 方法。

(2) postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，
由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 
方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图
返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的
ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 
是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，
这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的
Interceptor 的执行过程也是链式的，只是在Struts2 里面需要手动调用
ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者
是Action 的调用，然后每一个Interceptor 中在invoke 方法调用之前的
内容都是按照声明顺序执行的，而invoke 方法之后的内容就是反向的。

(3)afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，
该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值
为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在
DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要
作用是用于进行资源清理工作的。

现在开干!!!

创建一个MyInterceptor类实现HandlerInterceptor接口即可
别忘了@Component注解哟!

package com.itgzw.learninterceptor.interceptor;


import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @title: MyInterceptor
 * @Author Mr.Guo
 * @Date: 2021/9/1 14:27
 * @Version 1.0
 */
@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle......");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle......");
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion......");
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

接着在spring中注册我们的拦截器
别忘了@Configuration注解哟!
如果想对某些特殊的请求不进行拦截
可以使用excludePathPatterns()方法

package com.itgzw.learninterceptor.config;

import com.itgzw.learninterceptor.interceptor.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @title: InterceptorConfig
 * @Author Mr.Guo
 * @Date: 2021/9/1 14:59
 * @Version 1.0
 *  扩展SpringMVC
 *  SpringBoot2使用的Spring5，因此将WebMvcConfigurerAdapter改为WebMvcConfigurer
 * 使用WebMvcConfigurer扩展SpringMVC好处既保留了SpringBoot的自动配置，又能用到我们自己的配置
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        //设置对“/”的请求映射到index
        //如果没有数据返回到页面，没有必要用控制器方法对请求进行映射
        registry.addViewController("/").setViewName("index");
   }

    //注册拦截器
   @Override
   public void addInterceptors(InterceptorRegistry registry) {
                //SpringMVC下，拦截器的注册需要排除对静态资源的拦截(*.css,*.js)
                //SpringBoot已经做好了静态资源的映射，因此我们无需任何操作
                //.excludePathPatterns("/getUserById")表示需要排除的地址
                registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
           }

}

至此，java Interceptor就算是入门啦！！！
小伙伴们如果在项目中遇到问题可以在线讨论哟！！！
本文章纯属个人学习记录，如有问题，请不吝赐教。