phpcustomfilter技巧_Spring 自定义过滤器 Filter 注解

文章目录 [+]

Spring Filters简介

过滤器在 Web 开拓中发挥着至关主要的浸染，尤其是在基于 Spring 的 Web 运用程序的高下文中。
当我们评论辩论 Spring 时，我们紧张集中在依赖注入、AOP（面向切面编程）和 Data JPA 等功能上，而忽略了一些像Filter这样的无名英雄。
过滤器在许多方面都发挥了浸染，例如安全、日志记录、转换以及各种其他类型的预处理和后处理活动。

phpcustomfilter技巧_Spring 自定义过滤器 Filter 注解

过滤器在 Web 运用程序中的主要性

如果须要逼迫实行访问掌握（身份验证和授权）、记录传入或输出的 HTTP 要乞降相应，或者在要乞降相应正文到达掌握器或到达客户端之前对其进行操作，那么过滤器就发挥了浸染。
它们为横切关注点供应了一个集中处理，确保不必在运用程序的多个部分中写相同的逻辑，从而天生更干净、更易于掩护的代码。

phpcustomfilter技巧_Spring 自定义过滤器 Filter 注解

（图片来自网络侵删）

过滤器如何融入 Spring 生态系统

在 Spring 生态系统中，过滤器充当着 Servlet 管道中的拦截器，这意味着它们有权在要求到达掌握器之前（预处理）和相应离开掌握器之后（后处理）实行操作。
Spring 与 Java Servlet 规范很好地保持同等，因此，您可以在 Spring 运用程序中利用本机 Servlet 过滤器。
然而，Spring 更进一步，供应了一种利用表明及其强大的依赖注入功能来定义过滤器的优雅方法。

@Filter 有什么浸染？

Spring 中的 @Filter 注释（或用于类似目的的自定义表明）用于定义可以注册并运用于传入要求的过滤器。
它许可您将过滤逻辑与核心运用程序逻辑完备分离，供应一种优雅的办法将自定义操作添加到要求-相应周期。
利用@Filter，您可以简洁地表达特定的一段代码旨在充当过滤器，从而使代码更易于理解和掩护。

Servlet 过滤器与 Spring 过滤器

为什么要利用 Spring 特定的过滤器而不是标准 Servlet 过滤器。
虽然 Servlet 过滤器功能强大并且可以完成很多事情，但 Spring 过滤器受益于 Spring 的生态系统，例如它的依赖注入功能，它许可您将 Spring 管理的 bean 直接连接到过滤器类中。
这是传统 Servlet 过滤器无法做到的事情。

实践

在本节中，我们将着眼于从头开始设置 Spring Boot 项目，重点关注包含必要的依赖项和配置以支持过滤器的利用。
我们将谈论两种设置项目的方法：利用 Spring Initializr 和手动设置。

阐发过滤器

理解过滤器的构造对付充分利用其功能至关主要。
基于 Spring 的运用程序中的过滤器可以与 Java 的本机 Servlet Filter 保持同等，也可以利用 Spring 的特定功能来实现更加自定义的方法。
要节制过滤器的实质，就必须探索其核心方法——过滤器链，以及如何精确配置过滤器。

过滤器中的核心方法

Spring（或一样平常的 Java Web 运用程序）中的范例过滤器实质上是一个 Java 类，它实现了 javax.servlet 包中的 Filter 接口。
该接口定义了三个方法：

init(FilterConfig filterConfig)

该方法在过滤器的生命周期内仅被调用一次。
您可以在此处放置初始化逻辑，例如分配资源。
FilterConfig 工具供应对过滤器配置参数的访问，您可以利用此工具来获取 Spring 配置中定义的初始化参数。

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

这是过滤器的紧张逻辑，每次要求相应都会调用这个方法。
ServletRequest和ServletResponse分别表示输入要乞降输出回答，在此方法中调用chain.doFilter会将要乞降相应传给过滤器链中的下一个实体（过滤器链或者目标资源例如掌握器）

destory()

当过滤器停滞做事或者程序关闭时调用。
常日做的是一些清理资源的事情，例如关闭数据库连接、关闭文件等。

理解FilterChain(过滤器链)

过滤器链表示是要乞降相应经由的一系列的的过滤器，就和一根链条一样。
过滤器添加到链中的顺序很主要，如果Filter A修正了要求工具，那么链中的下一个Filter B将吸收修正后的要求。

如何在Spring中配置Filter

虽然可以利用@Component表明配置Filter class使得sping可以自动检测并运用，但这会造成过滤器运用到每个要求。
为了进行更风雅的掌握，可以利用 FilterRegistrationBean，这个类可以配置过滤器运用到哪个Url或者Servlet。

下面是示例

