springboot aop+annotation(注解) 实现部分请求(接口)校验token

        最近项目需要实现一个游客模式的功能,就是开放部分功能给未登录的游客访问,部分功能需要进行token校验是否登录,根据需求想到了使用aop配合自定义注解来实现这个功能

参考:SpringBoot通过AOP实现自定义注解验证Token_StrugglingXuYang的博客-CSDN博客

添加maven依赖

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>

1.首先自定义一个 annotation(注解)

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author zhanglong
 * @version 1.0
 * @date 2021/11/27 14:22
 */


/**
 * @Target 该注解声明可以使用的范围
 *  ElementType.METHOD 即为可在方法上使用
 * @Retention 用于描述注解的声明周期
 *  RetentionPolicy.RUNTIME 运行时
 *  RetentionPolicy.CLASS   编译时
 *  RetentionPolicy.RUNTIME 源码时
 *  注意 需用 @interface修饰。
 */
@Retention(value = RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface NotTourists {
    /**
     * 默认参数,你可以不写,但如果写了
     * String value() 就必须传一个字符串参数进来
     * 或者String value() default ""设置默认值
     * @return
     */
    String value() default "";
}

2.创建切面


import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Objects;

/**
 * @author zhanglong
 * @version 1.0
 * @date 2021/11/27 14:40
 */

//声明是个切面的类
@Aspect
//交给spring管理
@Component
public class CheckTokenAspect {

    /**
     * @Pointct 表示该方法可用于 com.xxx.xxx.annotation.NotTourists 这个注解
     * 还可以使用*号表示通配符
     */
    @Pointcut("@annotation(com.xxx.xxx.annotation.NotTourists)")
    public void pointcut() {

    }

    @Around("pointcut()")
    public Object checkTokenAroundAspect(ProceedingJoinPoint joinPoint) throws Throwable {
        //获取请求头
        HttpServletRequest request = ((ServletRequestAttributes) Objects.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest();
        //从请求头中获取需要的参数
        String token = request.getHeader("Authorization");

        if (StringUtils.isEmpty(token)) {
            //controller 上面的方法的返回值类型要和这里一样
            return "没有token,请先登录"
        }
        //结束,继续执行方法逻辑
        return joinPoint.proceed();
    }

}

4.现在只需要在要校验token的接口上写上@NotTourists就可以了

上一篇:利用AOP,实现log打印方法名和入参


下一篇:Spring入门篇