登录认证功能的统一拦截技术(拦截器)

以你之姓@ 2023-09-27 17:14 122阅读 0赞

**目录**

1.说明

2.使用方法

(1) 定义拦截器

(2)注册配置拦截器

(3)示例：

3.interceptor详细说明

(1)拦截路径

(2)执行流程

(3)过滤器和拦截器的区别

4.登录校验的拦截器实现

5.全局异常处理(补充说明)

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

### 1.说明 ###

拦截器是一种动态拦截方法调用的机制，类似于过滤器。  
拦截器是Spring框架中提供的，用来动态拦截控制器方法的执行。

拦截器作用：拦截请求，在指定方法调用前后，根据业务需要执行预先设定的代码。

在拦截器当中，我们通常也是做一些通用性的操作，比如：我们可以通过拦截器来拦截前端发起的请求，将登录校验的逻辑全部编写在拦截器当中。在校验的过程当中，如发现用户登录了(携带JWT令牌且是合法令牌)，就可以直接放行，去访问spring当中的资源。如果校验时发现并没有登录或是非法令牌，就可以直接给前端响应未登录的错误信息。

### 2.使用方法 ###

#### (1) 定义拦截器 ####

实现HandlerInterceptor接口，并重写其所有方法

//自定义拦截器
    @Component
    public class LoginCheckInterceptor implements HandlerInterceptor {
        //目标资源方法执行前执行。 返回true：放行    返回false：不放行
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            System.out.println("preHandle .... ");
    
            return true; //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 .... ");
        }
    }

注意：  
preHandle方法：目标资源方法执行前执行。 返回true：放行 返回false：不放行。  
postHandle方法：目标资源方法执行后执行。  
afterCompletion方法：视图渲染完毕后执行，最后执行。

#### (2)注册配置拦截器 ####

实现WebMvcConfigurer接口，并重写addInterceptors方法。

@Configuration  
    public class WebConfig implements WebMvcConfigurer {
    
        //自定义的拦截器对象
        @Autowired
        private LoginCheckInterceptor loginCheckInterceptor;
    
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
           //注册自定义拦截器对象
            registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");//设置拦截器拦截的请求路径（ /** 表示拦截所有请求）
        }
    }

#### (3)示例： ####

package com.example.demo.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;
    
    /**
     * @Author linaibo
     * @Date 2023/4/9 15:29
     * @PackageName:com.example.demo.interceptor
     * @ClassName: DemoInterceptor
     * @Version 1.0
     */
    @Component
    public class DemoInterceptor implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            System.out.println("方法执行前");
            // 返回true，代表放行。返回false，代表不放行
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
            System.out.println("方法执行后");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            System.out.println("视图渲染完毕后执行");
        }
    }

package com.example.demo.config;
    
    import com.example.demo.interceptor.DemoInterceptor;
    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;
    
    /**
     * @Author linaibo
     * @Date 2023/4/9 15:33
     * @PackageName:com.example.demo.config
     * @ClassName: WebConfig
     * @Version 1.0
     */
    @Configuration
    public class WebConfig implements WebMvcConfigurer {
    
        @Autowired
        private DemoInterceptor demoInterceptor;
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(demoInterceptor).addPathPatterns("/**");
        }
    }

### 3.interceptor详细说明 ###

#### (1)拦截路径 ####

首先我们先来看拦截器的拦截路径的配置，在注册配置拦截器的时候，我们要指定拦截器的拦截路径，通过addPathPatterns("要拦截路径")方法，就可以指定要拦截哪些资源。

