springboot学习六：Spring Boot2.x 过滤器基础入门&实战项目场景实现

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

文章目录

导言

一、过滤器

  1. 过滤器是什么?
    它是基于Servlet 技术实现的， 简单的来说，过滤器就是起到过滤的作用，在web项目开发中帮我们过滤一些指定的 url做一些特殊的处理。 过滤器主要做什么?

    • 过滤掉一些不需要的东西，例如一些错误的请求。
    • 也可以修改请求和相应的内容。
    • 也可以拿来过滤未登录用户

  2. 过滤器的代码实现
    过滤器(filter)有三个方法，其中初始化(init)和摧毁(destroy)方法一般不会用到，主要用到的是doFilter这个方法。

  3. 怎么过滤呢?
    如果过滤通过，则在doFilter 执行 filterChain.doFilter(request,response); 。

二、 创建项目springboot-filter

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

三、Filter 快速入门

那么在springBoot中如何使用过滤器呢?

自定义Filter有两种实现方式，第一种是使用@WebFilter，第二种是使用 FilterRegistrationBean,下面我们分别来实现

1. @WebFilter 实现

@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。

属性名类型描述
filterNameString指定该Filter的名称
urlPatternsString指定该Filter所拦截的URL。
valueString与 urlPatterns 一致

a. 创建一个MyFilter.java实现Filter接口

package com.feng.springboot_filter.filter;

import org.springframework.core.annotation.Order;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@WebFilter(urlPatterns = "/api/*", filterName = "myFilter")
@Order(1) //指定过滤器的执行顺序,值越大越靠后执行
public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化过滤器");
        Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String requestURI = request.getRequestURI();
        String method = request.getMethod();
        System.out.println("拦截器 MyFilter 拦截了请求：" + requestURI + "，方法为：" + method);
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

b. 启动类加上 @ServletComponentScan 注解

在这里插入图片描述

c. 创建一个 FilterController 接口

package com.feng.springboot_filter.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 FilterController {

    @GetMapping("/user/filter")
    public String hello(){
        return "已经通过了过滤器";
    }

}

d. 创建一个 TestController 接口

package com.feng.springboot_filter.controller;

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

@RestController
public class TestController {

    @GetMapping("/test")
    public String hello(){
        return "hello world";
    }
}

e. 项目结构

在这里插入图片描述

f. 测试

i、拦截的请求

http://localhost:8080/api/user/filter
在这里插入图片描述
在这里插入图片描述

ii、未拦截的请求：没有走过滤器

http://localhost:8080/test
在这里插入图片描述
没有走过滤器
在这里插入图片描述

2、FilterRegistrationBean 实现

a、创建 FilterConfig 配置类

package com.feng.springboot_filter.config;

import com.feng.springboot_filter.filter.MyFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {
    @Bean
    public MyFilter myFilter() {
        return new MyFilter();
    }

    @Bean
    public FilterRegistrationBean getFilterRegistrationBean(MyFilter myFilter) {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        /**
         * 设置过滤器
         */
        filterRegistrationBean.setFilter(myFilter());
        /**
         * 拦截路径
         */
        filterRegistrationBean.addUrlPatterns("/api/*");
        /**
         * 设置名称
         */
        filterRegistrationBean.setName("myFilter");
        /**
         * 设置访问优先级 值越小越高
         */
        filterRegistrationBean.setOrder(1);
        return filterRegistrationBean;
    }
}

b、修改 MyFilter.java

//@WebFilter(urlPatterns = "/api/*", filterName = "myFilter")

c、修改启动类

//@ServletComponentScan

d、测试

结果和三.1.e一样，说明这两种方式都可以。

i、拦截的请求

http://localhost:8080/api/user/filter
在这里插入图片描述
在这里插入图片描述

ii、未拦截的请求：没有走过滤器

http://localhost:8080/test
在这里插入图片描述
在这里插入图片描述

四、过滤校验用户是否登录实战

采用第二种方式进行 过滤用户是否登录成功

1. 修改 application.yml

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

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

2. 修改 MyFilter

package com.feng.springboot_filter.filter;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.annotation.Order;
import org.springframework.util.AntPathMatcher;
import org.springframework.util.PathMatcher;
import org.springframework.util.StringUtils;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

//@WebFilter(urlPatterns = "/api/*", filterName = "myFilter")
@Order(1) //指定过滤器的执行顺序,值越大越靠后执行
public class MyFilter implements Filter {

    @Value("${open.url}")
    private String openUrl;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化过滤器");
        Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String requestURI = request.getRequestURI();
        String method = request.getMethod();
        System.out.println("拦截器 MyFilter 拦截了请求：" + requestURI + "，方法为：" + method);

