案例:验证token为目的开发注解
(1)pom文件引入依赖
<!--自定义注解-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
(2)注解类
-
@Target({ElementType.TYPE}) 注解
ElementType 这个枚举类型的常量提供了一个简单的分类:注解可能出现在Java程序中的语法位置(这些常量与元注解类型(@Target)一起指定在何处写入注解的合法位置)
-
@Retention({RetentionPolicy.Runtime}) 注解
RetentionPolicy这个枚举类型的常量描述保留注解的各种策略,它们与元注解(@Retention)一起指定注释要保留多长时间
RUNTIME 注解将被编译器记录在类文件中,在运行时需要JVM保留,因此可以反读。 -
@Documented注解
Documented注解表明这个注解是由 javadoc记录的,在默认情况下也有类似的记录工具。 如果一个类型声明被注解了文档化,它的注解成为公共API的一部分。
import java.lang.annotation.*;
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CheckToken {
// String value() default "";
}
(3)切面类
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
@Slf4j
@Aspect
@Component
public class CheckTokenAspect {
@Pointcut("@annotation(com.itsufu.annotation.CheckToken)")
public void annotationPointcut() {
}
@Before("annotationPointcut()")
public void beforePointcut(JoinPoint joinPoint) throws Exception {
// 获取请求头token信息
ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
String token = sra.getRequest().getHeader("token");
log.info("token为: " + token);
if (token == null || "".equals(token)) {
throw new Exception("token为空");
}
//校验token
}
@Around("annotationPointcut()")
public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
return joinPoint.proceed();
}
/**
* 在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
* @param joinPoint
*/
@AfterReturning("annotationPointcut()")
public void doAfterReturning(JoinPoint joinPoint) {
}
}
(4)controller测试
给测试的方法加上 @CheckToken 自定义注解实现功能,该功能为:用户要想访问成功,发送请求时必许得有token令牌(请求头),否则访问失败。
@PostMapping("/testPost")
@CheckToken
public String testPost(){
return "自定义注解,测试发送请求后,请求头token信息是否存在";
}
祝各位看官老爷们大富大贵,步步高升。