Spring Boot 实战:如何自定义 Servlet Filter

1.前言

有些时候我们需要在 Spring Boot Servlet Web 应用中声明一些自定义的 Servlet Filter来处理一些逻辑。比如简单的权限系统、请求头过滤、防止 XSS 攻击等。本篇将讲解如何在 Spring Boot 应用中声明自定义 Servlet Filter 以及定义它们各自的作用域和顺序。

2. 自定义 Filter

可能有人说声明 Servlet Filter 不就是实现 Filter 接口嘛,没有什么好讲的!是的这个没错,但是很多时候我们并不想我们声明的 Filter 作用于全部的请求。甚至当一个请求经过多个 Filter 时需要按照既定的顺序执行。接下来我会一一讲解如何实现以上的功能。

2.1 Filter 的声明

在 Spring Boot 中 只需要声明一个实现 javax.servlet.Filter 接口的 Spring Bean 就可以了。如下:

非常简单不是吗?但是这种方式无法保证顺序,而且作用于所有的请求,即拦截的 Ant 规则为 /*。所以需要我们改进

2.2 实现 Filter 顺序化

如果需要实现顺序化,可以借助于 Spring 提供的 @Order 注解或者 Ordered 接口。这里有一个坑:如果使用 @Order 注解一定要注解标注到具体的类上。 为了方便 JavaConfig 风格的声明。我们可以实现 OrderedFilter 接口,该接口是 Filter接口和 Ordered 接口的复合体,最终上面的配置如下

Filter 执行的规则是 数字越小越先执行 。跟之前 Bean 实例化的优先级是一致的。

2.3 自定义 Filter 作用域

实现了顺序化之后我们来看看如何实现自定义 Filter 的作用域。我们先说一下思路:

通过 ServletRequest 对象来获取请求的 URI,然后对 URI 进行 ANT 风格匹配, 匹配通过执行具体的逻辑,否则跳过该 Filter 。

这里非常适合抽象一个基类来把该流程固定下来,留一个抽象方法作为函数钩子,只需要继承基类实现该抽象方法钩子就可以了。 为了保证顺序执行基类我们依然实现了 OrderedFilter 接口,我们来定义基类:

我们来实现一个具体的 Filter 逻辑,打印请求的 URI:

然后定义好其 urlPatterns 并将其注册到 Spring IoC 容器中就行了,如果有多个而且希望按照一定的顺序执行。

3. Spring Boot的机制

以上方式是我们自己造的轮子。其实 Spring Boot 还提供了 Filter 注册机制来实现顺序执行和声明作用域。 我们上面的逻辑可以改为:

3.1 要点

  • FilterRegistrationBean 与 Filter 之间是一对一关系。
  • 如果存在多个 FilterRegistrationBean 需要调用其 setName(String name) 为其声明唯一名称,否则只有第一个注册成功的有效。
  • 如果需要保证调用顺序可通过调用其 setOrder(int order) 方法进行设置。

4. 总结

我们在本文中通过自定义和 Spring Boot 提供的两种方式实现了使用自定义 Filter ,虽然 Spring Boot 提供的方式更加方便一些,但是自定义的方式更能体现你对面向对象理解和提高你的抽象能力。希望多多关注,与往常一样。

原文地址:https://www.cnblogs.com/CQqfjy/p/12294127.html

时间: 2024-10-25 15:55:53

Spring Boot 实战:如何自定义 Servlet Filter的相关文章

Spring Boot 2 实战:如何自定义 Servlet Filter

1.前言 有些时候我们需要在 Spring Boot Servlet Web 应用中声明一些自定义的 Servlet Filter 来处理一些逻辑.比如简单的权限系统.请求头过滤.防止 XSS 攻击等.本篇将讲解如何在 Spring Boot 应用中声明自定义 Servlet Filter 以及定义它们各自的作用域和顺序. 2. 自定义 Filter 可能有人说声明 Servlet Filter 不就是实现 Filter 接口嘛,没有什么好讲的!是的这个没错,但是很多时候我们并不想我们声明的 F

Spring Boot实战之Filter实现使用JWT进行接口认证

Spring Boot实战之Filter实现使用JWT进行接口认证 jwt(json web token) 用户发送按照约定,向服务端发送 Header.Payload 和 Signature,并包含认证信息(密码),验证通过后服务端返回一个token,之后用户使用该token作为登录凭证,适合于移动端和api jwt使用流程 本文示例接上面几篇文章中的代码进行编写,请阅读本文的同时可以参考前面几篇文章 1.添加依赖库jjwt,本文中构造jwt及解析jwt都使用了jjwt库 <dependenc

《Spring Boot实战》笔记(目录)

目录 目 录第一部分 点睛Spring 4.x第1 章 Spring 基础 ............................................................................................................. 21.1 Spring 概述 .......................................................................................

Spring Boot 之FilterRegistrationBean --支持web Filter 排序的使用(转)

Spring Boot 之FilterRegistrationBean  --支持web Filter 排序的使用Spring 提供了FilterRegistrationBean类,此类提供setOrder方法,可以为filter设置排序值,让spring在注册web filter之前排序后再依次注册. 写一个普通的filter: package com.sdcuike.practice.web2; import java.io.IOException; import javax.annotat

Spring Boot实战之定制URL匹配规则

本文首发于个人网站:Spring Boot实战之定制URL匹配规则 构建web应用程序时,并不是所有的URL请求都遵循默认的规则.有时,我们希望RESTful URL匹配的时候包含定界符".",这种情况在Spring中可以称之为"定界符定义的格式":有时,我们希望识别斜杠的存在.Spring提供了接口供开发人员按照需求定制. 在之前的几篇文章中,可以通过WebConfiguration类来定制程序中的过滤器.格式化工具等等,同样得,也可以在这个类中用类似的办法配置&

Spring Boot实战之定制type Formatters

本文首发于个人网站:Spring Boot实战之定制type Formatters 前面我们有篇文章介绍了PropertyEditors,是用来将文本类型转换成指定的Java类型,不过,考虑到PropertyEditor的无状态和非线程安全特性,Spring 3增加了一个Formatter接口来替代它.Formatters提供和PropertyEditor类似的功能,但是提供线程安全特性,也可以实现字符串和对象类型的互相转换. 假设在我们的程序中,需要根据一本书的ISBN字符串得到对应的book

spring boot 实战随书源码

spring boot 实战 -汪云飞 随书源码 点击下载

Spring Boot Admin 集成自定义监控告警

Spring Boot Admin 集成自定义监控告警 前言 Spring Boot Admin 是一个社区项目,可以用来监控和管理 Spring Boot 应用并且提供 UI,详细可以参考 官方文档. Spring Boot Admin 本身提供监控告警功能,但是默认只提供了 Hipchat.Slack 等国外流行的通讯软件的集成,虽然也有邮件通知,不过考虑到使用体检决定二次开发增加 钉钉 通知. 本文基于 Spring Boot Admin 目前最新版 1.5.7. 准备工作 Spring

《Spring Boot实战》示例代码问题

* Idea环境 * <Java EE开发的颠覆者 Spring Boot实战> 1.2.2 Spring EL 读取文件获取不到: 需把test.txt和test.properties放在resource文件下,将resource文件标记为资源目录,将引用目录换为"classpath:test.txt"就可以. 2. 2.4  Profile 运行报错:GenericApplicationContext does not support multiple refresh