简单总结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 相关文章推荐
解析Java异步之call future
Jun 14 Java/Android
详解Java线程池是如何重复利用空闲线程的
Jun 26 Java/Android
java泛型通配符详解
Jul 25 Java/Android
MyBatis-Plus 批量插入数据的操作方法
Sep 25 Java/Android
InterProcessMutex实现zookeeper分布式锁原理
Mar 21 Java/Android
Mybatis-Plus 使用 @TableField 自动填充日期
Apr 26 Java/Android
Java版 单机五子棋
May 04 Java/Android
Java 定时任务技术趋势简介
May 04 Java/Android
Java线程的6种状态与生命周期
May 11 Java/Android
JAVA springCloud项目搭建流程
May 11 Java/Android
springboot+rabbitmq实现智能家居实例详解
Jul 23 Java/Android
Java Spring读取和存储详细操作
Aug 05 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
Apache2 httpd.conf 中文版
2006/11/17 PHP
PHP容易被忽略而出错陷阱 数字与字符串比较
2011/11/10 PHP
浅谈socket同步和异步、阻塞和非阻塞、I/O模型
2016/12/15 PHP
Yii2.0多文件上传实例说明
2017/07/24 PHP
PHP Web表单生成器案例分析
2020/06/02 PHP
jQuery 前的按键判断代码
2010/03/19 Javascript
最简单的js图片切换效果实现代码
2011/09/24 Javascript
验证手机号码的JS方法分享
2013/09/10 Javascript
基于js实现微信发送好友如何分享到朋友圈、微博
2015/11/30 Javascript
AngularJS 让人爱不释手的八种功能
2016/03/23 Javascript
浅谈JS中json数据的处理
2016/06/30 Javascript
Angular 2应用的8个主要构造块有哪些
2016/10/17 Javascript
jq checkbox 的全选并ajax传参的实例
2017/04/01 Javascript
React Native之prop-types进行属性确认详解
2017/12/19 Javascript
vue2.0 根据状态值进行样式的改变展示方法
2018/03/13 Javascript
使用vue-router为每个路由配置各自的title
2018/07/30 Javascript
Vue基本使用之对象提供的属性功能
2019/04/30 Javascript
element-ui tree结构实现增删改自定义功能代码
2020/08/31 Javascript
Vue表单提交点击事件只允许点击一次的实例
2020/10/23 Javascript
[02:52]DOTA2新手基础教程 米波
2014/01/21 DOTA
[03:12]2016完美“圣”典风云人物:单车专访
2016/12/02 DOTA
Python的Django应用程序解决AJAX跨域访问问题的方法
2016/05/31 Python
Python随机数random模块使用指南
2016/09/09 Python
pycharm设置python文件模板信息过程图解
2020/03/10 Python
pytorch学习教程之自定义数据集
2020/11/10 Python
Python join()函数原理及使用方法
2020/11/14 Python
HTML5的download属性详细介绍和使用实例
2014/04/23 HTML / CSS
顶级宝石首饰网络零售商:Angara
2016/10/25 全球购物
建筑公司文秘岗位职责
2013/11/29 职场文书
同学会邀请书大全
2014/01/12 职场文书
学校安全生产承诺书
2014/05/23 职场文书
调研座谈会发言材料
2014/08/23 职场文书
重阳节演讲稿:尊敬帮助老人 弘扬传统美德
2014/09/25 职场文书
文书工作总结(范文)
2019/07/11 职场文书
草系十大最强宝可梦,纸片人上榜,榜首大家最熟悉
2022/03/18 日漫
SQL Server #{}可以防止SQL注入
2022/05/11 SQL Server