SpringAop应用实例

HTTP 接口鉴权

需求描述：

1. 可以定制地为某些指定的 HTTP RESTful api 提供权限验证功能.
2. 当调用方的权限不符时, 返回错误.

根据上面所提出的需求, 我们可以进行如下设计:

1. 提供一个特殊的注解 AuthChecker, 这个是一个方法注解, 有此注解所标注的 Controller 需要进行调用方权限的认证.
2. 利用 Spring AOP, 以 @annotation 切点标志符来匹配有注解 AuthChecker 所标注的 joinpoint.
3. 在 advice 中, 简单地检查调用者请求中的 Cookie 中是否有我们指定的 token, 如果有, 则认为此调用者权限合法, 允许调用, 反之权限不合法, 范围错误.

1.自定义AuthChecker注解

代码示例

@Target(ElementType.method)
@Retention(RetentionPolicy.RUNTIME)
public @interface AuthChecker{
    
}

2.自定义切面类

代码示例

@Aspect
@Componet
public class AopAdvise{
    // 定义一个切点 那些方法必须要进行拦截
    @Pointcut("@annotation(com.zjzcc.xys.demo.AuthChecker)")
    public void pointcut(){
        
    }
    
    // 定义一个Advise
    @Around("pointcut()")
    public Object checkAuth(ProceedingJoinPoint joint){
        // TODO 业务逻辑自己实现
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
            .getRequest();
        return joint.procees();
    }
    
    
    
}

方法调用日志

首先假设我们有如下需求:

• 某个服务下的方法的调用需要有 log: 记录调用的参数以及返回结果.
• 当方法调用出异常时, 有特殊处理, 例如打印异常 log, 报警等.

代码示例

@Componet
@Aspect
public class LogAspect{

    private Logger logger = LoggerFactory.getLogger(getClass());
    
    @Pointcut("within(NeedLogService)")
    public void pointcut(){
        
    }
    
    @Before("pointcut()")
    public void logMethodInvokeParam(JoinPoint joinPoint){
        logger.info("方法名:{},参数名:{}",joinpoint.getSignature().toString,joinpoint.getArgs());
    }
    
    @AfterReturning(pointcut = "pointcut()",returning = "retVal")
    public void logMethodResultInvoke(JoinPoint joinpoint,Object retVal){
            logger.info("方法名:{},参数名:{}",joinpoint.getSignature().toString,joinpoint.getArgs());
    }    
    
    @AfterThrowing(pointcut = "pointcut",throwing = "exception")
    public void logMethodException(JointPoint joint,Exception ex){
        logger.info("方法名:{},异常信息:{}",joinpoint.getSignature().toString,ex.getMessage());
    }
}

方法统计耗时

代码示例

@Component
@Aspect
@Order(1)
public class ExpireAspect {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Pointcut("within(com.leyou.user.service.UserService)")
    public void pointcut(){

    }

    @Around("pointcut()")
    public Object methodInvokeParam(ProceedingJoinPoint joinPoint) throws Throwable {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        // 开始执行切入点里面的方法
        Object proceed = joinPoint.proceed();
        stopWatch.stop();
        logger.info("统计耗时:{}",stopWatch.prettyPrint());
        return proceed;
    }

}