关于Java的MDC的一个小问题。
起初，我有非常直接的方法，一些方法有许多参数(我缩短了参数列表，以保持内容简短，只是为了这个问题，但请想象很多参数)
public String invokeMethodForPerson(int age, String name, boolean isCool, long distanceRun, double weight) {
LOGGER.info("begin to invoke method invokeMethodForPerson");
return methodForPerson(age, name, isCool, distanceRun, weight);
}
public String invokeMethodForCar(String model, boolean isElectric, long price, int numberOfDoors) {
LOGGER.info("begin to invoke method invokeMethodForCar");
return methodForCar(model, isElectric, price, numberOfDoors);
}
public String invokeMethodForFlower(String name, String color) {
LOGGER.info("begin to invoke method invokeMethodForFlower");
return methodForFlower(name, color);
}
(这个问题不是关于如何重构一长串参数)
然后，我想利用MDC。MDC非常有帮助，它允许在日志聚合工具等中进行更好的搜索。将它们作为第一级，而不是在记录器本身中是非常有用的。
因此，为了利用MDC，代码从简单变成了现在类似的东西，这是我所尝试的。
public String invokeMethodForPerson(int age, String name, boolean isCool, long distanceRun, double weight) {
MDC.put("age", age);
MDC.put("name", name);
MDC.put("isCool", isCool);
MDC.put("distanceRun", distanceRun);
MDC.put("weight", weight);
LOGGER.info("begin to invoke method invokeMethodForPerson");
return methodForPerson(age, name, isCool, distanceRun, weight);
}
public String invokeMethodForCar(String model, boolean isElectric, long price, int numberOfDoors) {
MDC.put("model", model);
MDC.put("isElectric", isElectric);
MDC.put("price", price);
MDC.put("numberOfDoors", numberOfDoors);
LOGGER.info("begin to invoke method invokeMethodForCar");
return methodForCar(model, isElectric, price, numberOfDoors);
}
public String invokeMethodForFlower(String name, String color) {
MDC.put("name", name);
MDC.put("color", color);
LOGGER.info("begin to invoke method invokeMethodForFlower");
return methodForFlower(name, color);
}
问题:现在看看代码，实际上MDC.put()的行数比实际的业务逻辑代码多
问题:对于许多参数，除了添加大量的MDC.put()行之外，是否有更干净的方法来利用MDC，如果可能的话，请使用AOP/方面/通知/切入点?
谢谢
您可以创建自己的utils来使用MDC。
public class MDCUtils {
private MDCUtils() {
}
public static void putAll(Object... params) {
if ((params.length & 1) != 0) {
throw new IllegalArgumentException("Length is odd");
}
for (int i = 0; i < params.length; i += 2) {
String key = Objects.requireNonNull((String) params[i]); //The key parameter cannot be null
Object value = params[i + 1]; //The val parameter can be null only if the underlying implementation supports it.
MDC.put(key, value);
}
}
public static void putAll(Map<String, Object> map) {
map.forEach(MDC::put);
}
public static <K extends String, V> void put(K k1, V v1, K k2, V v2) {
putAll(k1, v1, k2, v2);
}
public static <K extends String, V> void put(K k1, V v1, K k2, V v2, K k3, V v3) {
putAll(k1, v1, k2, v2, k3, v3);
}
}
用法示例:
public String invokeMethodForPerson(int age, String name, boolean isCool, long distanceRun, double weight) {
MDCUtils.putAll("age",age, "name", name,"isCool", isCool,"distanceRun", distanceRun,"weight", weight);
LOGGER.info("begin to invoke method invokeMethodForPerson");
return methodForPerson(age, name, isCool, distanceRun, weight);
}
更严格的例子:
public String invokeMethodForFlower(String name, String color) {
MDCUtils.put("name", name, "color", color);
LOGGER.info("begin to invoke method invokeMethodForFlower");
return methodForFlower(name, color);
}
使用Map.of示例，但不支持可空值。
public String invokeMethodForPerson(int age, String name, boolean isCool, long distanceRun, double weight) {
MDCUtils.putAll(Map.of( "age",age,"name", name,"isCool", isCool,"distanceRun", distanceRun,"weight", weight));
LOGGER.info("begin to invoke method invokeMethodForPerson");
return methodForPerson(age, name, isCool, distanceRun, weight);
}
更新:
通过AspectJ的AOP解决方案
为方法和参数目标增加@LogMDC注释。我们的想法是添加将所有方法参数或特定参数放入MDC
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface LogMDC {
}
添加方面，捕获标记为@LogMDC注释的方法，并将参数存储到MDC。
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
@Aspect
public class MDCAspect {
//match the method marked @LogMDC annotation
@Before("@annotation(LogMDC) && execution(* *(..))")
public void beforeMethodAnnotation(JoinPoint joinPoint) {
String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
Object[] values = joinPoint.getArgs();
if (argNames.length != 0) {
for (int i = 0; i < argNames.length; i++) {
MDC.put(argNames[i], values[i]);
}
}
}
//match the method which has any parameter with @LogMDC annotation
@Before("execution(* *(.., @LogMDC (*), ..))")
public void beforeParamsAnnotation(JoinPoint joinPoint) {
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
String[] argNames = methodSignature.getParameterNames();
Object[] values = joinPoint.getArgs();
Method method = methodSignature.getMethod();
Annotation[][] parameterAnnotations = method.getParameterAnnotations();
for (int i = 0; i < parameterAnnotations.length; i++) {
Annotation[] annotations = parameterAnnotations[i];
for (Annotation annotation : annotations) {
if (annotation.annotationType() == LogMDC.class) {
MDC.put(argNames[i], values[i]);
}
}
}
}
}
使用示例。将方法的所有参数放入MDC
@LogMDC
public String invokeMethodForPerson(int age, String name, boolean isCool, long distanceRun, double weight) {
LOGGER.info("begin to invoke method invokeMethodForPerson");
return methodForPerson(age, name, isCool, distanceRun, weight);
}
使用示例。仅将方法的特定参数放入MDC，并标记为注释。
public String invokeMethodForPerson(@LogMDC int age, @LogMDC String name, boolean isCool, long distanceRun, @LogMDC double weight) {
LOGGER.info("begin to invoke method invokeMethodForPerson");
return methodForPerson(age, name, isCool, distanceRun, weight);
}
请注意，AspectJ有一点性能影响
使用AspectJ的性能损失使用aop对性能的影响
性能:使用AspectJ记录所有方法的运行时间
取决于你的用例，你应该决定使用简单的util方法调用还是aop解决方案。
我会尝试利用MDC.setContextMap()和getCopyOfContextMap。
这样你可以一次提供一个完整的参数映射。
要小心，因为setContextMap会清除之前存在的值。