在入门程序中我们配置的是\`/\*\*\`，表示拦截所有资源，而在配置拦截器时，不仅可以指定要拦截哪些资源，还可以指定不拦截哪些资源，只需要调用\`excludePathPatterns("不拦截路径")\`方法，指定哪些资源不需要拦截。

例：

@Configuration  
    public class WebConfig implements WebMvcConfigurer {
    
        //拦截器对象
        @Autowired
        private LoginCheckInterceptor loginCheckInterceptor;
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            //注册自定义拦截器对象
            registry.addInterceptor(loginCheckInterceptor)
                    .addPathPatterns("/**")//设置拦截器拦截的请求路径（ /** 表示拦截所有请求）
                    .excludePathPatterns("/login");//设置不拦截的请求路径
        }
    }

在拦截器中除了可以设置\`/\*\*\`拦截所有资源外，还有一些常见拦截路径设置：

![93c221f620954a0da455c90647130e80.png][]

#### (2)执行流程 ####

![5526121995d6469eaa543d94628f38d3.png][]

当我们打开浏览器来访问部署在web服务器当中的web应用时，此时我们所定义的过滤器会拦截到这次请求。拦截到这次请求之后，它会先执行放行前的逻辑，然后再执行放行操作。而由于我们当前是基于springboot开发的，所以放行之后是进入到了spring的环境当中，也就是要来访问我们所定义的controller当中的接口方法。  
Tomcat并不识别所编写的Controller程序，但是它识别Servlet程序，所以在Spring的Web环境中提供了一个非常核心的Servlet：DispatcherServlet（前端控制器），所有请求都会先进行到DispatcherServlet，再将请求转给Controller。  
当我们定义了拦截器后，会在执行Controller的方法之前，请求被拦截器拦截住。执行\`preHandle()\`方法，这个方法执行完成后需要返回一个布尔类型的值，如果返回true，就表示放行本次操作，才会继续访问controller中的方法；如果返回false，则不会放行（controller中的方法也不会执行）。  
在controller当中的方法执行完毕之后，再回过来执行\`postHandle()\`这个方法以及\`afterCompletion()\` 方法，然后再返回给DispatcherServlet，最终再来执行过滤器当中放行后的这一部分逻辑的逻辑。执行完毕之后，最终给浏览器响应数据。

#### (3)过滤器和拦截器的区别 ####

接口规范不同：过滤器需要实现Filter接口，而拦截器需要实现HandlerInterceptor接口。  
拦截范围不同：过滤器Filter会拦截所有的资源，而Interceptor只会拦截Spring环境中的资源。

### 4.登录校验的拦截器实现 ###

登录校验拦截器

//自定义拦截器
    @Component //当前拦截器对象由Spring创建和管理
    @Slf4j
    public class LoginCheckInterceptor implements HandlerInterceptor {
        //前置方式
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            System.out.println("preHandle .... ");
            //1.获取请求url
            //2.判断请求url中是否包含login，如果包含，说明是登录操作，放行
    
            //3.获取请求头中的令牌（token）
            String token = request.getHeader("token");
            log.info("从请求头中获取的令牌：{}",token);
    
            //4.判断令牌是否存在，如果不存在，返回错误结果（未登录）
            if(!StringUtils.hasLength(token)){
                log.info("Token不存在");
    
                //创建响应结果对象
                Result responseResult = Result.error("NOT_LOGIN");
                //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
                String json = JSONObject.toJSONString(responseResult);
                //设置响应头（告知浏览器：响应的数据类型为json、响应的数据编码表为utf-8）
                response.setContentType("application/json;charset=utf-8");
                //响应
                response.getWriter().write(json);
    
                return false;//不放行
            }
    
            //5.解析token，如果解析失败，返回错误结果（未登录）
            try {
                JwtUtils.parseJWT(token);
            }catch (Exception e){
                log.info("令牌解析失败!");
    
                //创建响应结果对象
                Result responseResult = Result.error("NOT_LOGIN");
                //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
                String json = JSONObject.toJSONString(responseResult);
                //设置响应头
                response.setContentType("application/json;charset=utf-8");
                //响应
                response.getWriter().write(json);
    
                return false;
            }
    
            //6.放行
            return true;
        }

注册配置拦截器

@Configuration  
    public class WebConfig implements WebMvcConfigurer {
        //拦截器对象
        @Autowired
        private LoginCheckInterceptor loginCheckInterceptor;
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
           //注册自定义拦截器对象
            registry.addInterceptor(loginCheckInterceptor)
                    .addPathPatterns("/**")
                    .excludePathPatterns("/login");
        }
    }

### 5.全局异常处理(补充说明) ###

\* 定义全局异常处理器非常简单，就是定义一个类，在类上加上一个注解@RestControllerAdvice，加上这个注解就代表我们定义了一个全局异常处理器。  
\* 在全局异常处理器当中，需要定义一个方法来捕获异常，在这个方法上需要加上注解@ExceptionHandler。通过@ExceptionHandler注解当中的value属性来指定我们要捕获的是哪一类型的异常。

示例：

@RestControllerAdvice
    public class GlobalExceptionHandler {
    
        //处理异常
        @ExceptionHandler(Exception.class) //指定能够处理的异常类型
        public Result ex(Exception e){
            e.printStackTrace();//打印堆栈中的异常信息
    
            //捕获到异常之后，响应一个标准的Result
            return Result.error("对不起,操作失败,请联系管理员");
        }
    }

@RestControllerAdvice = @ControllerAdvice + @ResponseBody  
处理异常的方法返回值会转换为json后再响应给前端

全局异常处理器的使用，主要涉及到两个注解：

@RestControllerAdvice //表示当前类为全局异常处理器  
@ExceptionHandler //指定可以捕获哪种类型的异常进行处理

[93c221f620954a0da455c90647130e80.png]: https://img-blog.csdnimg.cn/93c221f620954a0da455c90647130e80.png
[5526121995d6469eaa543d94628f38d3.png]: https://img-blog.csdnimg.cn/5526121995d6469eaa543d94628f38d3.png