springboot学习七：Spring Boot2.x 拦截器基础入门&实战项目场景实现

已于 2022-08-22 21:28:06 修改
阅读量2.3k 收藏 2
点赞数 1
分类专栏： spring、springboot、springcloud 文章标签： spring boot 学习 java
于 2022-08-12 15:22:06 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40036754/article/details/126059642
版权

文章目录

导言

SpringBoot 拦截器和过滤器区别及应用

一、拦截器

  1. 拦截器是什么?
    简单的来说，就是一道阀门，在某个方法被访问之前，进行拦截，然后在之前或之后加入某些操作，拦截器是AOP 的一种实现策略。
  2. 拦截器主要做什么?
    • 对正在运行的流程进行干预。
  3. 拦截器的代码实现。拦截器也主要有三个方法:
    • 其中preHandle是在请求之前就进行调用，如果该请求需要被拦截，则返回false，否则true;
    • postHandle是在请求之后进行调用，无返回值;
    • afterCompletion是在请求结束的时候进行调用，无返回值。

二、创建项目 springboot-interceptor

  1. 根据 springboot 学习二：springboot 第一次创建 web 项目，打包项目并测试成功 博文，快速创建本项目：springboot-interceptor
  2. 项目依赖仅勾选web即可。
  3. 项目结构如下：(记得修改application配置文件的后缀为 yml)
    在这里插入图片描述

三、Interceptor 快速入门

那么在 springBoot 中如何使用拦截器呢?
步骤:

  1. 创建一个类实现 HandlerInterceptor 接口，
  2. 再创建一个配置类实现 WebMvcConfigurer接口 ，重写 addInterceptors 方法。

1. 创建拦截器类

创建我们自己的拦截器类并实现 HandlerInterceptor 接口。

package com.feng.springboot_interceptor.interceptor;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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


public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor....在请求处理之前进行调用(Controller方法调用之前)");
        String requestUrl = request.getRequestURI();
        System.out.println("过滤器MyFilter拦截了请求为" + requestUrl);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor...请求处理之后进行调用，但是在视图被渲染之前(Controller方法调用之后)");
        //HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyInterceptor....在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对 应的视图之后执行(主要是用于进行资源清理工作)");
        //HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

2. 修改 application.yml

修改 application.properties 加入开发接口通配地址