@Beanpublic FilterRegistrationBean<CustomFilter> loggingFilter() { FilterRegistrationBean<CustomFilter> registrationBean = new FilterRegistrationBean<>(); registrationBean.setFilter(new CustomFilter()); registrationBean.addUrlPatterns("/api/"); return registrationBean;}

这个例子中，我们的过滤器只对以api开头的要求有效。

一个大略的日志过滤器

为了将所有这些观点联系在一起，让我们回顾一下大略的日志过滤器示例：

import javax.servlet.;import java.io.IOException;public class LoggingFilter implements Filter { @Override public void init(FilterConfig filterConfig) throws ServletException { // 初始化 System.out.println("Logging Filter initialized"); } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { System.out.println("Request received at " + new java.util.Date()); chain.doFilter(request, response); System.out.println("Response sent at " + new java.util.Date()); } @Override public void destroy() { // 清理资源 System.out.println("Logging Filter destroyed"); }}

在这个例子中，实现了三个紧张的方法，init()输出了一些初始化方法，doFilter记录了要求进来的韶光和相应回答的韶光，destory()记录了资源清理的韶光。

利用@Filter创建自定义过滤器

利用@Filter表明创建自定义过滤器给程序添加特定的功能是非常有效的，这种自定义过滤器以声明的办法在特定方法或者路由上运用过滤器，是代码更加简介且随意马虎掩护。

创建@Filter表明

第一步是创建 @Filter 表明本身。
这将是一个标记表明，用于标识哪些掌握器或方法应受到过滤器的影响

import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.METHOD, ElementType.TYPE})public @interface Filter { String value() default "";}创建一个@Filter过滤器类

现在，让我们创建一个将实行实际逻辑的自定义过滤器类。
要利用 @Filter 注释，自定义过滤器类应检讨其是否存在。

import org.springframework.core.annotation.AnnotationUtils;import javax.servlet.;import javax.servlet.http.HttpServletRequest;import java.io.IOException;public class CustomFilter implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletRequest httpRequest = (HttpServletRequest) request; String path = httpRequest.getRequestURI(); Class<?> controller = if (controller != null && AnnotationUtils.findAnnotation(controller, Filter.class) != null) { System.out.println("Custom filter applied"); } chain.doFilter(request, response); }}注册自定义过滤器

为了让自定义过滤器正常事情，我们须要注册它。
您可以利用 Spring 的 FilterRegistrationBean 以编程办法实现。

import org.springframework.boot.web.servlet.FilterRegistrationBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationpublic class FilterConfig { @Bean public FilterRegistrationBean<CustomFilter> customFilterRegistration() { FilterRegistrationBean<CustomFilter> registrationBean = new FilterRegistrationBean<>(); registrationBean.setFilter(new CustomFilter()); registrationBean.addUrlPatterns("/"); // Apply to all routes return registrationBean; }}

通过此配置，自定义过滤器将运用于所有路由。
您可以变动 addUrlPatterns 方法参数来限定应运用过滤器的路由。

利用自定义过滤器表明

现在自定义过滤器和 @Filter 表明已准备就绪，现在可以表明掌握器或特定方法。

import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestController@Filter("Some Value")public class MyController { @GetMapping("/hello") public String hello() { return "Hello, World!"; }}

利用场景和最佳实践

过滤器为 Spring Boot 运用程序供应了强大的自定义功能，并且可以通过多种办法利用它们来知足不同的需求。
下面，我们将先容一些利用过滤器的常见用例，并研究履行过滤器时要遵照的最佳实践。

利用场景

认证与授权：过滤器是在许可要求连续发送到掌握器之前实行身份验证和授权检讨的空想工具。
这可确保只有授权用户才能访问运用程序的特定部分。

记录和监控：过滤器可以记录有关要乞降相应的基本信息，例如 IP 地址、标头、有效负载大小和实行韶光。
这些信息有利于调试和监控。

数据转换：可以利用过滤器来转换要乞降相应数据，例如，通过添加默认参数、实行数据转换或利用附加信息丰富相应。

速率限定：过滤器可以通过打算给定时间范围内来自特定客户真个要求数量来帮助限定速率，然后根据这些计数阻挡或许可要求。

最佳实践

把事情大略化：过滤器不适宜繁芜业务逻辑。
它们该当尽可能轻量级，以确保它们不会成为性能瓶颈。

把稳过滤器链：永久记住调用 chain.doFilter(request, response) 来连续实行过滤器链。
否则，要求将被阻挡，并且无法到达预期的效果。

实行顺序：过滤器注册和实行的顺序很主要。
如果处理依赖于先前的过滤器，请确保设置顺序。

彻底测试：过滤器与每个传入要乞降传出相应交互。
因此，严格的测试对付确保它们在各种条件下表现出预期的效果至关主要。