SpringBoot —— Filter过滤器的使用

秒速五厘米 2023-10-05 21:52 18阅读 0赞

## 前言 ##

过滤器是Javaweb非常基础的一个概念，属于Servlet的一部分。本文记录一下在SpringBoot项目中是如何使用Filter过滤器。

## 一、过滤器是什么？ ##

过滤器是[AOP（面向切面编程）思想][AOP]的具体实现。可以过滤浏览器发出的请求，并且决定放行请求还是中断请求。

**机制简述**：  
在浏览器对服务器**发起请求**或者服务器对浏览器**响应**，都会经过过滤器。

基于过滤器的机制，我们可以在过滤器中对请求和响应做一些处理，可以在过滤器中决定是否放行，例如：校验请求中有没有敏感字符串，校验有没有Session，实现URL级别的权限控制、压缩响应信息、编码格式等。

## 二、过滤器的实现 ##

### 1.使用@WebFilter注解 ###

Filter的执行由Servlet容器回调完成，因此我们不需要再额外引包。

下面列举一个登录场景：即用户需登录后才能访问  
新建MyFilter类

@Slf4j
    @Order(1)
    @WebFilter(filterName = "myFilter", urlPatterns = {
        "/user/*"})
    public class MyFilter implements Filter {
        
    
        @Autowired
        private SysUserService sysUserService;
    
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
        
            log.info("过滤器初始化");
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        
            log.info("请求处理");
            HttpServletResponse response = (HttpServletResponse) servletResponse;
            HttpServletRequest request = (HttpServletRequest) servletRequest;
            log.info("MyFilter, URL：{}", request.getRequestURI());
            if (request.getRequestURI().contains("login")) {
        
                filterChain.doFilter(servletRequest, servletResponse);
            } else {
        
                log.info("非法URL：{}", request.getRequestURI());
                response.setStatus(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
                PrintWriter writer = response.getWriter();
                writer.print("no access");
            }
        }
    
        @Override
        public void destroy() {
        
            log.info("过滤器销毁");
        }
    }

### 2.启动类注解 ###

用@WebFilter注解，指定拦截路径以及一些参数，同时需要在启动类使用@**ServletComponentScan**扫描带@WebFilter、@WebServlet、@WebListener并将帮我们注入bean

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

### 3.测试 ###

输入请求：http://localhost:8080/hello/error1  
![在这里插入图片描述][24e5005ea7f74b9c8c3e81fe8ef7fa79.png]  
没有拦截请求，因为我们设置的拦截请求为 **/user/**\*，带user的请求才会被拦截处理。

输入请求：http://localhost:8080/user/getUserByCondition  
![在这里插入图片描述][f8d98a6471bc49b7ac49298eeb9694c0.png]  
日志：  
![在这里插入图片描述][4376afb47a8648a790bf1580b17fb604.png]  
过滤器使用成功。这里只是简单演示，实际的登录处理大部分情况通过token配合过滤器来实现。

**补充：设置多个过滤器的执行顺序**  
当你有多个过滤器之后，就需要规定各个过滤器的指定顺序了。

使用@Order()注解  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16]  
以上就是SpringBoot中过滤器的简单使用。

[«][Link 1] 上一章：[SpringBoot —— 简单整合Redis实例及StringRedisTemplate与RedisTemplate对比和选择][Link 1]  
[»][Link 2] 下一章：[SpringBoot —— 简单多模块构建][Link 2]

[AOP]: https://baike.baidu.com/item/AOP/1332219?fr=aladdin
[24e5005ea7f74b9c8c3e81fe8ef7fa79.png]: https://img-blog.csdnimg.cn/24e5005ea7f74b9c8c3e81fe8ef7fa79.png
[f8d98a6471bc49b7ac49298eeb9694c0.png]: https://img-blog.csdnimg.cn/f8d98a6471bc49b7ac49298eeb9694c0.png
[4376afb47a8648a790bf1580b17fb604.png]: https://img-blog.csdnimg.cn/4376afb47a8648a790bf1580b17fb604.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/fe4bc52d38ac470585a964e68dfaaddb.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[Link 1]: https://blog.csdn.net/qq_34383510/article/details/120560746
[Link 2]: https://blog.csdn.net/qq_34383510/article/details/120790064