SpringBoot自定义拦截器

最新推荐文章于 2023-08-11 11:11:43 发布
最新推荐文章于 2023-08-11 11:11:43 发布
阅读量540 收藏
点赞数 2
分类专栏： interceptor 文章标签： spring Boot interceptor
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wyz0923/article/details/88558141
版权

Interceptor的基本介绍和使用

简介

拦截器是可以动态的拦截action的调用，它提供了一个接口可以使开发者在一个Action执行的前后添加自己的逻辑。在AOP中，拦截器用于在某个方法或者字段被访问之前，进行拦截然后再之前或者之后加入某些操作。目前，我们需要掌握的主要是Spring的拦截器。

原理

拦截器：它采用了java动态代理和反射的机制来实现。

实现自定义拦截器步骤。

1.创建一个spring Web项目。
2.创建一个实现HandlerInterceptor接口的自定义拦截器实体类。
3.创建一个实现WebMvcConfigurer接口的配置类。将自定义拦截器添加到容器中，并配置拦截的路径。

1 开发工具 ：IntelliJ IDEA
当前spring boot备受欢迎的快速开发框架，我这里就采用spring boo框架搭建web项目 。
2 创建自定义拦截器
创建一个实现HandlerInterceptor接口的拦截器类MyInterceptor。
HandlerInterceptor 接口中定义了三个接口，分别是：preHandle（在调取action之前调用），postHandle（在action调用之后，返回视图对象之前调用）和afterCompletion（在action调用完成之后，返回视图之后调用，一般用于清理资源）如下图所示。在这里插入图片描述
在jdk8之前，接口中是没有方法体的，如果实现拦截器接口的话，要同时重写三个方法。很多情况下，我们实际中用不到三个拦截方法。所以jdk8之前我们自定义拦截器一般时继承一个抽象类适配器HandlerInterceptorAdapter。这时候想使用哪个方法，就重写那方法即可。而jdk8之后，接口中可以出现了方法体。所以现在我们可以直接实现接口，使用哪个方法直接重写即可。我这是都重写了。

package com.wyz.study.interceptor;


import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.View;

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

/**
 * @author wyz
 * @version 1.0
 * @ClassName: MyInterceptor
 * @Description: 自定义拦截器
 * @date 2019/3/12 12:03
 **/
@Component
public class MyInterceptor implements HandlerInterceptor {
    /**
     * 在业务调用action对象之前被调用
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("preHandle........");
        //从session中获取用户信息
        String username = (String) request.getSession().getAttribute("userName");
        //判断userName是否为null
        if(null == username){
            System.out.println("用户未登录，请先登录！！！");
            // 跳转到登录页面
            request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
            return false;
        }
        return true;
    }

    /**
     * 在请求完成之后，呈现视图对象之前被调用
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle-----------执行了！！！！！");
        String viewName = modelAndView.getViewName();
        View view = modelAndView.getView();

        System.out.println("viewName==="+viewName);
        System.out.println("view==="+view);


    }

    /**
     * 在请求请求结束之后被调用，可以使用该方法清理资源
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        System.out.println("afterCompletion#############执行了。。。。。。");
 
    }
}

3.创建配置实体类
创建一个将自定义拦截器加入容器中的配置实体类。该配置类要实现WebMvcConfigurer接口。重写addInterceptors方法。

package com.wyz.study.interceptor;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @author wyz
 * @version 1.0
 * @ClassName: MySpringMVCConfig
 * @Description: 这是一个配置类，将自定义的拦截器注册到容器中。
 * @date 2019/3/13 13:02
 **/
@Configuration
public class MySpringMVCConfigurer implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    /**
     * 将拦截器注册到容器中
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //设置拦截路径
        registry.addInterceptor(myInterceptor).addPathPatterns("/userInfo");
    }
}

验证自定义拦截器是否成功

1.创建页面
接下来创建几个简单的jsp页面。login.jsp(简单的登录页面),success.jsp(登录成功的页面)，userInfo.jsp(用户信息的页面) 。页面用于演示。所以很简陋。
在这里插入图片描述
login.jsp

<%--
  Created by IntelliJ IDEA.
  User: wyz
  Date: 2019/3/12
  Time: 11:57
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>登录页面</title>
</head>
<body>
    <form action="login" >
        用户名:<input type="text" name="userName">
        密码:<input type="password" name="passWord">
        <button >提交</button>
    </form>

</body>
</html>

success.jsp

<%--
  Created by IntelliJ IDEA.
  User: wyz
  Date: 2019/3/12
  Time: 11:57
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>成功页面</title>
</head>
<body>
   <h2>欢迎${userName},您已经登录成功！！！</h2>
    <<a href="userInfo">点击获取用户信息</a>
</body>
</html>

success.jsp

<%--
  Created by IntelliJ IDEA.
  User: wyz
  Date: 2019/3/13
  Time: 13:15
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>用户页面</title>
</head>
<body>
     <h2>用户名：${userName} 用户年龄:${age}（当用户名后面有名字出现，说明拦截器未设置成功，反之说明成功）</h2>
</body>
</html>

2.创建控制层
LoginController.java

package com.wyz.study.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;

/**
 * @author wyz
 * @version 1.0
 * @ClassName: LoginController
 * @Description: 用户登录控制层
 * @date 2019/3/12 12:04
 **/
@Controller
public class LoginController {


