【Spring】注解使用AOP的应用（含demo）

一：AOP的简单理解：

面向切面编程，对OOP的一种补充，可以将公共逻辑（事务管理，日志，缓存）等封装成切面，和业务代码分离，降低耦合度。

---

二：AOP相关概念

1. Aspect（切面）：在Spring AOP中，切面是用@Aspect注解修饰的类，在Aspect中可以包含多个Pointcut和Adice，即公共逻辑类
2. Pointcut（切入点）：指定切面要拦截哪个包？哪个类？哪个方法或注解？使用@Pointcut注解
3. Joinpoint（连接点）：在Spring AOP中，可以认为所以方法的执行点为Joinpoint，即要使用切面的普通类，方法，注解
4. Advice（通知）：写入增强逻辑，@Befor @After @Around 注解区别增强方法是在连接点之前之后还是环绕执行
5. Weaving（织入）：将增强逻辑方法加到连接点的过程
6. Target（目标对象）：被植入切面增强逻辑的对象实例

---

三：AOP的使用

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogAnnotation {

    String module() default  "";
    String operater() default "";
}

定义 LogAnnotation 注解做切入点

@Component
@Aspect //切面  定义了 通知 和 切点 的关系
@EnableAspectJAutoProxy(proxyTargetClass = true)
@Slf4j //记录日志
public class LogAspect {

    @Pointcut("@annotation(com.xiaosuda.common.aop.LogAnnotation)")  //切点位置
    public void pt(){}

    @Around("pt()")  //环绕通知
    public Object log(ProceedingJoinPoint joinPoint) throws Throwable {
        long beginTime = System.currentTimeMillis();
        //执行方法
        Object result = joinPoint.proceed();
        //执行时长(毫秒)
        long time = System.currentTimeMillis() - beginTime;
        //保存日志
        recordLog(joinPoint, time);
        return result;
    }

    private void recordLog(ProceedingJoinPoint joinPoint, long time) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        LogAnnotation logAnnotation = method.getAnnotation(LogAnnotation.class);
        log.info("=====================log start================================");
        log.info("module:{}",logAnnotation.module());
        log.info("operation:{}",logAnnotation.operater());

        //请求的方法名
        String className = joinPoint.getTarget().getClass().getName();

        log.info("代理类名字"+joinPoint.getThis().getClass().getName());
        String methodName = signature.getName();
        log.info("request method:{}",className + "." + methodName + "()");

        //请求的参数
        Object[] args = joinPoint.getArgs();
        String params = JSON.toJSONString(args[0]);
        log.info("params:{}",params);

        //获取request 设置IP地址
        HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
        log.info("ip:{}", IpUtils.getIpAddr(request));


        log.info("excute time : {} ms",time);
        log.info("=====================log end================================");
    }
}

做增强逻辑

    @PostMapping 
    @LogAnnotation(module="文章",operater="获取文章列表")  
    public Result listArticle(@RequestBody PageParams pageParams){ 
        return articleService.listArticle(pageParams);
    }

使用AOP的Joinpoint（连接点）方法