        // 首先校验是否是开放 api
        // 是则：直接放行，否则：再校验token
        PathMatcher matcher = new AntPathMatcher();
        if (matcher.match(openUrl, requestURI)) {
            filterChain.doFilter(servletRequest, servletResponse);
        } else {
            String token = request.getHeader("token");
            if (StringUtils.isEmpty(token)) {
                // 若无 token，则转发到：未登录请求
                servletRequest.getRequestDispatcher("/api/open/unLogin").forward(servletRequest, servletResponse);
            } else {
                // 若有 则放行
                filterChain.doFilter(servletRequest, servletResponse);
            }
        }
        //filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

3. 新增 未登录接口、首页接口

a、新增接口

    @GetMapping("/open/home/info")
    public Map<String, String> getHome() {
        Map<String, String> map = new HashMap<>();
        map.put("游客", "欢迎访问首页");
        return map;
    }

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

b、全部接口

package com.feng.springboot_filter.controller;

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

import java.util.HashMap;
import java.util.Map;

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

    @GetMapping("/user/filter")
    public String hello() {
        return "已经通过了过滤器";
    }

    @GetMapping("/open/home/info")
    public Map<String, String> getHome() {
        Map<String, String> map = new HashMap<>();
        map.put("游客", "欢迎访问首页");
        return map;
    }

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

4. 测试

  1. 首先访问 开放接口
    http://localhost:8080/api/user/filter(直接放行)
    在这里插入图片描述

  2. 访问需权鉴接口：http://localhost:8080/api/user/filter

    • 不带 token
      在这里插入图片描述

