Springboot项目快速实现过滤器功能

已于 2023-11-30 17:56:34 修改
阅读量2.8k 收藏 23
点赞数 4
分类专栏： Springboot实战与原理 文章标签： spring boot servlet java FIlter 过滤器
于 2023-03-20 18:04:09 首次发布
本文为博主原创文章，未经博主允许不得转载。
本文链接：https://blog.csdn.net/fox9916/article/details/129672773
版权
本文介绍了SpringBoot中过滤器Filter的使用，包括其作用、核心类、工作原理和实现方式。Filter是Servlet相关技术，用于在请求和响应之间进行拦截操作，但不改变请求和响应本身。文章提到了两种实现Filter的方式：@WebFilter注解和FilterRegistrationBean，并讨论了过滤器链的执行顺序。此外，文章还探讨了过滤器与AOP、拦截器的区别。
摘要由CSDN通过智能技术生成

阅读建议


嗨，伙计！刷到这篇文章咱们就是有缘人，在阅读这篇文章前我有一些建议：

  1. 本篇文章大概5000多字，预计阅读时间长需要5分钟。
  2. 本篇文章的实战性、理论性较强，是一篇质量分数较高的技术干货文章，建议收藏起来，方便时常学习与回顾，温故而知新。
  3. 创作不易，免费的点赞、关注，请走上一走，算是对博主一些鼓励，让我更有动力输出更多的干货内容。
     

前言

很多时候，当你以为掌握了事实真相的时间，如果你能再深入一点，你可能会发现另外一些真相。比如面向切面编程的最佳编程实践是AOP，AOP的主要作用就是可以定义切入点，并在切入点纵向织入一些额外的统一操作，避免与业务代码过度耦合。熟悉java web项目的都知道，另外还有过滤器（filter）、拦截器（interceptor）也有类似AOP的功能特性，那么问题来了：为什么一般说面向切面编程就是指AOP，而不是过滤器和拦截器？过滤器和拦截器在Spring boot中怎么实现？这三者之间有什么区别？Springboot项目快速实现Aop功能中分享了AOP的相关实现，下面将再用两到三篇文章，分别和大家分享一下过滤器、拦截器的实现，以及AOP、过滤器、拦截器之间的横向对比，以便在业务开发中，能够快速、正确选对具体实现方法。

环境配置

jdk版本:1.8

开发工具：Intellij iDEA 2020.1

springboot:2.3.9.RELEASE

Filter简介

Filter， 中文意思是过滤器，Filter的全限定类名是javax.servlet.Filter，可以看出这是与servelt相关的一个接口；SpringMVC核心是DispatcherServlet，而DispatcherServlet又继承了Servlet，进而可以推测出Filter与SpringMVC也是关联关系。

事实上这样的推测也是正确的，在SpringMVC项目中，filter在浏览器与服务器之间起过滤的作用，可以截取客户端和服务端之间的请求和响应信息，并根据这些请求-响应信息作一些其他的操作，但是要注意，filter并不能改变请求-响应信息；

核心类

Filter

Filter接口的全限定类名是javax.servlet.Filter，该接口有三个方法，分别是

1、init(...)：用于初始化Filter；

2、doFilter(...)：过滤请求和拦截响应信息的具体实现在这个方法里；

3、destroy(...)：Filter对象被销毁时触发，主要用于做一些收尾工作，如资源的释放等；

FilterConfig

FilterConfig接口的全限定类名是javax.servlet.FilterConfig，该接口主要有四个方法，分别是：

1、getFilterName() 获取Filter的名字；

2、getServletContext() 获取ServletContext对象（即application）；

3、getInitParameter() 获取Filter的初始化参数；

4、getInitParameterNames() 获取所有初始化参数的名字；

FilterChain

FilterChainr接口的全限定类名是javax.servlet.FilterChain，该接口只有一个方法，是doFilter()方法，用于调用Filter链上的下一个过滤器，如果当前过滤器为最后一个或只有一个过滤器，则该过滤器则将请求发送到目标资源。