#凡是请求地址层级带有 open 都放行
open:
  url: /**/open/**

3. 实现 WebMvcConfigurer

创建一个 Java 实现 WebMvcConfigurer ， 并重写 addInterceptors 方法。

package com.feng.springboot_interceptor.config;

import com.feng.springboot_interceptor.interceptor.MyInterceptor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
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 WebAppConfig implements WebMvcConfigurer {
    @Value("${open.url}")
    private String openUrl;

    @Bean
    public MyInterceptor getMyInterceptor() {
        return new MyInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 拦截以 /api 开头的请求，但是排除  openUrl：/**/open/**。 即 ：匹配这个（/**/open/**）URL的所有请求不拦截
        registry.addInterceptor(getMyInterceptor()).addPathPatterns("/api/**").excludePathPatterns(openUrl);
        // WebMvcConfigurer.super.addInterceptors(registry);
    }
}

4. 创建接口Interceptorcontroller

package com.feng.springboot_interceptor.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class InterceptorController {

    @GetMapping("/home/open/info")
    public String home() {
        return "欢迎来到首页";
    }

    @GetMapping("/user/interceptor")
    public String interceptor() {
        return "我被拦截了并通过了拦截器";
    }
}

5. 项目结构

在这里插入图片描述

5. 测试

  1. 带有open http://localhost:8080/api/open/home/info 不拦截
    在这里插入图片描述
  2. 不带open http://localhost:8080/api/user/interceptor 拦截
    在这里插入图片描述
    在这里插入图片描述

四、拦截校验用户是否登录实战

1. 加入需要权鉴接口、未登录接口

a、加入接口

    @GetMapping("/open/unLogin")    // 带 open 放行
    public String getUnauthorized() {
        return "登录失效，请重新登录";
    }

b、全部接口

package com.feng.springboot_interceptor.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class InterceptorController {

    @GetMapping("/home/open/info") // 带 open 放行
    public String home() {
        return "欢迎来到首页";
    }

    @GetMapping("/user/interceptor")
    public String interceptor() {
        return "我被拦截了并通过了拦截器";
    }

    @GetMapping("/open/unLogin")    // 带 open 放行
    public String getUnauthorized() {
        return "登录失效，请重新登录";
    }
}

2. 修改拦截器校验逻辑

package com.feng.springboot_interceptor.interceptor;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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


public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor....在请求处理之前进行调用(Controller方法调用之前)");
        String requestUrl = request.getRequestURI();
        System.out.println(requestUrl + "被 MyInterceptor 拦截了"); //判断是否携带凭证就可以了

        String token = request.getHeader("token");
        if (StringUtils.isEmpty(token)) {
            request.getRequestDispatcher("/api/open/unLogin").forward(request, response);
            return false;
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor...请求处理之后进行调用，但是在视图被渲染之前(Controller方法调用之后)");
        //HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyInterceptor....在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对 应的视图之后执行(主要是用于进行资源清理工作)");
        //HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

3. 测试

a. 首先访问 开放接口

http://localhost:8080/api/home/open/info
在这里插入图片描述
在这里插入图片描述

b. 访问 需权鉴接口

  1. 带 token
    http://localhost:8080/api/user/interceptor
    在这里插入图片描述

在这里插入图片描述

  1. 不带 token：http://localhost:8080/api/user/interceptor
    在这里插入图片描述

在这里插入图片描述

java冯坚持
关注
专栏目录
Spring Boot入门(25)：三位程序员谁能守护项目入口？- 过滤器、拦截器、监听器的对比及使用场景
**My Coding Family**
08-25 1963
Spring Boot 如何使用过滤器、拦截器、监听器对比及使用场景，一文带你吃透它。
2024最新首发，全网最全 Spring Boot 学习宝典(附思维导图)
热门推荐
**My Coding Family**
04-20 8万+
从0到1以知识点+实例+项目的教学模式对SpringBoot框架由浅入深进行学习，快来跟bug菌一起学习吧。
spring boot 2.X拦截器的正确使用
weixin_41639009的博客
07-21 185
第一步 创建拦截类继承HandlerInterceptor，类加上 @Component注解，重写HandlerInterceptor的三个方法，然后根据需要在三个方法中写业务逻辑即可 package com.nowcoder.community.controller.interceptor; import... @Component public class LoginTicketInterceptor implements HandlerInterceptor { @Autowired
【Springboot2.x】拦截器
fen_dou_shao_nian的博客
06-01 278
拦截器
SpringBoot 2.x拦截器
qq_31445987的博客
09-27 654
SpringBoot 2.x 拦截器注册方式 在SpringBoot 1.x中我们可以通过继承WebMvcConfigurerAdapter这个类来实现注册拦截器的功能，但在SpringBoot 2.x中，却不推荐我们通过这种方式来实现，我们可以通过继承WebMvcConfigurationSupport这个类来实现。 我们可以通过继承HandlerInterceptorAdapter这个抽象类来...
spring boot 2.X 实现自定义拦截器
冰冻非一日之寒
03-15 769
一、什么是拦截器 拦截器是spring aop思想的一种体现和运用，底层通过动态代理模式完成；拦截器不依赖于servlet容器，依赖于web框架，由于拦截器是基于web框架的调用，因此可以使用spring的依赖注入（DI）获取IOC容器中的各个bean；可以用来拦截一些非法的Action请求，或者是对Action请求进行一些预处理和请求后的一些处理等，使得我们业务更加符合实际需求，...
springboot2.x基础教程：过滤器和拦截器详解
编程之家出品
08-27 313
在springboot web项目开发过程中，我们通常需要对请求与响应的内容请求拦截处理，如进行请求日志记录、UA检查、用户权限验证、非法内容过滤等功能，这时候过滤器与拦截器就派上用场。 本文带大家讲解springboot如何使用过滤器与拦截器以及两者之间的区别。 本文导航过滤器SpringBoot使用过滤器拦截器过滤器与拦截器区别 过滤器 Servlet 过滤器可以动态地拦截请求和响应，以变换或使用包含在请求或响应中的信息。过滤器是一个实现了 javax.servlet.Filter 接口的 Java.
Spring Boot入门(02)：【教程】轻松搭建Spring Boot开发环境，启动你的第一个Web项目！
**My Coding Family**
08-11 3万+
快速搭建开发环境和启动项目是每个开发人员必备的技能。本文将为您提供一些简单易懂的方法和技巧，以帮助您快速搭建开发环境和启动项目。我们将介绍如何选择适合您的开发工具、配置您的操作系统、安装必要的软件包和依赖项，并开始编写您的第一个应用程序。无论您是一位新手还是一位经验丰富的开发人员，本文都会给您提供有用的信息和实用的建议，让您在最短时间内快速搭建和启动开发项目。
《滚雪球学Spring Boot》教程导航帖（更新于2024.06.20）
最新发布
**My Coding Family**
06-29 4万+
《滚雪球学Spring Boot》是由CSDN博主bug菌创作的全面Spring Boot教程。作者是全栈开发专家，在多个技术社区如CSDN、掘金、InfoQ、51CTO等担任博客专家，并拥有超过30万的全网粉丝。该教程分为入门篇和进阶篇，每篇包含详细的教学步骤，涵盖Spring Boot的基础和高级主题。
Spring Boot入门(01)：探索Spring Boot的学习历程、发展历程与成功之路
**My Coding Family**
03-09 3万+
Spring Boot是目前最流行的Java开发框架之一，它带来了前所未有的便利性和开发效率，同时也是Spring框架的一个重要组成部分。Spring Boot的出现不仅仅是为了简化Spring应用程序的开发过程，更是为了解决Spring框架中的一些问题，比如依赖管理、配置管理等，从而使Spring应用程序更容易上手，更易于维护。通过这篇文章，你将了解到Spring Boot的历史背景、设计理念、特性和优点，以及如何使用它来快速开发高效的Java应用程序。
springboot 2.x自定义拦截器实现
qq_38216502的博客
10-21 188
spring2X* 拦截器实现 HandlerInterceptor接口，下面是我自定义的接口 public class RequestFilter implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
Java --- springboot2配置拦截器
qq_46093575的博客
05-06 213
所有拦截器的 preHandle方法：①、如果当前拦截器prehandler返回为true。则执行下一个拦截器的preHandle。②、如果当前拦截器返回为false。直接 倒序执行所有已经执行了的拦截器的 afterCompletion；6、 前面的步骤有任何异常都会直接倒序触发 afterCompletion。可以处理请求的handler以及handler的所有 拦截器】3、如果任何一个拦截器返回false。5、倒序执行所有拦截器的postHandle方法。4、所有拦截器都返回True。
SpringBoot2.X拦截器配置
weixin_43432438的博客
04-14 1432
SpringBoot2.X拦截器配置
【Spring Boot2】拦截器
凤凰涅槃
02-21 194
目录实现拦截器步骤一、HandlerInterceptor二、容器三、拦截范围原理 实现拦截器步骤 一、HandlerInterceptor 编写一个拦截器实现HandlerInterceptor接口 /** * 登录检查 * 1.配置好拦截器要拦哪些请求 * 2.把这些配置放在容器中 */ @Slf4j public class LoginInterceptor implements HandlerInterceptor { /** * 目标方法执行之前 *
SpringBoot2之拦截器
maogenb的博客
05-05 2083
SpringBoo2因为整合了SpringMVC，因此SpringMVC的拦截器也被SpringBoot收入囊中，拦截器（Interceptor）是SpringMVC的核心功能之一，是利用Spring的**AOP**的**面向切面编程**的思想，可以很方便的实现对登录权限控制、日志打印等功能。...
SpringBoot_02拦截器
weixin_48751562的博客
10-21 805
拦截器
SpringBoot2.0学习第四篇之拦截器过滤器配置
西魏陶渊明的博客
03-11 700
对于JavaWeb开发,拦截器和过滤器无疑是两个非常重要的知识点,在传统SpringMVC的框架配置中,是令人很头疼的一个事情,因为需要在web.xml中配置，但是自从有了SpringBoot这一切都变得非常的简单,没有任何复杂点。任何人都能在1分钟内学会如何进行配置整合,下面跟着小编来一起配置拦截器和过滤器。 通读全文大概需要1分钟 image 教程目录 ...
springBoot 2.x过滤器--监听器--拦截器
猫腻的博客
07-15 221
springboot 2.x过滤器 1.什么是 springboot 2.x过滤器 类似于检票员,检验游客的门票 2.springboot里的过滤器 ApplicationContextHeaderFilter OrderedCharacterEncodingFilter OrderedFormContentFilter OrderedRequestContextFilter 3.过滤器的优先级 低位值意味着更⾼的优先级 Higher values are interpreted as lower
Spring Boot入门十——拦截器
i_wave的博客
05-25 103
在Spring Boot项目中使用拦截器主要分为三步 step1：在控制器中创建不同的视图页面，其中有需要拦截的页面 step2：创建拦截器对象实现HandlerInterceptor接口，并实现接口的方法，在preHandler()方法中编写拦截规则，可以将拦截的对象重定向到其他页面 public class UserInterceptor implements HandlerInterceptor { //定义拦截规则 @Override public boolean preHandl
Spring Boot：过滤器与拦截器实战，REST接口简易安全认证教程
本文详细探讨了如何在Spring Boot应用中利用过滤器（Filter）和拦截器（Interceptor）来实现REST接口的简易安全认证。首先，我们需要了解这两个概念与Spring Boot的关系，虽然它们在名称上与Spring相关，但实际上，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

java冯坚持

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值