springBoot-自定义注解实现登录拦截

流程图

逻辑流程：

1.登录成功后，后台会生成一个token并返回给客户端，客户端需要保存token。在调用其他请求时，携带此token，到请求头中或者参数里。

2.后台通过拦截器，拦截到请求后，判断请求的方法或方法所属类 中是否存在 我们 标注的 登录校验注解，如果存在，表示当前请求需要校验用户是否登录，

3.去请求头里获取 token 数据，拿到token 从redis 校验、如果正确，则放行请求， 如果找不到token 或者校验 token已过期 ，则向外抛出异常。

代码实现：

定义注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface Login {
}

定义拦截器：

package com.joy.demo.intercept;


import com.joy.demo.util.RedisUtil;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;


import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;
import java.lang.reflect.Method;


/**
* User: Joy
* Description:
* Date: 2022-11-01 18:31
*/
@Component
public class LoginInterceptor extends HandlerInterceptorAdapter {


 @Resource
 public RedisUtil redisUtil;


 public boolean preHandle(HttpServletRequest request
 , HttpServletResponse response
 , Object handler) throws Exception {


 HandlerMethod handlerMethod = (HandlerMethod) handler;
 Method method = handlerMethod.getMethod();
 Login login = (Login) method.getAnnotation(Login.class);
 if (null == login) {
 // 放行，不需要登录token
 return true;
 }
 String token = request.getHeader("token");
 if (StringUtils.isEmpty(token)) {
 sendJsonMessage(response, "token不能为空，请重新登录！");
 return false;
 }


 boolean existFlag = redisUtil.exists("token-" + token);
 if(!existFlag){
 sendJsonMessage(response, "token已过期或不正确，请重新登录！");
 return false;
 }


 return true;
 }


 public static void sendJsonMessage(HttpServletResponse response, String body) throws Exception {
 response.setContentType("application/json; charset=utf-8");
 PrintWriter writer = response.getWriter();
 writer.print(body);
 writer.close();
 response.flushBuffer();
 }


}

配置拦截哪些地址：

package com.joy.demo.config;


import com.joy.demo.intercept.LoginInterceptor;
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.WebMvcConfigurerAdapter;


/**
* User: Joy
* Description:
* Date: 2022-11-01 19:48
*/
@Configuration
public class WebMvcConfigure extends WebMvcConfigurerAdapter {
 @Autowired
 private LoginInterceptor loginInterceptor;


 public WebMvcConfigure() {
 }


 public void addInterceptors(InterceptorRegistry registry) {
 registry.addInterceptor(this.loginInterceptor).addPathPatterns(new String[]{"/**"});
 super.addInterceptors(registry);
 }
}

登录接口（模拟生成token，这里直接传入），下单接口（依赖token，这里加上 @Login校验注解）

 // 登录 set token
// @Login
 @GetMapping("/login")
 public String login(@RequestHeader String token){
 return userService.login(token);
 }


 // 下单 需要验证token
 @Login
 @GetMapping("/doOrder")
 public String doOrder(@RequestHeader String token){
 return userService.doOrder(token);
 }

sevice类

@Resource
private RedisUtil redisUtil; //这里参考 springBoot引入redis章节


@Override
public String login(String token) {
 // 这里假定用户 密码登录成功，开始set token
 String tokenKey = token;
 String tokenValue = "用户信息jsonStr(用户id 等等)";
 redisUtil.set(tokenKey, tokenValue, 600L, TimeUnit.SECONDS);
 return "登录成功，set token ok, token key:" + tokenKey + " tokenValue :" + tokenValue;
}


@Override
public String doOrder(String token) {
 return ("pass login validate");
}

测试：

Step1 postman 模拟用户登录，设置token key值 abc

此时redis中 key，value值

下单接口 使用 token key，显示 验证通过

修改token key值，显示 “token不正确”

ok，done [憨笑]