脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → springboot 过滤器

springboot实现过滤器的示例代码

 更新时间：2024年10月25日 10:43:37   作者：麦芽糖0219  
JavaWeb开发中,过滤器Filter是三大组件之一,主要用于请求拦截和响应处理,如权限校验、日志记录、请求过滤等,本文就来介绍一下springboot实现过滤器的示例代码,感兴趣的可以了解一下

一 过滤器介绍

1.1 过滤器概念

过滤器，即filter，它是javaWeb三大组件之一（Servlet程序、Listener监听器、Filter过滤器）

作用：既可以对请求进行拦截，也可以对响应进行处理。常用于做权限检查，记录日志操作、拦截过滤请求、对请求字符设置编码等。

1.2 过滤器生命周期

SpringBoot定义一个过滤器很简单，只需要实现Filter类，然后重写它的3个方法即可。

  • init方法：程序启动调用Filter的init()方法，永远只调用一次；在容器中创建当前过滤器的时候自动调用这个方法。
  • destory方法：程序停止调用Filter的destroy()方法，永远只调用一次；在容器中销毁当前过滤器的时候自动调用这个方法。
  • doFilter方法：每次的访问请求如果符合拦截条件都会调用doFilter()方法，程序第一次运行，会在servlet调用init()方法以后调用doFilter()方法；不管第几次请求，都是在调用servlet的doGet(),doPost()方法之前调用。这个方法有3个参数，分别是ServletRequest、ServletResponse和FilterChain，可以从这些参数中获取HttpServletReguest和HttpServletResponse对象进行相应的处理操作。

二 SpringBoot中过滤器的两种实现方式

2.1 注解方式实现过滤器

首先需要在启动类加 @ServletComponentScan 注解，启动类如下

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@MapperScan("com.ts.myt.dao")
@ServletComponentScan // 过滤器
public class MytApplication {
    public static void main(String[] args) {
        SpringApplication.run(MytApplication.class, args);
    }
}

编写过滤器，实现Filter接口

import com.alibaba.fastjson.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * @Author:sgw
 * @Date:2023/9/15
 * @Description: 使用注解方式实现过滤器（@WebFilter）
 */
@WebFilter(urlPatterns = "/user/*", filterName = "filter1")
public class MyFilter implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(MyFilter.class);

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
//        Filter.super.init(filterConfig);
        logger.info("MyFilterInit1");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException, IOException {
        logger.info("doFilter");
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String token = request.getHeader("token");
        logger.info("token值：{}", token);

        if (token != null) {
            //该方法执行后直接运行至下一个过滤器
            filterChain.doFilter(servletRequest, servletResponse);
        } else {
            servletResponse.setCharacterEncoding("UTF-8");
            servletResponse.setContentType("application/json; charset=utf-8");
            PrintWriter out = servletResponse.getWriter();
            JSONObject res = new JSONObject();
            res.put("msg", "错误");
            res.put("success", "false");
            out.append(res.toString());
        }
    }

    @Override
    public void destroy() {
//        Filter.super.destroy();
        logger.info("destroy");
    }
}

上边对请求头header做了过滤，即请求头里必须含有key为token的值，才能继续访问具体接口，否则该请求就终止访问接口了

2.2 非注解方式实现过滤器（直接注入到spring中）

定义过滤器，同样实现Filter接口

import com.alibaba.fastjson.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * @Author:sgw
 * @Date:2023/9/15
 * @Description: 过滤器实现方式二：使用非注解方式实现过滤器（直接注入到spring中）
 */
public class MyFilter2 implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(MyFilter2.class);
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        logger.info("MyFilterInit2");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException, IOException {
        System.out.println("doFilter");
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String token = request.getHeader("token");
        System.out.println(token);
        //该方法执行后直接运行至下一个过滤器
        if(token!=null){
            filterChain.doFilter(servletRequest, servletResponse);
        }else{
            servletResponse.setCharacterEncoding("UTF-8");
            servletResponse.setContentType("application/json; charset=utf-8");
            PrintWriter out = servletResponse.getWriter();
            JSONObject res = new JSONObject();
            res.put("msg", "错误");
            res.put("success", "false");
            out.append(res.toString());
        }
    }

    @Override
    public void destroy() {
        System.out.println("destroy");
    }
}

