自定义注解+AOP花式记录你的用户操作日志

2022-12-24 01:09:02

使用自定义注解和 AOP 无忧记录用户操作日志

轻松记录，事半功倍

在系统运维、安全审计和用户分析等场景中，用户操作日志至关重要，但传统的手动记录方式繁琐且易出错。自定义注解 + AOP 技术 的结合为记录用户操作日志提供了优雅的解决方案，让您轻松实现日志记录，免除繁琐操作。

自定义注解：标注需要记录日志的方法

自定义注解是专门用来标注需要记录日志的方法，使用它可以清晰地表明需要记录日志的位置。自定义注解的定义非常简单，只需指定一个名称和一个参数即可，例如：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
    String value() default "";
}

AOP：在方法执行前后自动记录日志

AOP（面向方面编程）技术允许我们在不修改原始代码的情况下，在方法执行前后执行自定义逻辑。通过在自定义注解上使用 AOP，我们可以在方法执行前后自动记录日志。

使用方式：开箱即用，零成本接入

使用自定义注解 + AOP 记录用户操作日志非常简单，只需要以下几步：

添加依赖： 在项目中添加自定义注解和 AOP 框架的依赖。
定义自定义注解： 定义一个自定义注解，用来标注需要记录日志的方法。
实现自定义注解方法： 实现自定义注解中定义的方法，用来记录日志。
使用自定义注解： 在需要记录日志的方法上添加自定义注解。

效果：事半功倍，记录无忧

使用自定义注解 + AOP 记录用户操作日志，可以轻松实现以下效果：

自动记录日志： 在方法执行前后自动记录日志，无需手动添加日志记录代码。
日志格式统一： 使用自定义注解，可以统一日志格式，方便日志分析。
日志内容丰富： 可以记录方法执行时间、参数、返回值等信息，日志内容更加丰富。

附录：示例代码

// 定义自定义注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
    String value() default "";
}

// 实现自定义注解方法
public class LogAspect {

    @Around("@annotation(com.example.demo.Log)")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取方法执行参数
        Object[] args = joinPoint.getArgs();
        // 获取方法执行时间
        long startTime = System.currentTimeMillis();
        // 执行方法
        Object result = joinPoint.proceed();
        // 获取方法执行时间
        long endTime = System.currentTimeMillis();
        // 记录日志
        logger.info("方法执行时间：{}ms", endTime - startTime);
        logger.info("方法执行参数：{}", Arrays.toString(args));
        logger.info("方法执行结果：{}", result);
        return result;
    }
}

// 使用自定义注解
@Log("记录用户登录日志")
public void login(String username, String password) {
    // 用户登录逻辑
}