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中的递归方法示例介绍，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下，方便下次浏览2021-12-12
这篇文章主要介绍了详解RabbitMQ延迟队列的基本使用和优化,延迟队列中的元素都是带有时间属性的。延迟队列就是用来存放需要在指定时间被处理的元素的队列,需要的朋友可以参考下2023-05-05
本文主要介绍了mybatis-plus自定义排序的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-01-01
下面小编就为大家带来一篇浅谈java继承中是否创建父类对象。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-06-06
这篇文章主要为大家介绍了Spring @InitBinder注解使用及原理详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-03-03
这篇文章主要介绍了解决for循环为空不需要判断的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-09-09
缩短 URL 是现代应用程序中常见的需求,通常用于减少长 URL 的长度,使其更易于分享,URL 缩短服务的核心思路是将长 URL 映射到一个唯一的短代码,本文主要介绍了springboot中缩短一个url链接的实现,感兴趣的可以了解一下2024-09-09
本文详细介绍了SA-Token这款安全框架的使用,并结合实际操作演示了如何集成到springboot项目中,感兴趣的朋友跟随小编一起看看吧2024-08-08
这篇文章主要介绍了Java编程之内置观察者模式,结合实例形式较为详细的分析了java内置观察者模式的原理、实现方法及相关注意事项,需要的朋友可以参考下2017-08-08
springboot ConfigurationProperties的绑定源码示例解析
这篇文章主要为大家介绍了springboot ConfigurationProperties的绑定源码示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2023-09-09
最新评论