采用自定义注解 和 AOP 完成日志记录

1、声明一个自定义注解

@Retention 注解包含一个 RetentionPolicy 类型的属性 value，用于指定注解的保留策略，常用的保留策略包括：

RetentionPolicy.SOURCE：表示注解仅在源代码中保留，编译器编译时会将其忽略，不会保存在编译后的字节码中。
RetentionPolicy.CLASS：表示注解在编译后的字节码中保留，但在运行时不会被加载到 JVM 中。这是默认的保留策略。
RetentionPolicy.RUNTIME：表示注解在编译后的字节码中保留，并在运行时被加载到 JVM 中

@Target 注解包含一个 ElementType[] 类型的属性 value，用于指定注解可以应用到的元素类型。常用的元素类型包括：

ElementType.TYPE：表示该注解可以应用到类、接口、枚举、注解类型等上。
ElementType.FIELD：表示该注解可以应用到字段上。
ElementType.METHOD：表示该注解可以应用到方法上。
ElementType.PARAMETER：表示该注解可以应用到方法参数上。
ElementType.CONSTRUCTOR：表示该注解可以应用到构造方法上。
ElementType.LOCAL_VARIABLE：表示该注解可以应用到局部变量上。
ElementType.ANNOTATION_TYPE：表示该注解可以应用到注解类型上。
ElementType.PACKAGE：表示该注解可以应用到包上。

@Retention(RetentionPolicy.RUNTIME) // 一般在采用自定义注解的时候使用此类型
@Target(ElementType.METHOD)  // 此注解使用在方法上
public @interface DhMonsterLog {

}

2、声明一个切面类

@Component
@Aspect
@Slf4j
public class DhMonsterLogAspect {

    @Pointcut("@annotation(com.dh.annotation.DhMonsterLog)")
    public void LogAspect(){}
    // 切面进入之前会执行
    @Before("LogAspect()")
    public void beforeDhLog(JoinPoint joinPoint) {
        ServletRequestAttributes requestAttributes =
                (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();

        String methodName = joinPoint.getSignature().getName();
        log.info("========================================= Method " + methodName + "() begin=========================================");
        // 执行时间
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        Date d= new Date();
        String time = sdf.format(d);
        log.info("Time           : " + time);
        // 打印请求 URL
        log.info("URL            : " + request.getRequestURL());
        // 打印 请求方法
        log.info("HTTP Method    : " + request.getMethod());
        // 打印controller 的全路径以及执行方法
        log.info("Class Method   : " + joinPoint.getSignature().getDeclaringTypeName() + "." + methodName);
        // 打印请求的 IP
        log.info("IP             : " + request.getRemoteHost());
        // 打印请求入参
        log.info("Request Args   : " + JSON.toJSONString(joinPoint.getArgs()));
        log.info("Executing Controller...");
    }

    @After("LogAspect()") //切面进入之后会执行
    public void afterDhLog(JoinPoint joinPoint) {
        String methodName = joinPoint.getSignature().getName();
        log.info("========================================= Method " + methodName + "() End =========================================");
    }
}

3、接口调用

    @RequestMapping("/list")
    @DhMonsterLog  //自定义的注解
    public List<Object> list(String param) {

       。。。。。。。。

    }