18Spring Boot拦截器精讲

已于 2023-09-09 10:58:26 修改
阅读量198 收藏
点赞数
分类专栏： springboot 文章标签： spring boot java spring
于 2022-09-29 17:38:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41946216/article/details/127110103
版权

       我们对拦截器并不陌生，无论是 Struts 2 还是 Spring MVC 中都提供了拦截器功能，它可以根据 URL 对请求进行拦截，主要应用于登陆校验、权限验证、乱码解决、性能监控和异常处理等功能上。Spring Boot 同样提供了拦截器功能。 

       在 Spring Boot 项目中，使用拦截器功能通常需要以下 3 步：

  1. 定义拦截器；
  2. 注册拦截器；
  3. 指定拦截规则（如果是拦截所有，静态资源也会被拦截）。

定义拦截器

       在 Spring Boot 中定义拦截器需要创建一个拦截器类，并实现 HandlerInterceptor 接口中定义以下 3 个方法，如下表。

返回值类型方法声明描述
booleanpreHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 该方法在控制器处理请求方法前执行，其返回值表示是否中断后续操作，返回 true 表示继续向下执行，返回 false 表示中断后续操作。
voidpostHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)该方法在控制器处理请求方法调用之后、解析视图之前执行，可以通过此方法对请求域中的模型和视图做进一步修改。
voidafterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)该方法在视图渲染结束后执行，可以通过此方法实现资源清理、记录日志信息等工作。

在 cn.edu.tyuy.componet 中创建 LoginInterceptor 的拦截器类，对登陆进行拦截，代码如下。

mport lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    //调用控制器中的目标方法前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object loginUser = request.getSession().getAttribute("loginUser");
        if (loginUser == null) {
            //未登录，返回登陆页
            request.setAttribute("msg", "您没有权限进行此操作，请先登陆！");
            request.getRequestDispatcher("/index.html").forward(request, response);
            return false;
        } else {
            //放行
            return true;
        }
    }
    //调用控制器中的目标方法后执行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行{}", modelAndView);
    }
    //页面渲染后执行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行异常{}", ex);
    }
}

注册拦截器

        创建配置类 MvcConfig（使用了 @Configuration 注解的类），并实现 WebMvcConfigurer 接口，重写 addInterceptors() 方法，并在该方法中调用 registry.addInterceptor() 方法将自定义的拦截器注册到容器中，代码如下。

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

@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor());
    }
}

