实际项目中 Spring AOP 的应用场景案例

一. 定义切点-pointcut

/**
* 定义若干切点，切点是某个位置，在该位置的前后可以做些自定义逻辑
**/
public class SelfPointcuts{
    
    //切点1
    @Pointcut("execution(public * com.lance.platform.controller.*.*(..))")
    public void restController(){}
    
    //切点2
    @Pointcut("execution(public * com.lance.platform.controller2.*.*(..))")
    public void restController2(){}
    
}

二. 定义切面-aspect

1. 切面定义

/**
* 切面是在切点的前后左右等定义相关逻辑的位置
**/
@Aspect
@Slf4j
public class SelfLogicAspect{
    
    @Before("SelfPointcuts.restController()")
    public void doSthBefore(JoinPoint joinpoint){
        //自定义逻辑
        log.info("before method.");
    }
    
    //restController2()虽不是static方法，但可以用“类.name()“形式调用
    @Around("SelfPointcuts.restController2()")
    public void doSthAround(ProceedingJoinPoint joinpoint){ //@Around时，参数是ProceedingJoinPoint 类型
        //自定义逻辑
        log.info("before method.");
        boolean flag = true;
        if(flag) {
            //验证通过，让程序继续执行下去
            joinpoint.proceed();
        }else {
            //做其他处理，一般中断程序执行，返回错误信息给client
        }
    }
    
}

2. 自定义逻辑

案例1

//通过JoinPoint获得，controller方法的各种信息
//方法modifier, 类package, 类名，方法名、方法参数、
org.aspectj.lang.Signature signature = joinPoint.getSignature()
signature.getName();
signature.getModifiers();
signature.getDeclaringType();
signature.getDeclaringTypeName();

//可以获取请求request，进而获得对请求流程的控制
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = (HttpServletRequest) attributes.getRequest();
//获取请求URL
String url = request.getRequestURL().toString();
//获取请求方法 POST,PUT,GET,DELETE
String method = request.getMethod();

案例2

结合controller方法自定义注解做权限控制

//自定义注解，置到方法上
@Target({ElementType.TYPE, Elementtype.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AuthResource{
    String name(); //相当于普通类中的 field
}

/**
* 定义controller，并用 自定义注解注解
**/
public class SelfController{
    
    @AuthResource(name = "ONLY_READ")
    @RequestMapping("/sth")
    public String getSth() {
        
    }
    
    @AuthResource(name = "READ_AND_EDIT")
    public String getSth() {
        
    }
    
}

...

MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
AuthResource resource = method.getAnnotation(AuthResource.class);
//获取 "ONLY_READ, READ_AND_EDIT" 等
String resourceName = resource.name();
//可以通过request 获取当前用户名
String userName = (String) request.getAttribute("prawn.audit.username");

//DB中已经分配过 user-role 对应关系
//判断该用户是否有读写权限
.....
.....

...

3. AOP与Filter的对比及结合

1）执行顺序上 filter -> aop拦截
2）filter 可以执行全局的控制，跟具体controller方法无关，在进入Controller之前过滤，一个粗粒度，一个细粒度到方法上
3）filter的创建及执行请阅读 ** 笔记