MyFilter2是自己实现的过滤器，实现了Filter接口；Filter接口依赖FilterChain接口和FilterConfig接口，其中FilterChain接口的实现类是org.apache.catalina.core.ApplicationFilterChain，FilterConfig接口的实现类是org.apache.catalina.core.ApplicationFilterConfig；

工作原理

1、项目启动的时候，先执行Filter的构造方法，完成相关Filter对象的注册；

2、紧接着，Filter对象的init()方法被调用，开始对Filter做一些初始化操作；

3、项目启动完成后，客户端每次向服务端发起请求时，如果请求地址与过滤器定义的地址匹配，则会执行Filter的doFilter()；如果匹配上多个过滤器，则会形成一个链路，依次调用各个过滤器对象的doFilter()；服务端作出响应后，也会再次执行到各个过滤器对象的doFilter()；请求和响应时，过滤器链的执行顺序是先进后出；

4、服务器停止时调用Filter的destroy()方法，用来释放资源。

实现方式

Springboot项目中一般有两种方式：

1、@WebFilter注解，即javax.servlet.annotation.WebFilter；

2、FilterRegistrationBean，即org.springframework.boot.web.servlet.FilterRegistrationBean；

两种方式，都需要在启动类上增加注解@ServletComponentScan，用于开启servlet相关bean的扫描，其中包含有过滤器（Filter）；


@SpringBootApplication
@ServletComponentScan
public class FanfuApplication {
    public static void main(String[] args) {
        SpringApplication.run(FanfuApplication.class, args);
    }
}

代码实现

