Java 编写一个比较全的日志注解
时间: 2024-02-09 16:08:57 浏览: 23
好的,下面是一个比较全的Java日志注解的示例代码:
```java
import java.lang.annotation.*;
@Target({ElementType.TYPE, ElementType.METHOD}) // 该注解可以用于类和方法上
@Retention(RetentionPolicy.RUNTIME) // 该注解在运行时保留
@Documented // 该注解将被包含在javadoc中
public @interface Log {
String value() default ""; // 日志信息
LogLevel level() default LogLevel.INFO; // 日志级别,默认为INFO
boolean printParams() default true; // 是否打印方法参数,默认为true
boolean printResult() default true; // 是否打印方法返回值,默认为true
boolean printTime() default true; // 是否打印方法执行时间,默认为true
boolean printThread() default true; // 是否打印线程信息,默认为true
boolean printException() default true; // 是否打印异常信息,默认为true
}
// 日志级别枚举类
enum LogLevel {
DEBUG, INFO, WARN, ERROR
}
```
在上述代码中,我们定义了一个名为Log的注解,它可以用于类和方法上,并且在运行时保留。该注解包含了一些属性,用来指定日志级别、是否打印方法参数、是否打印方法返回值、是否打印方法执行时间、是否打印线程信息以及是否打印异常信息。下面是一个使用该注解的示例:
```java
public class Demo {
@Log(value = "执行了方法A", level = LogLevel.INFO, printParams = true, printResult = true)
public void methodA(int a, int b) {
// 方法A的实现
}
}
```
在上述示例中,我们在方法methodA上使用了Log注解,并指定了一些属性。接下来,我们可以根据注解上的属性来打印日志:
```java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.reflect.Method;
public class LogUtil {
private static final Logger LOGGER = LoggerFactory.getLogger(LogUtil.class); // 使用SLF4J记录日志
public static void log(Method method, Object[] args, Object result, Throwable e) {
Log log = method.getAnnotation(Log.class);
if (log != null) {
LogLevel level = log.level();
String message = log.value();
long startTime = System.currentTimeMillis();
if (level == LogLevel.DEBUG) {
LOGGER.debug(getLogMessage(method, args, result, e, message, startTime));
} else if (level == LogLevel.WARN) {
LOGGER.warn(getLogMessage(method, args, result, e, message, startTime));
} else if (level == LogLevel.ERROR) {
LOGGER.error(getLogMessage(method, args, result, e, message, startTime));
} else {
LOGGER.info(getLogMessage(method, args, result, e, message, startTime));
}
}
}
private static String getLogMessage(Method method, Object[] args, Object result, Throwable e, String message, long startTime) {
StringBuilder sb = new StringBuilder();
sb.append(message).append(" 开始执行...");
if (args != null && args.length > 0) {
sb.append("方法参数:[");
for (int i = 0; i < args.length; i++) {
sb.append(args[i]);
if (i < args.length - 1) {
sb.append(", ");
}
}
sb.append("]");
}
if (result != null) {
sb.append("方法返回值:").append(result);
}
if (e != null) {
sb.append("方法执行出现异常:").append(e);
}
if (log.printTime()) {
long endTime = System.currentTimeMillis();
sb.append("方法执行时间:").append(endTime - startTime).append("ms");
}
if (log.printThread()) {
sb.append("方法执行线程:").append(Thread.currentThread().getName());
}
return sb.toString();
}
}
```
在上述代码中,我们定义了一个名为LogUtil的工具类,其中log方法接受一个Method类型的参数,表示需要打印日志的方法。我们首先通过getAnnotation方法获取该方法上的Log注解,如果存在,则根据注解上的属性来打印日志信息。在打印日志信息时,我们使用了SLF4J记录日志。getLogMessage方法用于构造日志信息字符串,它将方法参数、方法返回值、异常信息、方法执行时间和线程信息等信息拼接在一起。
最后,我们可以在调用需要打印日志的方法时,使用LogUtil工具类来实现日志打印:
```java
public class Main {
public static void main(String[] args) {
Demo demo = new Demo();
Method method = Demo.class.getMethod("methodA", int.class, int.class);
Object[] params = {1, 2};
Object result = null;
try {
result = method.invoke(demo, params);
} catch (Exception e) {
e.printStackTrace();
}
LogUtil.log(method, params, result, null);
}
}
```
在上述代码中,我们首先创建了一个Demo对象,然后通过反射获取methodA方法,并将其传入LogUtil.log方法中。在调用methodA方法时,我们需要传入参数,并将返回值保存。最后,我们调用LogUtil.log方法,并将method、params、result和异常信息传入。LogUtil.log方法会根据注解上的属性来打印日志信息。