使用面向方面編程時的自定義參數日誌記錄

Question

所有我見過的使用面向方面的編程來記錄日誌類，方法名和持續時間的例子，並且如果他們記錄參數並返回值，他們只需使用ToString（）。我需要對記錄的內容有更多的控制權。例如，我想跳過密碼，或者在某些情況下記錄對象的所有屬性，但在其他情況下只是id屬性。 有什麼建議嗎？我在C＃中查看了Java中的AspectJ和Unity攔截，並找不到解決方案。

Answer 1

您可以嘗試引入參數註釋以增強具有某些屬性的參數。其中一個屬性可能表示跳過記錄參數，另一個屬性可用於爲字符串表示指定轉換器類。

與以下注釋：

@Documented 
@Retention(RetentionPolicy.RUNTIME) 
@Target(ElementType.METHOD) 
public @interface Log { 
} 


@Documented 
@Retention(RetentionPolicy.RUNTIME) 
@Target(ElementType.PARAMETER) 
public @interface SkipLogging { 
} 

@Documented 
@Retention(RetentionPolicy.RUNTIME) 
@Target(ElementType.PARAMETER) 
public @interface ToStringWith { 
    Class<? extends Function<?, String>> value(); 
} 

方面看起來是這樣的：

import java.lang.reflect.Parameter; 
import java.util.function.Function; 
import java.util.stream.Collectors; 
import java.util.stream.IntStream; 

import org.aspectj.lang.reflect.MethodSignature; 
import org.slf4j.Logger; 
import org.slf4j.LoggerFactory; 

public aspect LoggingAspect { 

    private final static Logger logger = LoggerFactory.getLogger(LoggingAspect.class); 

    pointcut loggableMethod(): execution(@Log * *..*.*(..)); 

    before(): loggableMethod() { 
     MethodSignature signature = (MethodSignature) thisJoinPoint.getSignature(); 
     Parameter[] parameters = signature.getMethod() 
      .getParameters(); 
     String message = IntStream.range(0, parameters.length) 
      .filter(i -> this.isLoggable(parameters[i])) 
      .<String>mapToObj(i -> toString(parameters[i], thisJoinPoint.getArgs()[i])) 
      .collect(Collectors.joining(", ", 
        "method execution " + signature.getName() + "(", ")")); 
     Logger methodLogger = LoggerFactory.getLogger(
       thisJoinPointStaticPart.getSignature().getDeclaringType()); 
     methodLogger.debug(message); 
    } 

    private boolean isLoggable(Parameter parameter) { 
     return parameter.getAnnotation(SkipLogging.class) == null; 
    } 

    private String toString(Parameter parameter, Object value) { 
     ToStringWith toStringWith = parameter.getAnnotation(ToStringWith.class); 
     if (toStringWith != null) { 
      Class<? extends Function<?, String>> converterClass = 
        toStringWith.value(); 
      try { 
       @SuppressWarnings("unchecked") 
       Function<Object, String> converter = (Function<Object, String>) 
        converterClass.newInstance(); 
       String str = converter.apply(value); 
       return String.format("%s='%s'", parameter.getName(), str); 
      } catch (Exception e) { 
       logger.error("Couldn't instantiate toString converter for logging " 
         + converterClass.getName(), e); 
       return String.format("%s=<error converting to string>", 
         parameter.getName()); 
      } 
     } else { 
      return String.format("%s='%s'", parameter.getName(), String.valueOf(value)); 
     } 
    } 

} 

測試代碼：

public static class SomethingToStringConverter implements Function<Something, String> { 

    @Override 
    public String apply(Something something) { 
     return "Something nice"; 
    } 

} 

@Log 
public void test(
     @ToStringWith(SomethingToStringConverter.class) Something something, 
     String string, 
     @SkipLogging Class<?> cls, 
     Object object) { 

} 

public static void main(String[] args) { 
// execution of this method should log the following message: 
// method execution test(something='Something nice', string='some string', object='null') 
    test(new Something(), "some string", Object.class, null); 
} 

我使用的Java 8流API在我回答它的緊湊性，你可以將代碼轉換爲正常的Java代碼，如果你不使用Java 8功能或需要更好的效率。這只是給你一個想法。