Aspect实现对方法日志的拦截记录

在实际的业务系统中，我们通常都希望程序自动的打印方法的入参和返回值，某些特定的方法可能不想打印返回值（返回数据过大，打印日志影响效率），特有了下面的实现。

1、忽略返回值的java注解类

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

/**
 * 不需要打印返回值的log
 * @author yangzhilong
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface NotPrintResponseLog {
    public boolean value() default false;
}

2、日志记录切面类

 import java.io.Serializable;
 import java.lang.reflect.Method;
 import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;

 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Pointcut;
 import org.aspectj.lang.reflect.MethodSignature;
 import org.springframework.stereotype.Component;
 import org.springframework.web.multipart.MultipartFile;

 import com.alibaba.fastjson.JSONObject;

 import lombok.extern.slf4j.Slf4j;

 /**
  * 记录Rest和service的方法的入参和返回值
　　　* @author yangzhilong
  */
 @Aspect
 @Component
 @Slf4j
 public class CommonLogAspect {
     @Pointcut(value = "execution(public * com.tomato..*Impl.*(..))")
     private void pointcutService() {

     }
     @Pointcut(value = "execution(public * com.tomato..*Rest*.*(..))")
     private void pointcutRest() {

     }
     /*
     //拦截restmapping注解
     @Pointcut(value = "execution(@org.springframework.web.bind.annotation.RequestMapping public * com.tomato..*(..))")
     private void pointCut() {

     }

     //拦截post注解
     @Pointcut(value = "execution(@org.springframework.web.bind.annotation.PostMapping public * com.tomato..*(..))")
     private void pointCutPost() {

     }

     //拦截get注解
     @Pointcut(value = "execution(@org.springframework.web.bind.annotation.GetMapping public * *com.tomato..*(..))")
     private void pointCutGet() {

     }

     //拦截Delete注解
     @Pointcut(value = "execution(@org.springframework.web.bind.annotation.DeleteMapping public * com.tomato..*(..))")
     private void pointCutDelete() {

     }

     //拦截put注解
     @Pointcut(value = "execution(@org.springframework.web.bind.annotation.PutMapping public * com.tomato..*(..))")
     private void pointCutPut() {

     }*/

     @Pointcut("pointcutService()|| pointcutRest()")
     private void pointcut() {
     }

     @Around(value = "pointcut()")
     public Object Around(ProceedingJoinPoint pjp) throws Throwable {
         String classAndMethodName = null;
         Method currentMethod = null;

         try {
             currentMethod = this.getCurrentMethod(pjp);
             classAndMethodName = this.getCurrentCompleteMethodName(pjp);
         } catch (Throwable e) {
             log.error("初始化日志记录信息时出错", e);
             return pjp.proceed();
         }

         // 处理入参
         this.processBefore(pjp, classAndMethodName);

         Object result = null;
         try {
             // 调用目标方法
             result = pjp.proceed();
         } catch (Throwable e) {
             // 目标方法异常了
             log.info("end执行方法：{}发生异常，异常简述：{}", classAndMethodName, e.getMessage());
             throw e;
         }

         // 处理返回值
         processReturnValue(result, currentMethod, classAndMethodName);

         return result;
     }

     /**
      * 得到当前方法的对象引用
      * @param pjp
      * @return
      * @throws NoSuchMethodException
      * @throws SecurityException
      */
     private Method getCurrentMethod(ProceedingJoinPoint pjp) throws NoSuchMethodException, SecurityException {
         MethodSignature mig = (MethodSignature) pjp.getSignature();
         return pjp.getTarget().getClass().getMethod(mig.getName(), mig.getParameterTypes());
     }

     /**
      * 得到完整的方法名
      * @param pjp
      * @return
      */
     private String getCurrentCompleteMethodName(ProceedingJoinPoint pjp) {
         return pjp.getTarget().getClass() + "的" + pjp.getSignature().getName() + "方法";
     }

     /**
      * 处理入参打印
      * @param pjp
      * @param classAndMethodName
      */
     private void processBefore(ProceedingJoinPoint pjp, String classAndMethodName) {
         try {
             if(null==pjp.getArgs() || pjp.getArgs().length==0) {
                 log.info("begin执行方法：{},方法无入参", classAndMethodName);
             } else {
                 if(pjp.getArgs().length == 1) {
                     if (pjp.getArgs()[0] instanceof Serializable) {
                         if(isFile(pjp.getArgs()[0])) {
                             log.info("begin执行方法：{},入参为文件类型，文件名为：{}", classAndMethodName, getFileName(pjp.getArgs()[0]));
                         } else {
                             log.info("begin执行方法：{},入参为：{}", classAndMethodName, JSONObject.toJSONString(pjp.getArgs()[0]));
                         }
                     }
                 } else {
                     log.info("begin执行方法：{},有多个入参", classAndMethodName);
                     List<Object> list = Arrays.asList(pjp.getArgs());
                     final AtomicInteger index = new AtomicInteger(1);
                     list.stream().filter(x -> x instanceof Serializable).forEach(x -> {
                         if(isFile(x)) {
                             log.info("入参{}:{}", index.get(), getFileName(x));
                         } else {
                             log.info("入参{}:{}", index.get(), JSONObject.toJSONString(x));
                         }
                         index.incrementAndGet();
                     });
                 }
             }
         } catch (Throwable e) {
             log.error("记录入参日志的时候出错:", e);
         }
     }

     /**
      * 处理返回值
      * @param result
      * @param currentMethod
      * @param classAndMethodName
      */
     private void processReturnValue(Object result, Method currentMethod, String classAndMethodName) {
         if(null == result) {
             return;
         }
         try {
             if(!currentMethod.isAnnotationPresent(NotPrintResponseLog.class) && result instanceof Serializable) {
                 log.info("end执行方法：{}，返回结果:{}", classAndMethodName, JSONObject.toJSONString(result));
             }
         } catch (Throwable e) {
             log.error("记录返回日志的时候出错:", e);
         }

     }

     /**
      * 获取文件上传的文件名
      * @param file
      * @return
      */
     private String getFileName(Object file) {
         return null==file ? "空文件" : ((MultipartFile)file).getName();
     }

     /**
      * 判断是否是文件类型
      * @param obj
      * @return
      */
     private boolean isFile(Object obj) {
         return obj instanceof MultipartFile;
     }
 }

20180530补充：

在aop的逻辑内，先走@Around注解的方法。然后是@Before注解的方法，然后这两个都通过了，走核心代码，核心代码走完，无论核心有没有返回值，都会走@After方法。然后如果程序无异常，正常返回就走@AfterReturn,有异常就走@AfterThrowing。