springboot使用aop的学习——结合自定义注解校验登入

在项目开发中需要使用到一些校验，如登入用户才能访问的接口，这里就需要校验用户登入
当然校验用户的拦截方式有很多如: 过滤器，拦截器，自定义注解拦截等等
在这里介绍的是自定义注解拦截

需要使用到的pom

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
        </dependency>

1 需要的对象

LoginCheck

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

/**
 * 登录检查注解
 *
 */
@Target(ElementType.METHOD)//注解使用范围
@Retention(RetentionPolicy.RUNTIME)//注解运行时机
public @interface LoginCheck {

}

LoginCheckAspectj

import com.farm.core.util.UserUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;


/**
 * 登录检查，检查通过后，将在TreadLocal中放入从数据库中取出的User对象
 */
@Aspect
@Order(2)
@Component
public class LoginCheckAspectj {

    private static final Logger LOGGER = LoggerFactory.getLogger(LoginCheckAspectj.class);
 

    /**
     * 1.获取request信息
     * 2.根据request 的header获得用户登录凭证信息token
     * 3.解析token取出登录用户信息
     */
    @Around(value = "@annotation(com.farm.core.config.LoginCheck)")
    public Object check(ProceedingJoinPoint pjp) throws Throwable {
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        HttpServletRequest request = sra.getRequest();
        // 从token中获取用户信息
        String token = request.getHeader("token");
     
        //添加自己需要的业务代码
        

        try {
            return pjp.proceed();
        } finally {
            UserUtils.setUser(null);
        }
    }
}

2 aspectj目标类连接点对象简要介绍

JoinPoint

java.lang.Object[] getArgs()：获取连接点方法运行时的入参列表；
Signature getSignature() ：获取连接点的方法签名对象；
java.lang.Object getTarget() ：获取连接点所在的目标对象；
java.lang.Object getThis() ：获取代理对象本身；

ProceedingJoinPoint

ProceedingJoinPoint继承JoinPoint子接口，它新增了两个用于执行连接点方法的方法：
java.lang.Object proceed() throws java.lang.Throwable：通过反射执行目标对象的连接点处的方法；
java.lang.Object proceed(java.lang.Object[] args) throws java.lang.Throwable：通过反射执行目标对象连接点处的方法，不过使用新的入参替换原来的入参

3 举例

在需要的方法一般是controller层的方法添加注解