登录拦截,也就是说我们需要配置哪些 API 是用户不需要登录就可以访问的,哪些 API 必须要登录之后才能访问的
1、创建拦截器
package com.asurplus.common.satoken;
import cn.dev33.satoken.stp.StpUtil;
import org.springframework.http.HttpMethod;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class SaTokenLoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 在拦截器中,如果请求为OPTIONS请求,则返回true,表示可以正常访问,然后就会收到真正的GET/POST请求
if (HttpMethod.OPTIONS.toString().equals(request.getMethod())) {
return true;
}
// 检验当前会话是否已经登录, 如果未登录,则抛出异常:`NotLoginException`
StpUtil.checkLogin();
// 已经登录
return true;
}
}
这里如果是 OPTIONS 请求,我们需要直接通过,返回 true
然后我们使用 StpUtil.checkLogin(); 来检车该用户是否登录,此方法会抛出 NotLoginException 异常,我们只需要捕获到该异常,就能给前端返回未登录的信息提示
2、注册拦截器
接着上一篇的配置类,我们只需要实现 WebMvcConfigurer 接口,重写 addInterceptors 方法就好了
/**
* 注册拦截器
*
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 注册登录拦截器
registry.addInterceptor(new SaTokenLoginInterceptor())
// 需要拦截的路径
.addPathPatterns("/**")
// 不需要拦截的路径
.excludePathPatterns(
// 获取验证码
"/kaptcha-image",
// 登录
"/login",
// 登出
"/logout",
// 开发文档
"/doc.html", "/webjars/**", "/v2/api-docs/**", "/swagger-resources/**", "/favicon.ico"
);
}
我们对 获取验证码、登录、登出 以及 开发文档的请求地址放开了访问权限,也就是即使用户不登录,也能访问这些 API 接口,其它的接口,都需要用户登录之后才能访问了
如您在阅读中发现不足,欢迎留言!!!