【SpringBoot篇】Interceptor拦截器 | 拦截器和过滤器的区别

港控/mmm° 2024-04-17 06:38 8阅读 0赞

#### 文章目录 ####

*  🌹概念
 *   *  ⭐作用
 *  🎄快速入门
 *   *  ⭐入门案例代码实现
 *  🛸拦截路径
 *  🍔拦截器interceptor和过滤器filter的区别
 *  🎆登录校验

![在这里插入图片描述][0864401282c248e199a4f70914ad881d.png]

## 🌹概念 ##

拦截器（Interceptor）是一种软件设计模式，用于在应用程序处理请求或响应时对其进行拦截和修改。拦截器可以在整个应用程序中使用，用于执行跨越多个层的通用任务，如身份验证、授权、缓存、日志记录、性能计量等。

在Web开发中，拦截器通常用于在请求到达控制器之前或响应返回客户端之前对其进行修改。例如，在Spring框架中，可以使用拦截器来实现身份验证和授权检查，记录请求和响应的日志，以及处理全局异常等。

拦截器的工作方式是通过将其注册到应用程序的处理管道中，并在请求或响应传递过程中执行相应的操作。拦截器可以访问请求上下文、响应上下文和处理程序对象，从而允许它们访问和修改请求或响应的属性和状态。拦截器还可以决定是否将请求和响应继续传递到下一个处理程序或终止请求。

总之，拦截器是一种非常有用的设计模式，可以帮助开发人员在应用程序中实现通用的功能，提高代码的可重用性和可维护性。

### ⭐作用 ###

![请添加图片描述][e976dfe54b07499db20835f195afeb31.jpeg]

拦截器是一种非常有用的设计模式，它可以在应用程序处理请求或响应时对其进行拦截和修改。以下是拦截器的几个常见用途：

*  身份验证和授权：拦截器可以用于检查请求是否具有适当的凭据，并根据需要拒绝或允许请求。这使得开发人员能够轻松地实现身份验证和授权功能。
 *  缓存：拦截器可以用于缓存请求或响应数据，以便加快应用程序的性能。例如，在Web应用程序中，可以使用拦截器缓存静态资源，如CSS文件和图像。
 *  日志记录：拦截器可以用于记录请求和响应的详细信息，以便开发人员能够更好地了解应用程序的行为和性能。
 *  性能计量：拦截器可以用于测量应用程序的性能，并识别可能的瓶颈。例如，在Web应用程序中，可以使用拦截器跟踪页面加载时间，并标识慢速查询或资源。
 *  异常处理：拦截器可以用于处理应用程序中的异常情况，并提供友好的错误消息。例如，在Web应用程序中，可以使用拦截器捕获异常并显示自定义错误页面。

## 🎄快速入门 ##

![请添加图片描述][5fe2b3f968bd4cfa8ee1f4f40ae3f706.jpeg]

### ⭐入门案例代码实现 ###

> 代码脚手架我传到网盘里面了，需要的同学请自取  
> 我用夸克网盘分享了「tlias-web-management」，点击链接即可保存。  
> 链接：https://pan.quark.cn/s/b98922faf182

--------------------

首先我们创建interceptor类  
![在这里插入图片描述][1d037a1266524f87a18263ae65e44569.png]  
写入下面的代码

package com.itheima.interceptor;
    
    import org.springframework.stereotype.Component;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @Component
    public class LoginCheckInterceptor implements HandlerInterceptor {
        
        @Override //目标资源方法运行前运行 返回true，放行  返回false 拦截
        public boolean preHandle(HttpServletRequest  request, HttpServletResponse response, Object handler) throws Exception {
        
            System.out.println("preHandle");
            return true;
        }
    
        @Override //目标方法运行后运行
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
            System.out.println("postHandle");
        }
    
        @Override //视图渲染完毕后运行，最后运行
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
            System.out.println("afterCompletion");
        }
    }

![在这里插入图片描述][a7d1a9f825f34713bd782f7afa20be28.png]

--------------------

创建配置类  
![在这里插入图片描述][91fb80276c60493e9be757183dd21ef9.png]

写入下面的代码

package com.itheima.config;
    
    import com.itheima.interceptor.LoginCheckInterceptor;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    @Configuration  //表明这个是配置类
    public class WebConfig implements WebMvcConfigurer {
        
        
        @Autowired
        private LoginCheckInterceptor loginCheckInterceptor;
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            //加入拦截器（加入的拦截器就是我们刚刚创建的拦截器）
            registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**"); //所有路径都被拦截
            registration.excludePathPatterns( //添加不拦截路径
                    "/toLoginPage", //登录页面
                    "/login",       //登录请求
                    "/**/*.html",   //html静态资源
                    "/**/*.js",     //js静态资源
                    "/**/*.css"     //css静态资源
        };
    }