    /**
     * 跳转登录页面
     * @return
     */
    @RequestMapping("/toLogin")
    public String toLogin(){
        return "login";
    }

    /**
     * 登录操作
     * @param request
     * @param userName
     * @param passWord
     * @return
     */
    @RequestMapping("/login")
    public String login(HttpServletRequest request,String userName, String passWord){
        request.getSession().setAttribute("userName",userName);
        request.getSession().setAttribute("age",20);
        return "success";
    }
}

UserInfoController.java

package com.wyz.study.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author wyz
 * @version 1.0
 * @ClassName: UserInfoController
 * @Description: 这是用户的控制层
 * @date 2019/3/13 13:18
 **/
@Controller
public class UserInfoController {

    @RequestMapping("/userInfo")
    public String userInfo(){

        System.out.println("返回pay.jsp页面！！！");
        return "userInfo";
    }
}

3.验证
启动项目，在浏览器直接访问http://127.0.0.1:8080/userInfo，结果返回的是登录页面。
在这里插入图片描述
然后让我们看看代码和控制台打印的日志信息：
在这里插入图片描述
接口中输出的语句没有输出到控制台，输出的是自定义拦截器的preHandle拦截方法中的信息，由于用户没有登录，所以在调取用户信息接口的时候被拦截掉了。然后重定向到登录页面。这也证明了preHandle方法是在调取action之前执行的。
然后我们就登录一下，在访问连接看看。（登录里的信息随便填写。）

在这里插入图片描述
看到下面的页面，说明登录成功了。
在这里插入图片描述
，然后在访问userInfo（或者点击超链接）。查看控制台输出。
在这里插入图片描述
根据控制台的输入，可以发现执行顺序：preHandle() --> userInfo() --> preHandle() --> afterCompletion()。之前说了，preHandle()是在视图对象呈现前执行，而afterCompletion()是在视图对象呈现之后执行，是不是这样，只能看源码。。。。

从截图中可以得出结论，拦截器中的postHandle方法是在actin方法执行完后，才执行。是不是视图对象呈现前后需要看源码：
进入DispatcherServlet.doDispatch()中。
在这里插入图片描述
追进解析的方法中：

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
			@Nullable HandlerExecutionChain mappedHandler, @Nullable ModelAndView mv,
			@Nullable Exception exception) throws Exception {
			//这部分是对异常的解析
		boolean errorView = false;
		if (exception != null) {
			if (exception instanceof ModelAndViewDefiningException) {
				logger.debug("ModelAndViewDefiningException encountered", exception);
				mv = ((ModelAndViewDefiningException) exception).getModelAndView();
			}
			else {
				Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
				mv = processHandlerException(request, response, handler, exception);
				errorView = (mv != null);
			}
		}

		// 判断程序是否返回要呈现的视图 
		if (mv != null && !mv.wasCleared()) {
			render(mv, request, response);
			if (errorView) {
				WebUtils.clearErrorRequestAttributes(request);
			}
		}
		else {
			if (logger.isTraceEnabled()) {
				logger.trace("No view rendering, null ModelAndView returned.");
			}
		}

		if (WebAsyncUtils.getAsyncManager(request).isConcurrentHandlingStarted()) {
			// Concurrent handling started during a forward
			return;
		}
		
		if (mappedHandler != null) {
		//这是执行拦截器的afterCompletion方法。自定义的也是在这里执行的
			mappedHandler.triggerAfterCompletion(request, response, null);
		}
	}

