简单总结SpringMVC拦截器的使用方法


Posted in Java/Android onJune 28, 2021

SpringMVC拦截器

拦截器类似于Filter过滤器,它是springMVC特有的,它可以预处理和后处理,我们可以定义一些拦截器来实现特定的业务。

过滤器与拦截器本质区别:

(1)拦截器时AOP思想的具体应用(一个横切面,直接切进请求响应中去)。

(2)拦截器时spring MVC特有的。

(3)拦截器只会拦截 访问控制器的方法,如果访问静态资源如:.jsp/html/css/image/js 时,它不会去拦截,而Filter过滤器无论什么都会去拦截。

自定义拦截器需要两步:

第一步:编写自定义类实现 HandlerInterceptor 接口,且必须重写方法;

第二步:在配置类中,注册拦截器,实现 WebMvcConfigurer接口,重写对应的方法;

(1)public boolean preHandle() {}

请求前处理的逻辑 - 前置。
方法返回值:返回布尔值,返回true表示可以执行后续代码,返回false程序会终止。

(2)public void postHandle(){}

请响应前处理的逻辑 - 后置。
方法返回值:无返回值。

目录:

简单总结SpringMVC拦截器的使用方法

package com.lxc.springboot.interceptor;
 
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
 
@Component
public class MyInterceptor implements HandlerInterceptor {
    private static final Logger LOG = LoggerFactory.getLogger(LogInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        s
        // 拦截前的操作
        System.out.println("-----------前置拦截-----------");
        return true;
    }
    
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 拦截后的操作
        System.out.println("------------后置拦截------------");
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 可以做一些清理工作
    }
}

注册拦截器:

package com.lxc.springboot.config;
 
 
import com.lxc.springboot.intercetor.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
import javax.annotation.Resource;
 
/**
 * @扩展springMVC
 * 第一步:
 * @Configuration 注解的作用:让这个类变为配置类
 * 第二步:
 * 必须实现 WebMvcConfigurer 接口
 */
@Configuration
public class SpringMvcConfig implements WebMvcConfigurer {
    @Resource
    private MyInterceptor myInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // addInterceptor():注册拦截器,参数是一个拦截器
        // addPathPatterns(): 路径映射,哪些路径需要被拦截,/** 全部拦截
        // excludePathPatterns(): 排除哪些路径,不会被拦截
        registry.addInterceptor(myInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/login");
    }
}

简单总结SpringMVC拦截器的使用方法

小例子

跟Filter一样,记录接口的请求响应耗时:

package com.lxc.springboot.interceptor;
 
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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;
 
/**
 * 这个是拦截器,与过滤器区别:
 *
 * 【【【【特别注意:增加拦截器,还需要在config中增加一个配置类!配置】】】】
 *
 * (1)拦截器是spring特有的,经常用于登录校验、权限验证、请求打印日志等等。
 * (2)拦截器不需要你手动调用后续代码执行,它是有两个方法的,且分开的,一个前,一个后
 * (3)而过滤器,我们会在打印日志的中间,使用filterChain.doFilter()方法去调用后续代码执行的!
 * (4)拦截器的 preHandle 前置处理方法,必须返回true,否则后续逻辑不会执行,整个业务也会结束!
 */
@Component // 增加这个注解,让spring能扫描到这个类
public class LogInterceptor implements HandlerInterceptor {
    private static final Logger LOG = LoggerFactory.getLogger(LogInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        LOG.info("【全局拦截器】");
        LOG.info("*********** InterceptorLog日志开始 *********** ");
        LOG.info("* 请求地址: {}, 方法: {}", request.getRequestURL().toString(), request.getMethod());
        LOG.info("* 远程地址: {}, 域名: {}, 端口: {}", request.getRemoteAddr(), request.getRemoteHost(), request.getRemotePort());
        long startTime = System.currentTimeMillis();
        request.setAttribute("boot-responseTime", startTime);
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // request.getAttribute("boot-responseTime") 返回的是Object
        long startTimed = (long) request.getAttribute("boot-responseTime");
        LOG.info(" *********** InterceptorLog 结束,耗时: {} ms *********** ", System.currentTimeMillis() - startTimed);
    }
}

在配置类中注册拦截器:

package com.lxc.springboot.config;
 
import com.lxc.springboot.intercetor.LogInterceptor;
import com.lxc.springboot.intercetor.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
import javax.annotation.Resource;
 
