springboot 拦截器

news2024/11/17 18:26:08

定义

拦截器类似于javaweb中filter 功能
注意: 只能拦截器controller相关的请求

作用

举一个例子，例如我们在Controller中都有一段业务逻辑，这样我们就可以都统一放在拦截器中
在这里插入图片描述
因此拦截器的作用就是将controller中共有代码放入到拦截器中执行,减少controller中代码冗余

特性

1).拦截器只能拦截controller相关请求
2).拦截器可以中断请求轨迹
3).请求之前如果该请求配置了拦截器,请求会先经过拦截器,拦截器放心之后执行请求的controller,controller执行完成之后会回到拦截器继续执行拦截器中的代码

。

拦截器开发

a.类 implement HandlerInterceptor 接口引入默认实现

preHandler : 预先处理方法: 最先执行方法返回值布尔类型 true 放行请求 false 中断controller 中内容

postHandler ： 过程中处理: controller返回之后回到postHandler这个方法执行,执行完成这个方法开始响应浏览器

afterCompletion 最后完成: 当响应结束之后会执行拦截器中这个方法内容

b.配置拦截器

springboot 提供了springmvc配置类: WebMvcConfigurer
基本格式如下：
类 implement WebMvcConfigurer{
//覆盖配置拦截器方法
1.使用哪个拦截器 2.拦截器拦截请求 3.排除那些请求
}

具体实例

在项目文件中新建interceptors文件夹，新建拦截器类


public class MyInterceptor1 implements HandlerInterceptor {

    private static final Logger log = LoggerFactory.getLogger(MyInterceptor1.class);

    //pre handler 最先执行
    //参数3: handler 当前请求请求的控制器方法对象  DemoController#demo
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.debug("handler: {} ", handler);
        log.debug("===========1=========");
//        response.sendRedirect(request.getContextPath()+"/403.jsp");
        return true;//放行 false 中断
    }

    //参数3: handler 当前请求请求的控制器方法对象  DemoController#demo
    //参数4: modelAndView 模型和视图  当前请求访问方法的modelandview对象
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.debug("===========2=========");
        //log.debug("view: {}",modelAndView.getViewName());
    }

    //参数3: handler 当前请求请求的控制器方法对象  DemoController#demo
    //参数4: exception 如果控制器出现异常时异常对象
    //这个方法: finally{}代码块  总是执行  无论请求正确,出现异常
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.debug("===========3=========");
    }
}

在项目文件中配置WebMvcConfigure

@Configuration
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor1()) //指定拦截器
                .addPathPatterns("/**")//拦截所有
                .excludePathPatterns("/file/**");//排除那些路径
    }
}