![在这里插入图片描述][340923cdc8b948908e0225c5e7deb0db.png]

> 入门案例就完成了

## 🛸拦截路径 ##

通过配置拦截路径，我们可以设置拦截什么路径，放行什么路径

![请添加图片描述][b7d325da2d074967bd7b065fe2e519d6.jpeg]

## 🍔拦截器interceptor和过滤器filter的区别 ##

`接口规范不同`：过滤器需要实现Filter接口，而拦截器需要实现HanglerInterceptor接口  
`拦截范围不同`：过滤器filter会拦截所有的资源，而Interceptor中会拦截Spring环境的资源  
![请添加图片描述][8c366996dc2f40afb195becad536a625.jpeg]

## 🎆登录校验 ##

![请添加图片描述][69f1e5687f3e4ce9a223655c29e849bf.jpeg]

登录操作，我们需要使用LoginCheckFilter类，我们修改一下里面的代码

下面是修改后的代码

package com.itheima.interceptor;
    
    import com.itheima.pojo.Result;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    
    @Component
    @Slf4j
    public class LoginCheckInterceptor implements HandlerInterceptor {
        
        @Override //目标资源方法运行前运行 返回true，放行  返回false 拦截
        public boolean preHandle(HttpServletRequest  req, HttpServletResponse resp, Object handler) throws Exception {
        
            
                //获取请求的url
                String url = req.getRequestURL().toString();
                log.info("请求的url：{}",url);
    
                //判断请求url中是否包含有login，如果包含，说明是登录操作，进行放行
                if(url.contains("login")){
        
                    log.info("登录操作，放行");
                    return true;
                }
                //获取请求头的令牌(token)
                String jwt=req.getHeader("token");
    
                //判断令牌是否存在，如果不存在，返回错误结果(未登录)
                //hasLength()方法判断字符串是否有长度(是否为空)
                if (!StringUtils.hasLength(jwt)){
        
                    log.info("请求头token为空，返回未登录的信息");
                    Result error= Result.error("NOT_LOGIN");
                    //使用阿里巴巴的fastJSON工具包，将对象转成json字符串
                    String notLogin= JSONObject.toJSONString(error);
                    //响应给浏览器
                    resp.getWriter().write(notLogin);
                    return false;
                }
                //解析token，如果解析失败，返回登录结果
                //jwt令牌
                try {
        
                    JwtUtils.parseJWT(jwt);
                }catch (Exception e){
        
                    e.printStackTrace();
                    log.info("解析token失败，返回未登录的错误信息");
                    Result error= Result.error("NOT_LOGIN");
                    //使用阿里巴巴的fastJSON工具包，将对象转成json字符串
                    String notLogin= JSONObject.toJSONString(error);
                    //响应给浏览器
                    resp.getWriter().write(notLogin);
                    return false;
                }
    
                //放行
                log.info("令牌合法，放行");
                return true;
        }
    
        @Override //目标方法运行后运行
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        
            System.out.println("postHandle");
        }
    
        @Override //视图渲染完毕后运行，最后运行
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        
            System.out.println("afterCompletion");
        }
    }

![在这里插入图片描述][28a1ec5722cf4b698220edabb2a9543c.png_pic_center]

> 在技术的道路上，我们不断探索、不断前行，不断面对挑战、不断突破自我。科技的发展改变着世界，而我们作为技术人员，也在这个过程中书写着自己的篇章。让我们携手并进，共同努力，开创美好的未来！愿我们在科技的征途上不断奋进，创造出更加美好、更加智能的明天！

[0864401282c248e199a4f70914ad881d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/9ebf40c7ad4b4a0caab757e8c9f5b5f3.png
[e976dfe54b07499db20835f195afeb31.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/094e56cabfec48cbb5f736c1efbf7188.jpeg
[5fe2b3f968bd4cfa8ee1f4f40ae3f706.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/177a336bfab24135a872ecd480d719b9.jpeg
[1d037a1266524f87a18263ae65e44569.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/9e6139c437b848c4994e3276d94c2167.png
[a7d1a9f825f34713bd782f7afa20be28.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/5cacc966c6ca43728ae3d13d2921f71d.png
[91fb80276c60493e9be757183dd21ef9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/42562867446243faa988d2e2f14dcc1f.png
[340923cdc8b948908e0225c5e7deb0db.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/32473f590506493099c4043542059fd1.png
[b7d325da2d074967bd7b065fe2e519d6.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/b358097ed64a48a6a46d18396d638d86.jpeg
[8c366996dc2f40afb195becad536a625.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/b22c7d49de3648eea1249d953bd59970.jpeg
[69f1e5687f3e4ce9a223655c29e849bf.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/6b88f265917e4ef49017547caf097395.jpeg
[28a1ec5722cf4b698220edabb2a9543c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/23e211241b5842b6ae3de10cea2f1b09.png