    • 带上 token
      在这里插入图片描述

java冯坚持
关注
专栏目录
基于SpringBoot的仿哔哩哔哩后台系统+源代码+文档说明
11-28
业务开发流程 通用功能 - 数据加解密、安全验证、跨域处理、热部署、 - Json 处理 用户服务 - 用户注册和登录、忘记和修改密码、项目权限分配、 - 用户即时通讯、消息、订阅、关注 核心功能 - 视频上传和下载、视频轮播和异步加载、视频分享、 - 点赞、投币、分片、大规模弹幕实时加载、 - 观看记录同步 系统开发&部署 - 自动化部署、智能推荐、异步推送、数据统计、 - 日志记录、全局搜索、系统广播、负载均衡 ## 项目备注 1、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习，也适合小白学习进阶，当然也可作为毕设项目、课程设计、作业、项目初期立项演示等。 3、如果基础还行，也可在此代码基础上进行修改，以实现其他功能，也可用于毕设、课设、作业等。 下载后请首先打开README.md文件（如有），仅供学习参考, 切勿用于商业用途。
Springboot过滤器和拦截器详解及使用场景
qq_15654285的博客
05-06 84
Springboot过滤器和拦截器详解及使用场景_spring 过滤器 应用_头顶假发的博客-CSDN博客
Springboot2.x快速入门（三）过滤器、监听器、拦截器
qq_46033586的博客
01-11 426
案例项目demo_project101、启动类⾥⾯增加 @ServletComponentScan，进⾏扫描2、新建⼀个Filter类，implements Filter，并实现对应的接⼝3、@WebFilter 标记⼀个类为filter，被spring进⾏扫描4、urlPatterns：拦截规则，⽀持正则5、控制chain.doFilter的⽅法的调⽤，来实现是否通过放⾏。
Spring Boot (Filter)过滤器的实现以及使用场景
花&败
05-01 3466
一、过滤器简介 1、过滤器是什么？ Filter也称之为过滤器,过滤器是对数据进行过滤，预处理。开发人员可以对客户端提交的数据进行过滤处理，比如敏感词，也可以对服务端返回的数据进行处理。还有就是可以验证用户的登录情况，权限验证，对静态资源进行访问控制，没有登录或者是没有权限时是不能让用户直接访问这些资源的。类似的过滤器还有很多的功能，比如说编码，压缩服务端给客户端返回的各种数据，等等。 2、过滤器的运作原理？ 过滤器这么牛逼，那么它的运作原理是什么呢？  j...
过滤器、拦截器、AOP应用场景及在springboot项目中如何配置
L丶小先生的博客
03-21 677
过滤器、拦截器、AOP应用场景及在springboot项目中如何配置
Spring Boot 2.X 实战教程.pdf
07-30
本课程内容包括Spring简介、Spring Boot简介、安装JDK、安装Maven、第一个Spring Boot程序（使用Spring Initializr构建、Spring Boot代码讲解、安装Notepad++）、构建系统、代码、配置、三种方式运行程序、安装...
Spring-Boot-2:Spring Boot 2.x 示例
05-30
Spring-Boot-2 如何更改端口号？ 如果您想更改端口号，请在 src/main/resources/application.properties 中的 application.properties 上写入 (server.port=3132) 命令。 您可以在 appplicaton.properties 中更改...
SpringBoot-Learn:Spring Boot 入门
05-18
:Spring Boot 集成 WebSocket 实现服务端推送消息到客户端:Spring Boot 集成 Elasticsearch 实战:Spring Boot 集成阿里云 OSS 进行文件存储:Spring Boot 集成 Redis 实现数据缓存:Spring Boot 优雅地发送邮件:Spring...
spring-boot-leaning：Spring Boot 2.X最全课程代码
01-29
spring-boot-leaning：Spring Boot 2.X最全课程代码
springboot-sutra-pavilion：Spring boot 2.X版本教程，集成了各种中间件，以方便快速参考和使用
02-04
springboot-sutra-pavilion是一个基于Spring Boot 2.x的综合性仓库。Spring Spring Boot 2.x中的各种示例，以简单，快捷，精炼为目标，目的是帮助大家快速掌握Spring Boot 2.x的使用以及集成的各类中间件的使用 产品...
过滤器学习(概念和例子)
懒散狂徒的专栏
06-16 1048
从J2EE1.3开始，Servlet2.3规范中加入了对过滤器的支持。过滤器能够对目标资源的请求和响应进行截取。过滤器的工作方式分为四种，下面让我们分别来看看这四种过滤器的工作方式： 1、request过滤器     这种过滤器的工作方式比较简单，大家也经常遇到，如下图所示： 以下是web.xml文件配置方式： myFilter xx.MyFilter
web开发——过滤器
2301_77713282的博客
04-27 622
过滤器; Filter接口, FilterChain接口, FilterConfig接口; Filter的配制方法, 注解方式配置过滤器, xml文件配置过滤器, 注解配置和xml文件配制方法的区别; 设置请求和响应的字符集
布隆过滤器介绍及实战应用（防止缓存穿透）
mlwsmqq的博客
11-01 3425
本文将讲解布隆过滤器的概念、原理、优缺点、使用场景；通过Java使用布隆过滤器，以及在项目中结合Redis使用，贴近实战，干货满满！！！
Spring Boot中的过滤器与拦截器实战：实现用户认证与资源访问控制
最新发布
心猿意码
08-23 764
在构建Web应用时，我们经常需要实现诸如用户认证、资源访问控制等功能。Spring Boot 提供了多种工具来帮助开发者轻松实现这些需求。本文将介绍如何使用Spring Boot 3.x中的过滤器（Filter）和拦截器（Interceptor）来实现用户登录验证和对特定资源的访问控制。
Springboot过滤器和拦截器详解及使用场景，连续四年百度Java岗必问面试题
m0_62289824的博客
03-23 1330
很多程序员，整天沉浸在业务代码的 CRUD 中，业务中没有大量数据做并发，缺少实战经验，对并发仅仅停留在了解，做不到精通，所以总是与大厂擦肩而过。我把私藏的这套并发体系的笔记和思维脑图分享出来，理论知识与项目实战的结合，我觉得只要你肯花时间用心学完这些，一定可以快速掌握并发编程。36112)]很多程序员，整天沉浸在业务代码的 CRUD 中，业务中没有大量数据做并发，缺少实战经验，对并发仅仅停留在了解，做不到精通，所以总是与大厂擦肩而过。
过滤器第一篇【介绍、入门、简单应用】
3y
03-06 597
什么是过滤器 过滤器是Servlet的高级特性之一，也别把它想得那么高深，只不过是实现Filter接口的Java类罢了！ 首先，我们来看看过滤器究竟Web容器的哪处: 从上面的图我们可以发现，当浏览器发送请求给服务器的时候，先执行过滤器，然后才访问Web的资源。服务器响应Response，从Web资源抵达浏览器之前，也会途径过滤器。 我们很容易发现，过滤器可以比喻成一张滤网。我们想想...
SpringBoot 仿B站后端项目实战 Day01
aixuexie的博客
03-15 5231
SpringBoot 仿B站后端项目实战 1. 搭建环境 1）项目架构 业务（功能）架构 用户服务： 注册登录 /大会员权限/ 查找视频 在线视频流播放+实时弹幕 管理后台 视频上传/数据统计/系统消息推送 技术架构 SpringBoot + MySql + Mybatis + Maven 部署架构 前端 ： 服务转发 + 负载均衡
Springboot——过滤器
热门推荐
梦想的边缘
08-12 1万+
Springboot——过滤器
SpringBoot实战——仿b站项目（一）
weixin_52880572的博客
03-18 2261
热部署就是当应用程序这种运行的时候升级冉家或者修改某一部分代码、配置文件时，无需手动启动应用，即可修改的部分生效工具 + IDEA配置。
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、付费专栏及课程。

余额充值