登录校验-拦截器Interceptor

黑马程序员JavaWeb开发教程

一、简介和快速入门

1.1 简介

1. 概念：是一种动态拦截方法调用的机制，类似于过滤器。Spring框架中提供的，用来动态拦截控制器方法的执行
2. 作用：拦截请求，在指定的方法调用前后，根据业务需要执行预先设定的代码。

1.2 快速入门

1. 定义拦截器，实现HandlerInterceptor接口，并重写其所有方法
   • 创建一个新的目录 interceptor 创建LoginCheckInterceptor类 实现 HandlerInterceptor 接口

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;

@Component//交给IOC容器管理
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...");
    }
}

2. 注册拦截器
   • 创建目录 config，在其下创建类 WebConfig，实现接口 WebMvcConfigurer

package com.example.demo.config;

import com.example.demo.filter.LoginCheckFilter;
import com.example.demo.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
    LoginCheckInterceptor loginCheckInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");
    }
}

二、详解

2.1 拦截路径的配置

1. 拦截器可以根据需求，配置不同的拦截路径：
   
2. 常用拦截路径
   

2.2 执行流程

2.3 Filter 与 Interceptor的不同之处

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

三、登录校验-Interceptor

package com.example.demo.interceptor;

import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.support.hsf.HSFJSONUtils;
import com.example.demo.pojo.Result;
import com.example.demo.utils.JwtUtils;
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;

@Slf4j
@Component//交给IOC容器管理
public class LoginCheckInterceptor implements HandlerInterceptor {
    @Override//目标资源方法运行前运行，返回true：返工；返回false：不放行
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //1. 获取请求url
        String url = request.getRequestURL().toString();
        log.info("请求的url {}", url);
        //2. 判断请求url中是否含有login，如果有的话，直接放行
        if (url.contains("login")) {
            log.info("登录界面，直接放行");
            return true;
        }
        //3. 获取请求头中的令牌（token）
        String token = request.getHeader("token");
        //4. 判断令牌是否存在，不存在的话直接返回错误信息
        if (!StringUtils.hasLength(token)) {
            log.info("令牌不存在");
            //手动转换 对象-》json
            Result error = Result.error("NO_LOGIN");
            String noLogin = JSONObject.toJSONString(error);
            response.getWriter().write(noLogin);
            return false;
        }
        //5. 解析令牌，解析失败的话直接返回错误信息
        try {
            JwtUtils.parseJWT(token);
        } catch (Exception e) {
            e.printStackTrace();
            log.info("令牌解析错误");
            //手动转换 对象-》json
            Result error = Result.error("NO_LOGIN");
            String noLogin = JSONObject.toJSONString(error);
            response.getWriter().write(noLogin);
            return false;
        }

        //6. 放行
        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...");
    }
}