springboot使用过滤器详解
更新时间：2024年10月29日 10:08:26 作者：天空中那座城
本文主要介绍了过滤器的基本概念,过滤器的生命周期,以及如何通过注解方式和非注解方式实现过滤器,过滤器是客户端与服务器资源文件之间的一道过滤网,能够帮助我们过滤不符合要求的请求,通常用作Session校验
一：过滤器
1.过滤器介绍
过滤器是处于客户端与服务器资源文件之间的一道过滤网，帮助我们过滤一些不符合要求的请求。
通常用作 Session校验，判断用户权限。
2.过滤器生命周期
使用过滤器很简单，只需要实现Filter类，然后重写它的3个方法即可。
- init方法：程序启动调用Filter的init()方法(永远只调用一次)；在容器中创建当前过滤器的时候自动调用这个方法。
- destory方法：程序停止调用Filter的destroy()方法(永远只调用一次)；在容器中销毁当前过滤器的时候自动调用这个方法。
- doFilter方法：doFilter()方法每次的访问请求如果符合拦截条件都会调用(程序第一次运行，会在servlet调用init()方法以后调用；不管第几次，都在调用doGet(),doPost()方法之前)。这个方法有3个参数，分别是ServletRequest、ServletResponse和FilterChain可以从参数中获取HttpServletReguest和HttpServletResponse对象进行相应的处理操作。
二：使用注解方式实现过滤器（@WebFilter）
1.在springboot 启动类添加该注解@ServletComponentScan
@SpringBootApplication
@ServletComponentScan // 过滤器
public class Springboot02WebTestApplication {
SpringApplication.run(Springboot02WebTestApplication.class, args);
}2.写个过滤器类，实现Filter接口
import com.alibaba.fastjson.JSONObject;
import org.springframework.core.annotation.Order;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;
// urlPatterns 过滤路径 filterName 过滤器name
@WebFilter(urlPatterns = "/user/*", filterName = "tokenFilter1")
public class TokenFilter1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
// Filter.super.init(filterConfig);
System.out.println("init");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
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() {
// Filter.super.destroy();
System.out.println("destroy");
}
}3.访问，我使用的Postman软件进行的测试
添加请求头token信息，才可以访问成功。
三：使用非注解方式实现过滤器（直接注入到spring中）
1.Filter代码
import com.alibaba.fastjson.JSONObject;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.io.PrintWriter;
public class TokenFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("init");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
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");
}
}2.Filter配置文件
import com.itsufu.filter.TokenFilter2;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FilterConfig {
// Filter代码类
@Bean
public TokenFilter2 tokenFilter2() {
return new TokenFilter2();
}
@Bean
public FilterRegistrationBean getFilterRegistrationBean(TokenFilter2 tokenFilter2) {
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
filterRegistrationBean.setFilter(tokenFilter2);
filterRegistrationBean.setOrder(2);
filterRegistrationBean.addUrlPatterns("/user/*");
filterRegistrationBean.setName("tokenFilter2");
return filterRegistrationBean;
}
}测试与注解式一样。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
今天教大家怎么用Java实现哈希表的基本功能,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下2021-05-05
这篇文章主要介绍了Java内存溢出实现原因及解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-03-03
这篇文章主要介绍了Java解析方法的调用关系,方法在Java编程中用于封装重复的代码,提高代码复用性,文中通过代码介绍的非常详细,需要的朋友可以参考下2024-10-10
Java KeyGenerator.generateKey的19个方法代码示例
在下文中一共展示了KeyGenerator.generateKey方法的19个代码示例，这些例子默认根据受欢迎程度排序2021-12-12
在Spring Boot中设计一个订单号生成系统,主要考虑到生成的订单号需要满足的几个要求：唯一性、可扩展性、以及可能的业务相关性,本文给大家介绍了几种常见的解决方案及相应的示例代码,需要的朋友可以参考下2024-02-02
SpringBoot中maven项目打成war包部署在linux服务器上的方法
这篇文章主要介绍了SpringBoot中maven项目打成war包部署在linux服务器上的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-05-05
java打印从1到100的值(break,return断句)
java 先写一个程序，打印从1到100的值。之后修改程序，通过使用break关键词，使得程序在打印到98时退出。然后尝试使用return来达到相同的目的2017-02-02
Spring @Configuration proxyBeanMethods=false问题
这篇文章主要介绍了Spring @Configuration proxyBeanMethods=false问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2025-04-04
Jenkins中自动化部署Spring Boot项目的全过程
这篇文章主要介绍了如何使用Jenkins从Git仓库拉取SpringBoot项目并进行自动化部署,通过配置Jenkins任务,实现项目的构建、镜像构建和容器运行,确保项目在更新时自动部署,需要的朋友可以参考下2025-01-01
本文主要介绍了SpringCloud连接不上远程Nacos问题排查,可能是因为未开放端口,或集群内部通信异常等,下面就来介绍一下问题解决,感兴趣的可以了解一下2024-06-06
最新评论