编写过滤器配置类

import com.ts.myt.filter.MyFilter2;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * @Author:sgw
 * @Date:2023/9/15
 * @Description: 方式二的过滤器配置文件
 */
@Configuration
public class MyFilter2Config {
    // Filter代码类
    @Bean
    public MyFilter2 myFilter2() {
        return new MyFilter2();
    }

    @Bean
    public FilterRegistrationBean getFilterRegistrationBean(MyFilter2 myFilter2) {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(myFilter2);
        filterRegistrationBean.setOrder(2);
        filterRegistrationBean.addUrlPatterns("/user/*");
        filterRegistrationBean.setName("tokenFilter2");
        return filterRegistrationBean;
    }
}

效果与方式一一样。

到此这篇关于springboot实现过滤器的示例代码的文章就介绍到这了,更多相关springboot 过滤器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • springboot 实现记录业务日志和异常业务日志的操作

    springboot 实现记录业务日志和异常业务日志的操作

    这篇文章主要介绍了springboot 实现记录业务日志和异常业务日志的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-07-07
  • Java8 日期和时间类的基本使用

    Java8 日期和时间类的基本使用

    这篇文章主要介绍了Java 日期和时间类的基本使用，帮助大家更好的理解和学习Java，感兴趣的朋友可以了解下
    2020-08-08
  • SpringBoot 策略模式实现切换上传文件模式

    SpringBoot 策略模式实现切换上传文件模式

    策略模式是指有一定行动内容的相对稳定的策略名称,这篇文章主要介绍了SpringBoot 策略模式 切换上传文件模式,需要的朋友可以参考下
    2023-11-11
  • 详解Spring Security中权限注解的使用

    详解Spring Security中权限注解的使用

    这篇文章主要为大家详细介绍一下Spring Security中权限注解的使用方法，文中的示例代码讲解详细，对我们学习或工作有一定参考价值，需要的可以参考一下
    2022-05-05
  • 解决JPA save()方法null值覆盖掉mysql预设的默认值问题

    解决JPA save()方法null值覆盖掉mysql预设的默认值问题

    这篇文章主要介绍了解决JPA save()方法null值覆盖掉mysql预设的默认值问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-11-11
  • Java @RequestMapping注解功能使用详解

    Java @RequestMapping注解功能使用详解

    通过@RequestMapping注解可以定义不同的处理器映射规则,下面这篇文章主要给大家介绍了关于SpringMVC中@RequestMapping注解用法的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-11-11
  • SpringBoot实现图片上传及本地访问

    SpringBoot实现图片上传及本地访问

    在SpringBoot项目中,处理静态文件访问尤其是实时更新的文件如商品图片,可通过配置WebMvcConfig将本地文件映射到URL路径上,以解决重启项目才能访问文件的问题,本文详解如何保存和访问这些文件,帮助开发者优化项目文件管理
    2022-09-09
  • Javaweb使用Maven工具与Tomcat的方法详解

    Javaweb使用Maven工具与Tomcat的方法详解

    这篇文章主要为大家详细介绍了Javaweb使用Maven工具与Tomcat的方法，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
    2022-03-03
  • 基于HashMap遍历和使用方法(详解)

    基于HashMap遍历和使用方法(详解)

    下面小编就为大家带来一篇基于HashMap遍历和使用方法(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • 详解MyBatis Plus中分页插件的使用

    详解MyBatis Plus中分页插件的使用

    这篇文章主要为大家详细介绍了MyBatis Plus中分页插件使用的相关知识，文中的示例代码讲解详细，具有一定的学习价值，感兴趣的小伙伴可以了解一下
    2023-02-02

最新评论