@Configuration
public class SpringMvcConfig implements WebMvcConfigurer {
    @Resource
    private MyInterceptor myInterceptor;
    @Resource
    private LogInterceptor logInterceptor;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/login");
    }
    
}

测试:

简单总结SpringMVC拦截器的使用方法

到此这篇关于简单总结SpringMVC拦截器的使用方法的文章就介绍到这了,更多相关SpringMVC拦截器内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Java/Android 相关文章推荐
源码解读Spring-Integration执行过程
Jun 11 Java/Android
springBoot基于webSocket实现扫码登录
Jun 22 Java/Android
Spring整合Mybatis的全过程
Jun 28 Java/Android
Spring Boot 排除某个类加载注入IOC的操作
Aug 02 Java/Android
mybatis3中@SelectProvider传递参数方式
Aug 04 Java/Android
Logback 使用TurboFilter实现日志级别等内容的动态修改操作
Aug 30 Java/Android
Netty分布式客户端接入流程初始化源码分析
Mar 25 Java/Android
MyBatis配置文件解析与MyBatis实例演示
Apr 07 Java/Android
Android Flutter实现3D动画效果示例详解
Apr 07 Java/Android
java开发双人五子棋游戏
May 06 Java/Android
java实现面板之间切换功能
Jun 10 Java/Android
Java结构型设计模式之组合模式详解
Sep 23 Java/Android
SpringBoot实现异步事件驱动的方法
Jun 28 #Java/Android
Spring整合Mybatis的全过程
Jun 28 #Java/Android
Java中常用解析工具jackson及fastjson的使用
Java中使用Filter过滤器的方法
Jun 28 #Java/Android
浅谈Python魔法方法
Java实现二维数组和稀疏数组之间的转换
深入理解java.lang.String类的不可变性
You might like
法兰绒滤网冲泡
2021/03/03 冲泡冲煮
php代码把全角数字转为半角数字
2007/12/10 PHP
PHP MVC框架skymvc支持多文件上传
2016/05/26 PHP
php在windows环境下获得cpu内存实时使用率(推荐)
2018/02/08 PHP
laravel框架使用阿里云短信发送消息操作示例
2020/02/15 PHP
判断脚本加载是否完成的方法
2009/05/26 Javascript
JavaScript 变量基础知识
2009/11/07 Javascript
JavaScript高级程序设计 错误处理与调试学习笔记
2011/09/10 Javascript
jQuery表单域属性过滤器用法分析
2015/02/10 Javascript
JS 实现倒计时数字时钟效果【附实例代码】
2016/03/30 Javascript
3分钟快速搭建nodejs本地服务器方法运行测试html/js
2017/04/01 NodeJs
JS+Ajax实现百度智能搜索框
2017/08/04 Javascript
Angular网络请求的封装方法
2018/05/22 Javascript
nuxt.js 在middleware(中间件)中实现路由鉴权操作
2020/11/06 Javascript
可用于监控 mysql Master Slave 状态的python代码
2013/02/10 Python
Python常用的爬虫技巧总结
2016/03/28 Python
Sanic框架请求与响应实例分析
2018/07/16 Python
对python模块中多个类的用法详解
2019/01/10 Python
将python图片转为二进制文本的实例
2019/01/24 Python
python里 super类的工作原理详解
2019/06/19 Python
基于python全局设置id 自动化测试元素定位过程解析
2019/09/04 Python
Python 中 -m 的典型用法、原理解析与发展演变
2019/11/11 Python
基于python+selenium的二次封装的实现
2020/01/06 Python
Python实现点云投影到平面显示
2020/01/18 Python
使用python实现学生信息管理系统
2021/02/25 Python
css3实现超炫风车特效
2014/11/12 HTML / CSS
CSS3实现淘宝留白的方法
2020/06/05 HTML / CSS
html通过canvas转成base64的方法
2019/07/18 HTML / CSS
俄罗斯领先的移动和数字设备在线商店:Svyaznoy.ru
2020/12/21 全球购物
志愿者活动总结
2014/04/28 职场文书
教师职位说明书
2014/07/29 职场文书
2014年自愿离婚协议书
2014/10/10 职场文书
2015年春节标语口号
2014/12/09 职场文书
第一节英语课开场白
2015/06/01 职场文书
2015初中生物教研组工作总结
2015/07/21 职场文书
教你怎么用python实现字符串转日期
2021/05/24 Python