使用注释的 Java 代码检测

Question

我有一个包含大量代码的巨大java项目。让我们假设它看起来像：

fn1(int arg1){...}
fn2(int arg1,int arg2){...}
fn23(){...}
...
fn134(){...}

我想使用注释记录每次函数调用：

@logme("arg1")
fn1(int arg1){...}
@logme("all args")
fn2(int arg1,int arg2){...}
fn23(){...}
...
fn134(){...}

并期望

fn1(arg1=223)
fn1(arg1=213,arg2=46)

在我的日志文件中

看到您能向我推荐一些工具吗？

史蒂夫

Answer 1

我建议使用 AspectJ 来实现此目的。在这里您可以找到一个简短的文档，了解如何定义适当的切入点

Answer 2

您可以使用 AspectJ &任何可以处理此要求的日志框架，
所以你需要执行以下操作：

1-创建你的注释，它可以根据你的意愿接受参数，甚至可以接受一串未定义数量的参数，并像 'arg1=q,arg2=w,arg3= 那样处理它们e'

2- 在新注释上创建一个带有切点的切面，如下所示，

@Pointcut(value = "@annotation(loggableActivity)", argNames = "loggableActivity")

注意这里使用 argNames 将注释本身发送到处理程序方法，因此您可以从中获取参数，如 'arg1=q ,arg2=w,arg3=e'，并处理它们

3-在继续方法调用之前，记录你想要的内容，你可以从参数中获取几乎所有需要的信息，

注释代码如下所示

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LoggableActivity {
    String value();

    String args() default "";
}

：剪切代码如下所示：

@Aspect
public class ActivityLogger {

    private static final Logger logger = LoggerFactory.getLogger("activity");

    @Pointcut(value = "@annotation(loggableActivity)", argNames = "loggableActivity")
    public void loggableUserActivity(LoggableActivity loggableActivity) {

    }

    @Around("loggableUserActivity(loggableActivity)")
    public Object doLoggingUserActivity(ProceedingJoinPoint pjp,
            LoggableActivity loggableActivity) throws Throwable {}

然后在 doLoggingUserActivity 中，您可以使用类似的方法

pjp.proceed(); proceed method call
pjp.getArgs(); gets method arguments
loggableActivity.args(); gets annotation argument as String

then 使用 logger 来记录它们