render()
在这里插入图片描述
triggerAfterCompletion()
在这里插入图片描述
然后代码就会进入自定义的AfterCompletion()方法中。所以从源码上可以看出，postHandle()是在返回mv之后呈现视图对象之前执行。而AfterCompletion()实在视图呈现之后执行。

第一次写博客，写的不好请见谅，写的不好的地方请指出。谢谢

heling_m6ss
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot 自定义拦截器 的 源代码
01-27
SpringBoot 自定义拦截器 的 源代码 SpringBoot 自定义拦截器 一、自定义拦截器 二、编写控制器 三、添加拦截器对象，注入到容器的配置类中 另一种写法 四、最后application运行 我们对拦截器并不陌生，无论是 ...
springboot自定义拦截器
wangqsse的博客
07-06 787
与过滤器的区别，过滤器实现的是 javax.servlet.Filter接口，而这个接口是在Servlet规范中定义的，也就是说过滤器Filter 的使用要依赖于Tomcat等容器，导致它只能在web程序中使用。而拦截器(Interceptor) 它是一个Spring组件，并由Spring容器管理，并不依赖Tomcat等容器，是可以单独使用的。接口方法的实现逻辑，拦截处理接口入参，打印入参值、请求时间、url、ip、接口路径。拦截器需要被spring容器管理，定义之后需要注册到容器中才能生效。
SpringBoot自定义拦截器interceptor使用详解
mao_mao37的博客
08-11 1131
perHandle：preHandle方法的作用是，当请求在进入controller之前拦截请求，对请求进行预处理，比如登录验证（cookie,token，referer）或者单点登录cookie解析都可以在这方法中进行。该方法的返回值，如果返回true，表示放行至controller业务层，如果false，表示请求非法，结束请求并返回错误信息。
springboot自定义拦截器的方法
菜鸟教程
04-06 4657
更多python、PHP、JAVA教程请到友情连接： 菜鸟教程https://www.piaodoo.com 茂名一技http://www.enechn.comppt制作教程步骤 http://www.tpyjn.cn 兴化论坛http://www.yimoge.cn 电白论坛 http://www.fcdzs.com表格制作excel教程 http://www.tsgmyy.cn 高州阳光论坛 http://www.tsgmyy.cn 拦截器应该分属于web框架的组件，每个框架提供的自己的支持，实现
SpringBoot自定义拦截器和统一异常处理
You辉编程的博客
08-11 664
SpringBoot
springboot自定义拦截器filter
07-10
项目集成了sso资源拦截的控制，自己写了一个springBoot自定义的filter。可以减少一些不必要的资源拦截。自己做的一个小demo,共享于大家。
SpringBoot的拦截器
11-26
idea软件。SpringBoot的拦截器的博客所写的例子。preHandle（）方法的返回值true和false的详细区别还未描述
springboot创建拦截器过程图解
08-25
主要介绍了springboot创建拦截器过程图解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Springboot引入拦截器并放行swagger代码实例
08-25
主要介绍了Springboot引入拦截器并放行swagger代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
python学习导航.txt
05-06
python
node-v8.3.0-linux-s390x.tar.xz
05-06
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
嵌入式微处理器设计及应用
05-06
摘要：为满足智能家居座椅的交互式运动控制需求，基于AT89S52设计了嵌入式座椅运动控制系统。使用VB.net设计了游戏手柄按键读取软件，并在此基础上设计了座椅运动控制软件，软件可分别在“手柄模式”和“鼠标模式”下与嵌入式座椅运动控制器通信，进而控制座椅进行加速、减速、正转和反转等运动；构建了控制系统实验装置，实验结果表明，“鼠标模式”下，通过鼠标点击控制软件上功能按钮可实现对座椅的准确运动控制；“手柄模式”下，游戏手柄不仅可控制座椅运动，还可同步控制电脑上运行的游戏或远程遥控车，实现浸入感较强的座椅运动娱乐应用。
2024年中国NFC RFID阅读器行业研究报告.docx
05-06
2024年中国NFC RFID阅读器行业研究报告
node-v9.9.0-linux-ppc64le.tar.xz
最新发布
05-06
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
04-18 周四 为LLM-inference项目配置GitHub CI过程记录
05-06
04-18 周四 为LLM-inference项目配置GitHub CI过程记录
2024年中国AI和机器视觉行业研究报告.docx
05-06
2024年中国AI和机器视觉行业研究报告
计算机二级【公共基础知识速学教程】.pdf
05-06
内容概要：这份资料包含了计算机二级公共基础知识速学教程的内容大纲，涵盖了数据结构与算法、程序设计基础、软件工程基础、数据库设计基础等多个章节。其中包括了算法复杂度、数据结构、栈、队列、链表、二叉树、查找、排序等内容，以及程序设计方法、软件工程概念、数据库设计原理等知识点。 适用人群：适合希望系统学习计算机二级公共基础知识的学生、计算机专业学习者、程序员、软件工程师以及对数据结构、算法和数据库设计感兴趣的人群，希望通过系统学习提升自己的计算机基础知识和技能。 使用场景及目标：该教程可用于计算机相关专业的课程学习、自学提升或备考计算机二级公共基础考试。学习者可以通过逐章学习和实践，掌握数据结构与算法、程序设计基础、软件工程基础和数据库设计基础等知识，提高自己在计算机领域的理论基础和实践能力。 其他说明：学习者在使用这份教程时，可以结合实际案例和练习题进行深入学习和巩固。建议按照章节顺序系统学习，理解各个知识点的概念和应用，并通过实践项目或练习加深对计算机基础知识的理解和掌握。通过系统学习，可以提升自己在计算机领域的专业水平和能力。
减肥管理，全球前10强生产商排名及市场份额.docx
05-06
减肥管理，全球前10强生产商排名及市场份额
springboot 自定义拦截器
12-10
SpringBoot允许我们自定义拦截器来拦截请求并进行一些逻辑处理。下面是SpringBoot自定义拦截器的步骤： 1.创建一个拦截器类并实现HandlerInterceptor接口，该接口有三个方法：preHandle、postHandle和afterCompletion。其中preHandle方法在请求处理之前被调用，postHandle方法在请求处理之后被调用，afterCompletion方法在视图渲染之后被调用。 2.在拦截器类上使用@Component注解将其注入到Spring容器中。 3.创建一个配置类并实现WebMvcConfigurer接口，该接口有一个addInterceptors方法，可以用来添加自定义拦截器。 4.在addInterceptors方法中添加自定义拦截器，并指定拦截的路径。 下面是一个简单的示例： 1.创建一个拦截器类并实现HandlerInterceptor接口： ```java @Component public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 在请求处理之前进行逻辑处理 // 如果返回false，则请求不会被处理 return true; } } ``` 2.创建一个配置类并实现WebMvcConfigurer接口： ```java @Configuration public class MyWebMvcConfigurer implements WebMvcConfigurer { @Autowired private MyInterceptor myInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { // 添加自定义拦截器，并指定拦截路径 registry.addInterceptor(myInterceptor).addPathPatterns("/**"); } } ``` 在上面的示例中，我们创建了一个名为MyInterceptor的拦截器类，并将其注入到Spring容器中。然后，我们创建了一个名为MyWebMvcConfigurer的配置类，并在其中添加了我们的自定义拦截器，并指定了拦截的路径为“/**”。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值