1、WebFilter注解里，定义一下过滤器的名字，以及要对哪些请求进行过滤，“/*”表示对所有的请求都过滤，在实际业务中，可具体对待；如果在初始化的时候，需要携带一些初始化的参数，可以在initParams属性上，使用@WebInitParam注解来定义初始化参数名称和具体的值，这些参数可以在filter对象初始化的时候获取到；MyFIlter1和MyFIlter2使用的注解方式定义的过滤器；


@Slf4j
@WebFilter(filterName = "myFilter1", urlPatterns = "/*", initParams = {@WebInitParam(name = "creator", value = "fanfu")})
public class MyFilter1 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("//myFilter1初始化开始");
        String creator = filterConfig.getInitParameter("creator");
        log.info("//初始化参数creator:{}",creator);
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//myFilter1开始执行");
        chain.doFilter(request, response);
        log.info("//myFilter1结束执行");
    }

    @Override
    public void destroy() {
        log.info("//myfilter1被销毁");
    }
}

@Slf4j
@WebFilter(filterName = "myFilter2", urlPatterns = "/*")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("//myFilter2初始化开始");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//myFilter2开始执行");
        chain.doFilter(request, response);
        log.info("//myFilter2结束执行");
    }

    @Override
    public void destroy() {
        log.info("//myFilter2被销毁");
    }
}

2、FilterRegistrationBean方式

在Springboot项目的配置类中，使用FilterRegistrationBean来包装自定义的过滤器，这种方式的最大好处就是可以自定义过滤器的执行顺序，数字越小，执行时的优先级就越高；MyFIlter3和MyFIlter4是使用FilterRegistrationBean方式定义的过滤器；


@Configuration
public class WebConfig {

    @Bean
    public FilterRegistrationBean filterRegistration1() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter3());
        filterRegistrationBean.addUrlPatterns("/*");//定义过滤器对哪些请求路径进行过滤，/*表示对所有请求都过滤
        filterRegistrationBean.setOrder(2);//定义过滤器的执行优先级，数据越小优先级越高
        return filterRegistrationBean;
    }

    @Bean
    public FilterRegistrationBean filterRegistration2() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter4());
        filterRegistrationBean.addUrlPatterns("/*");
        filterRegistrationBean.setOrder(1);
        return filterRegistrationBean;
    }
}

@Slf4j
public class MyFilter3 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    log.info("//MyFilter3初始化开始");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//MyFilter3开始执行");
        chain.doFilter(request,response);
        log.info("//MyFilter3结束执行");
    }

    @Override
    public void destroy() {
        log.info("//MyFilter3被销毁");
    }
}

@Slf4j
public class MyFilter4 implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("//MyFilter4初始化开始");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("//MyFilter4开始执行");
        chain.doFilter(request,response);
        log.info("//MyFilter4结束执行");
    }

    @Override
    public void destroy() {
        log.info("//MyFilter4被销毁");
    }
}

未定义myFilter3、myFilter4的执行优先级，即采取自然排序时的执行结果：在请求前myFilter3的执行时机早于myFilter4，响应后myFilter3的执行时机要晚于myFilter4；

定义myFilter4的优先级高于myFilter3时，执行结果：在请求前myFilter4的执行时机早于myFilter3，响应后的myFilter4的执行时机要晚于myFilter3；

总结

过滤器的实现是比较简单，通过梳理这个过程，我get到以下几个点：

1、过滤器是用于SpringMVC项目中，即与servlet相关的项目；

2、过滤器的执行时机是在请求前和响应后，有两种实现方式，即@WebFilter注解和FilterRegistrationBean；如果对过滤器的执行顺序没有限制要求，则可以使用第一种；如果对过滤器的执行顺序有明确限制，则可以使用第二种；

3、如果有多个过滤器对象时，会形成一个过滤器链，过滤器的执行顺序是先进后出；

4、过滤器可以过滤请求和拦截响应，但是不能改变请求值和响应值；

凡夫贩夫
关注
专栏目录
SpringBoot(13)过滤器+拦截器+监听器
weixin_38380811的博客
03-31 1503
SpringBoot(12)过滤器+拦截器+监听器
Springboot过滤器禁止ip频繁访问功能实现
p1830095583的博客
03-29 1252
在开发 Web 项目的时候，经常需要过滤器来处理一些请求，包括字符集转换什么的，记录请求日志什么的等等。在之前的 Web 开发中，我们习惯把过滤器配置到 web.xml 中，但是在 SpringBoot 中，兵没有这个配置文件，该如何操作呢？ 1.编写一个过滤器： import lombok.extern.slf4j.Slf4j; import javax.servlet.*; import javax.servlet.annotation.WebFilter; import javax.servlet
Springboot实现过滤器
热门推荐
一个菜鸡的博客
05-21 1万+
Springboot实现过滤器有以下俩种方式，第一种方式俩步走，即向spring容器注册filter 第一种： 1.Filter过滤器具体实现类 @Component @Slf4j public class MyTestFilter implements Filter { @Override public void init(FilterConfig filterConfig) throws ServletException { log.info("[ {} ] 创建
Java SpringBoot实现的过滤器（和拦截器）控制登录页面跳转
04-13
该压缩包实现了利用过滤器或者拦截器对登录信息进行验证跳转登陆页的功能，利用的是SpringBoot和thymeleaf,使用前请先看使用说明
springboot 过滤器
最新发布
溪
08-10 759
/ 执行一些预处理操作 System . out . println("3Filter==Before the request...");// 调用下一个过滤器 filterChain . doFilter(servletRequest , servletResponse);// 执行一些后处理操作 System . out . println("3Filter==After the request...");} }
springboot中filter的用法
weixin_34250709的博客
08-24 73
一、在spring的应用中我们存在两种过滤的用法，一种是拦截器、另外一种当然是过滤器。我们这里介绍过滤器在springboot的用法，在springmvc中的用法基本上一样，只是配置上面有点区别。 二、filter功能，它使用户可以改变一个 request和修改一个response. Filter 不是一个servlet,它不能产生一个response,...
springboot实现过滤器
东风麦芽糖
05-26 2323
注解方式实现过滤器、非注解方式实现过滤器
【SpringBoot】Springboot实现过滤器
weixin_45618869的博客
07-12 1729
在上述示例中，使用了@WebFilter注解将MyFilter类标记为过滤器，并通过urlPatterns拦截全部。在Spring Boot中，过滤器是一种用于对HTTP请求进行预处理和后处理的组件。为了使Spring Boot能够扫描到自定义的过滤器类，需要在启动类上使用。的一部分，它能够在请求进入Web容器之前或返回给客户端之前进行操作。通过实现过滤器，可以对HTTP请求进行一些通用操作，如。其中若用户未登录 ，执行下列的语句：给前端响应。“/user/login”,//移动端登录。
Springboot 过滤器
大新软件老杨
11-29 3622
Springboot的过滤器，在web开发中可以过滤指定的url 比如过拦截掉我们不需要的接口请求，同时也可以修改request和response内容 过滤器的应用场景： 1）过滤敏感词汇（防止sql注入） 2）设置字符编码 3）URL级别的权限访问控制 4）压缩响应信息
springboot+jsp 使用过滤器.do
02-20
这个例子"springboot+jsp 使用过滤器.do"显然展示了如何在Spring Boot应用中集成JSP并添加过滤器功能。这里我们将深入探讨Spring Boot、JSP以及过滤器的相关知识点。 **1. Spring Boot** Spring Boot是Spring框架...
springBoot-java敏感词语过滤类
09-14
这个"springBoot-java敏感词语过滤类"是一个实用的工具类，用于帮助开发者实现在Java环境中对用户输入或者系统文本进行安全审查，防止不适当、非法或者有害的信息传播。这个工具类通常会包含一系列的方法，用于匹配...
SpringBoot实现过滤器、拦截器与切片源码分析
勇往直前的专栏
02-19 1800
过滤器Filter 过滤器概念 Filter是J2E中来的，可以看做是Servlet的一种“加强版”，它主要用于对用户请求进行预处理和后处理，拥有一个典型的处理链。Filter也可以对用户请求生成响应，这一点与Servlet相同，但实际上很少会使用Filter向用户请求生成响应。使用Filter完整的流程是：Filter对用户请求进行预处理，接着将请求交给Servlet进行预处理并生成响应，最...
SpringBoot过滤器简单实现
qq_42026590的博客
09-09 179
package com.example.helloworld.filter; import org.springframework.stereotype.Component; import javax.servlet.*; import javax.servlet.annotation.WebFilter; import javax.servlet.http.HttpServletRequest; import java.io.IOException; @Component @WebFilter(url
springboot,实现简单的filter过滤器
小道仙的后宫
09-24 627
目的：springboot,实现简单的filter过滤器 环境搭建 ： https://blog.csdn.net/wuyinlei/article/details/79227962 项目整体目录结构：  filter 方法 package com.xdx97.backstage.filter; //判断是否登陆的 filter import javax.servlet.*; i...
springboot使用过滤器
Microhoo_苏福的博客
04-05 9419
过滤器是处于客户端与服务器资源文件之间的一道过滤网，帮助我们过滤一些不符合要求的请求。通常它被用作 Session校验，判断用户权限，如果不符合设定条件，就会被拦截到特殊的地址或者给予特殊的响应。
Spring boot 中的过滤器
canduecho的专栏
07-06 2198
其中一些经常在过滤器的实现中使用。以下是常用的几个方法：1. `doFilter()`: 这是过滤器的核心方法，用于实现过滤器的逻辑。在该方法中，您可以对请求进行预处理、修改请求参数、验证身份、记录日志等操作，然后通过调用`FilterChain`的`doFilter()`方法将请求传递给下一个过滤器或目标资源。在响应返回客户端之前，也可以在此方法中执行一些操作。```java```2. `init()`: `init()`方法在过滤器初始化时调用，用于执行一些初始化操作。
SpringBoot实现过滤器
Ara_Hu的博客
06-29 542
SpringBoot实现过滤器的三种方式以及设置其执行顺序
使用springboot实现过滤器
08-04
### 回答1： Spring Boot是一个使用Java开发的轻量级框架，用于快速创建微服务应用程序。它提供了许多方便的功能，其中之一是实现过滤器。 在Spring Boot中，您可以通过实现`javax.servlet.Filter`接口或继承`javax.servlet.Filter`类来实现过滤器。您可以使用@Component注解将其标记为组件，并在应用程序中使用它。 以下是一个简单的示例，该示例演示了如何实现过滤器并将其应用于请求： ``` import java.io.IOException; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import org.springframework.stereotype.Component; @Component public class MyFilter implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { System.out.println("MyFilter is executing."); chain.doFilter(request, response); } } ``` 您可以通过实现`doFilter`方法并在其中编写过滤逻辑来实现自定义过滤器。您可以使用`FilterChain`对象将请求传递给下一个过滤器或最终的servlet。 最后，您需要注册过滤器，以便在应用程序中使用它。您可以通过在启动类上使用`@ServletComponentScan`注解来注册过滤器。 ``` import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.web.servlet. ### 回答2： 使用Spring Boot实现过滤器可以通过编写一个类并使用特定注解来实现。 首先，我们需要创建一个过滤器类。这个类可以继承`javax.servlet.Filter`接口，并实现其中的方法。例如，我们可以创建一个名为`MyFilter`的类来处理过滤逻辑。 ```java import javax.servlet.*; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; public class MyFilter implements Filter { @Override public void init(FilterConfig filterConfig) throws ServletException { // 初始化方法 } @Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { HttpServletRequest request = (HttpServletRequest) servletRequest; HttpServletResponse response = (HttpServletResponse) servletResponse; // 在此处实现过滤逻辑 filterChain.doFilter(request, response); } @Override public void destroy() { // 销毁方法 } } ``` 然后，我们需要在Spring Boot应用的入口类上添加`@ServletComponentScan`注解，以扫描并注册我们的过滤器类。例如，如果入口类是`Application`，我们可以这样使用注解： ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.web.servlet.ServletComponentScan; @SpringBootApplication @ServletComponentScan // 添加此注解 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` 最后，我们需要在过滤器类上添加`@WebFilter`注解，以指定过滤器的URL匹配规则。例如，我们可以在`MyFilter`类上添加注解： ```java import javax.servlet.annotation.WebFilter; @WebFilter(urlPatterns = "/api/*") // 添加此注解 public class MyFilter implements Filter { // ... } ``` 通过以上步骤，我们就成功地在Spring Boot应用中实现了一个过滤器。当访问以`/api/`开头的URL时，过滤器将会被触发，执行我们在`doFilter`方法中定义的过滤逻辑。 ### 回答3： Spring Boot是基于Spring框架的一个快速开发框架，它提供了很多方便的功能来简化Java应用程序的开发过程。其中之一就是实现过滤器。 在Spring Boot中，实现过滤器需要以下步骤： 1. 创建一个类并实现javax.servlet.Filter接口，该接口定义了过滤器的生命周期和函数。 2. 在该类上面添加注解@Component，将其声明为一个Spring组件，以便Spring Boot能够自动扫描并将其初始化为一个Bean。 3. 实现Filter接口的三个方法：init、doFilter和destroy。 - 在init方法中，可以执行过滤器的初始化操作，例如加载配置文件或者建立数据库连接等。 - 在doFilter方法中，可以编写过滤器的业务逻辑。可以通过ServletRequest和ServletResponse对象获取请求和响应的相关信息，并对其进行处理。 - 在destroy方法中，可以释放资源或进行一些清理操作。 4. 使用注解@WebFilter来配置该过滤器的映射路径和执行顺序。可以通过urlPatterns属性设置过滤器要拦截的URL路径，也可以通过value属性设置优先级。 使用Spring Boot实现过滤器的好处是可以更加方便地集成到项目中，并且与Spring的其他组件进行无缝衔接。另外，Spring Boot还提供了很多其他的功能，例如自动配置、快速启动等，可以进一步提升开发效率。 总之，通过Spring Boot实现过滤器非常简单。只需要创建一个实现Filter接口的类，添加相应的注解和配置，即可实现对请求和响应的过滤和处理。这样可以很好地控制请求的访问权限，进行统一的日志记录、异常处理等操作，提高系统的可靠性和安全性。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

凡夫贩夫

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

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

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

打赏作者

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

抵扣说明：

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

余额充值