指定拦截规则

       修改 MvcConfig 配置类中 addInterceptors() 方法的代码，继续指定拦截器的拦截规则，代码如下。

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Slf4j
@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        log.info("注册拦截器");
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") //拦截所有请求，包括静态资源文件
                .excludePathPatterns("/", "/login", "/index.html", "/user/login",
                        "/css/**", "/images/**", "/js/**", "/fonts/**"); //放行登录页，登陆操作，静态资源
    }
}

       在指定拦截器拦截规则时，调用了两个方法，这两个方法的说明如下：

  • addPathPatterns：该方法用于指定拦截路径，例如拦截路径为“/**”，表示拦截所有请求，包括对静态资源的请求。
  • excludePathPatterns：该方法用于排除拦截路径，即指定不需要被拦截器拦截的请求。

        至此，拦截器的基本功能已经完成，接下来，我们先实现登陆功能，为验证登陆拦截做准备。

实现登陆功能

1. 创建login.html 和 main.html 到 src/main/resources/templates 中

login.html 

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>登录</title>
</head>
<body>
    <p style="color: red" th:text="${msg}" th:if="${not #strings.isEmpty(msg)}"></p>
    <form th:action="@{/user/login}" method="post">
        用户名：<input type="text" name="username" placeholder="Password" th:placeholder="username"/><br/>
        密码：<input type="password" name="password" placeholder="Password" th:placeholder="password"/><br/>
        <input type="submit" value="登录"/>
    </form>
</body>
</html>

main.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>主页</title>
</head>
<body>
    <p>Welcome to main page! [[${session.loginUser.username}]]</p>
</body>
</html>

2. 创建 LoginController， 并在其中添加处理登陆请求的方法 doLogin()，代码如下。 

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpSession;
import java.util.Map;
@Slf4j
@Controller
public class LoginController {
    @RequestMapping("/user/login")
    public String doLogin(User user, Map<String, Object> map, HttpSession session) {
        if (user != null && StringUtils.hasText(user.getUsername()) && "123456".equals(user.getPassword())) {
            session.setAttribute("loginUser", user);
            log.info("登陆成功，用户名：" + user.getUsername());
            //防止重复提交使用重定向
            return "redirect:/main.html";
        } else {
            map.put("msg", "用户名或密码错误");
            log.error("登陆失败");
            return "login";
        }
    }
}

3. 在配置类 MvcConfig 中添加视图映射，代码如下。

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Slf4j
@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        log.info("注册拦截器");
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") //拦截所有请求，包括静态资源文件
                .excludePathPatterns("/", "/login", "/index.html", "/user/login",
                        "/css/**", "/images/**", "/js/**", "/fonts/**"); //放行登录页，登陆操作，静态资源
    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        //当访问 “/” 或 “/index.html” 时，都直接跳转到登陆页面
        registry.addViewController("/").setViewName("login");
        registry.addViewController("/index.html").setViewName("login");
        //添加视图映射 main.html 指向  main.html
        registry.addViewController("/main.html").setViewName("main");
    }
}

验证登陆及登陆拦截功能

1. 启动 Spring Boot，在未登录的情况下，直接通过“http://localhost:8080/login.html”访问主页

2. 在登陆页用户名和密码输入框内分别输入 “admin”和“123456”

17Spring Boot整合Thymeleaf

19Spring Boot国际化

爱吃面的猫
关注
专栏目录
Spring Boot拦截器精讲
洛卡JAVA架构师每日分享Java架构师知识
06-02 2021
我们对拦截器并不陌生，无论是 Struts 2 还是 Spring MVC 中都提供了拦截器功能，它可以根据 URL 对请求进行拦截，主要应用于登陆校验、权限验证、乱码解决、性能监控和异常处理等功能上。Spring Boot 同样提供了拦截器功能。在 Spring Boot 项目中，使用拦截器功能通常需要以下 3 步： 定义拦截器； 注册拦截器； 指定拦截规则（如果是拦截所有，静态资源也会被拦截）。 定义拦截器 在 Spring Boot 中定义拦截器十分的简单，只需要创建一个拦截器类，并实现 Handle
Springboot 拦截器，拦截所有请求，判断是否登录，验证权限
weixin_58696998的博客
05-09 1万+
Java的三大器 拦截器的作用 Java里的拦截器是动态拦截Action调用的对象，它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码，也可以在一个Action执行前阻止其执行，同时也提供了一种可以提取Action中可重用部分代码的方式。 功能：可以进行权限验证，审计日志等。 代码实现 拦截器配置类 package com.thk.Interceptor; import org.springframework.context.annotation.Bean; i..
SpringBoot 请求拦截
风信子
04-26 4096
在 Spring Boot 中，请求拦截有如下三种方式切片（Aspect）过滤器（Filter）拦截器（Interceptor）
Springboot 中使用拦截器
<sdffdsfsdfdfs>sfsfsfsdfsdffds</sdfsDS>Fsd
04-20 474
????????关注后回复“进群”，拉你进程序员交流群????????作者丨武哥来源丨武哥聊编程拦截器的原理很简单，是 AOP 的一种实现，专门拦截对动态资源的后台请求，即拦截对控制层...
springboot拦截器
qq_52314126的博客
10-25 5116
springboot拦截器的使用
Spring+SpringMVC+MyBatis+Springboot介绍
qq_36335126的博客
08-02 3082
SSM（Spring+SpringMVC+MyBatis）框架集由Spring、SpringMVC、MyBatis三个开源框架整合而成，常作为数据源较简单的web项目的框架。 其中spring是一个轻量级的控制反转（IoC）和面向切面（AOP）的容器框架。 SpringMVC分离了控制器、模型对象、分派器以及处理程序对象的角色，这种分离让它们更容易进行定制。 MyBatis是一个支持普通SQL查询，存储过程和高级映射的优秀持久层框架。 1.SSM有什么用？ SpringMVC： 1.客户端发送请求到Disp
一文带你搞懂 Spring Security
m0_71777195的博客
12-27 2129
编写类，实现PasswordEncoder 接口/*** 凭证匹配器，用于做认证流程的凭证校验使用的类型* 其中有2个核心方法* 1. encode - 把明文密码，加密成密文密码* 2. matches - 校验明文和密文是否匹配* *//*** 加密* @param charSequence 明文字符串* @return*/@Overridetry {return "";}}/*** 密码校验* @param charSequence 明文，页面收集密码。
SpringBoot - 精讲
badwomen___的博客
05-28 262
一.SpringBoot入门 文章目录一.SpringBoot入门1.认识SpringBoot1.1.什么是SpringBoot1.2.SpringBoot的特点2.HelloWorld程序2.1.导入依赖2.2.创建配置类2.3.编写Controller2.4.启动测试二.SpringBoot分析1.spring-boot-starter-parent2.spring-boot-starter-web3.@SpringBootApplication4.SpringApplication.run三.Spri
Spring Security 2配置简化解析
Spring Security还支持更复杂的配置，比如自定义过滤器、支持OAuth、SAML等身份验证协议，以及与Spring MVC、Spring Boot的深度集成。 7. **安全性测试**： 在配置完成后，进行安全性测试是非常重要的，以确保...
SpringBoot的拦截器
weixin_46007404的博客
06-27 272
SpringBoot的拦截器 要求：用户没有登录，不可以进入用户中心页面，跳转到登录页面；当用户登录以后，才能进入用户中心页面 1.UserController控制类 @Controller public class UserController { //假装这是数据库内的数据，并取出来用 public static Map<String,String> db=new HashMap(); static { db.put("zhangsan","zhang
SpringBoot 拦截器
qq_46100517的博客
04-12 122
拦截器一、编写一个拦截器实现HandlerInterceptor接口二、拦截器注册到容器中 拦截器实现的几个步骤 1、编写一个拦截器实现HandlerInterceptor接口 2、拦截器注册到容器中（实现WebMvcConfigurer） 3、指定拦截规则【如果是拦截所有，静态资源也会被拦截】 一、编写一个拦截器实现HandlerInterceptor接口 package com.atguigu.admin.interceptor; import lombok.extern.slf4j.Slf
SpringBoot 全局请求拦截
一碗清深的博客
10-24 874
在Spring Boot中，可以使用拦截器（Interceptor）来实现全局请求拦截。RequestBodyAdvice和ResponseBodyAdvice是Spring框架提供的两个接口，用于在请求处理过程中对请求体和响应体进行处理。
在springboot中使用拦截器
进击的豌豆的博客
06-30 9966
目前有一个需求，是在现有项目中集成一个简单的登录功能，想到了使用过滤器和拦截器实现，这篇文章介绍如何使用spring的拦截器。拦截器是在面向切面编程中应用的，就是在你的service或者一个方法前调用一个方法，或者在方法后调用一个方法。是基于JAVA的反射机制。过滤前->拦截前->Action处理->拦截后->过滤后 1）预处理preHandle()方法2）后处理postHandle()方法3）返回处理afterCompletion()方法注：一般使用preHandle这个拦截器进行预处理，对url进行请求
谈谈spring中的拦截器interceptor
热门推荐
hongxingxiaonan的专栏
08-29 2万+
谈谈spring中的拦截器interceptor 在web开发中，拦截器是经常用到的功能。它可以帮我们验证是否登陆、预先设置数据以及统计方法的执行效率等等。今天就来详细的谈一下spring中的拦截器。spring中拦截器主要分两种，一个是HandlerInterceptor，一个是MethodInterceptor。 一，HandlerInterceptor拦截器 HandlerInterc
SpringBoot中使用拦截器
最新发布
Annaday的博客
08-17 898
Interceptor（拦截器）是一种面向对象编程（OOP）和软件开发中广泛使用的设计模式，特别是基于请求-响应的应用程序中，如Web应用、RestfulAPI等。
Springboot 拦截器(HandlerInterceptor)
baidu_38945557的博客
12-30 2625
拦截器就是面向切面编程----AOP的具体实现。可以使用Interceptor来执行某些任务，丽日再Controller处理之前编写日志，权限校验，通用行为（读取cookie得到用户信息并将用户对象放入请求，方便后续使用）等。在Spring中，当请求发送到Controller时，在被Controller处理之前，它经过Interceptors（0个或多个）拦截器。
Spring Boot实战：拦截器
LHY537200的博客
08-06 3801
什么是拦截器：拦截器在SpringBoot中主要有以下几个作用： 1.2拦截器的基本使用1.⾃定义拦截器：实现HandlerInterceptor接⼝，并重写其所有⽅法 2.注册配置拦截器：实现WebMvcConfigurer接⼝，并重写addInterceptors⽅法 3.启动服务, 试试访问任意请求, 观察后端⽇志 可以看到preHandle ⽅法执⾏之后就放⾏了, 开始执⾏⽬标⽅法, ⽬标⽅法执⾏完成之后执⾏ postHandle和afterCompletion⽅法.
spring 拦截器拦截所有的请求
ljyshiqihao的博客
09-25 2511
<mvc:interceptor> <mvc:mapping path="/**"/> <ref bean="_DotnetTicketLoginContextInterceptor"/> </mvc:interceptor> mapping path配置两个*， 否则拦截不住子目录 ， 如/...
Spring Boot 拦截器
08-14
在Spring Boot中，可以使用拦截器来对请求进行拦截和处理。拦截器是一种AOP（面向切面编程）的技术，在请求到达控制器之前或之后对请求进行处理。拦截器可以用于实现一些通用的功能，如日志记录、权限验证、参数校验等。 在Spring Boot中定义拦截器需要以下步骤： 1. 创建一个拦截器类，该类需要实现HandlerInterceptor接口。可以在拦截器中重写preHandle、postHandle和afterCompletion等方法来实现请求的前置处理、后置处理和完成处理。 2. 创建一个拦截器配置类，该类需要实现WebMvcConfigurer接口，并重写addInterceptors方法。在该方法中，可以注册拦截器类，并为其定义拦截规则。 在配置类中，可以通过使用addPathPatterns方法来定义需要拦截的请求路径，也可以使用excludePathPatterns方法来排除某些请求路径不被拦截。 拦截器与过滤器在功能和使用上有一些区别： 1. 归属不同：过滤器属于Servlet技术，而拦截器属于SpringMVC技术。 2. 内容不同：过滤器对所有访问进行增强，而拦截器仅针对SpringMVC的访问进行增强。 通过上述步骤定义和配置拦截器，可以在Spring Boot应用中实现对请求的拦截和处理。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [Spring-Boot 拦截器](https://blog.csdn.net/PeterMrWang/article/details/123916751)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *2* [Springboot——拦截器](https://blog.csdn.net/weixin_51351637/article/details/128058053)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值