feat: 添加操作日志是否忽略支持记录当前参数配置;登录接口记录操作日志用户认证信息

hsweb-authorization/hsweb-authorization-basic/src/main/java/org/hswebframework/web/authorization/basic/web/AuthorizationController.java

@@ -33,8 +33,10 @@
 import org.hswebframework.web.authorization.exception.UnAuthorizedException;
 import org.hswebframework.web.authorization.simple.PlainTextUsernamePasswordAuthenticationRequest;
 import org.hswebframework.web.logging.AccessLogger;
+import org.hswebframework.web.logging.AccessLoggerInfo;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.context.event.EventListener;
 import org.springframework.http.MediaType;
 import org.springframework.util.Assert;
 import org.springframework.web.bind.annotation.*;
@@ -68,7 +70,7 @@ public Mono<Authentication> me() {
 
     @PostMapping(value = "/login", consumes = MediaType.APPLICATION_JSON_VALUE)
     @Authorize(ignore = true)
-    @AccessLogger(ignore = true)
+    @AccessLogger(ignoreParameter = {"parameter"})
     @Operation(summary = "登录", description = "必要参数:username,password.根据配置不同,其他参数也不同,如:验证码等.")
     public Mono<Map<String, Object>> authorizeByJson(@Parameter(example = "{\"username\":\"admin\",\"password\":\"admin\"}")
                                                      @RequestBody Mono<Map<String, Object>> parameter) {
@@ -121,6 +123,25 @@ private Mono<Map<String, Object>> doLogin(Mono<Map<String, Object>> parameter) {
         });
     }
 
+    @EventListener
+    public void fillLoggerInfoAuth(AuthorizationSuccessEvent event) {
+        event.async(
+                //填充操作日志用户认证信息
+                Mono.deferContextual(ctx -> {
+                    ctx.<AccessLoggerInfo>getOrEmpty(AccessLoggerInfo.class)
+                       .ifPresent(loggerInfo -> {
+                           Authentication auth = event.getAuthentication();
+                           loggerInfo.putContext("userId", auth.getUser().getId());
+                           loggerInfo.putContext("username", auth.getUser().getUsername());
+                           loggerInfo.putContext("userName", auth.getUser().getName());
+                       });
+                    // FIXME: 2024/3/26 未传递用户维度信息,如有需要也可通过上下文传递
+                    return Mono.empty();
+                })
+        );
+
+    }
+
     private Mono<Authentication> doAuthorize(AuthorizationBeforeEvent event) {
         Mono<Authentication> authenticationMono;
         if (event.isAuthorized()) {

hsweb-logging/hsweb-access-logging-aop/src/main/java/org/hswebframework/web/logging/aop/AccessLoggerParser.java

@@ -5,9 +5,18 @@
 import org.hswebframework.web.logging.LoggerDefine;
 
 import java.lang.reflect.Method;
+import java.util.function.Predicate;
 
 public interface AccessLoggerParser {
     boolean support(Class<?> clazz, Method method);
 
     LoggerDefine parse(MethodInterceptorHolder holder);
+
+    /**
+     * @param holder MethodInterceptorHolder
+     * @return 是否忽略支持记录当前参数
+     */
+    default Predicate<String> ignoreParameter(MethodInterceptorHolder holder) {
+        return p -> false;
+    }
 }

hsweb-logging/hsweb-access-logging-aop/src/main/java/org/hswebframework/web/logging/aop/AopAccessLoggerSupport.java

@@ -19,6 +19,9 @@
 import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
 
 /**
  * 使用AOP记录访问日志,并触发{@link AccessLoggerListener#onLogger(AccessLoggerInfo)}
@@ -61,7 +64,8 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
         info.setId(IDGenerator.MD5.generate());
 
         info.setRequestTime(System.currentTimeMillis());
-        LoggerDefine define = loggerParsers.stream()
+        LoggerDefine define = loggerParsers
+                .stream()
                 .filter(parser -> parser.support(ClassUtils.getUserClass(holder.getTarget()), holder.getMethod()))
                 .findAny()
                 .map(parser -> parser.parse(holder))
@@ -71,7 +75,7 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
             info.setAction(define.getAction());
             info.setDescribe(define.getDescribe());
         }
-        info.setParameters(holder.getNamedArguments());
+        info.setParameters(parseParameter(holder));
         info.setTarget(holder.getTarget().getClass());
         info.setMethod(holder.getMethod());
 
@@ -86,6 +90,19 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
 
     }
 
+    private Map<String, Object> parseParameter(MethodInterceptorHolder holder) {
+        Predicate<String> ignoreParameter = parameter -> loggerParsers
+                .stream()
+                .anyMatch(loggerParser -> loggerParser.ignoreParameter(holder).test(parameter));
+
+        return holder
+                .getNamedArguments()
+                .entrySet()
+                .stream()
+                .filter(entry -> ignoreParameter.test(entry.getKey()))
+                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+    }
+
     @Override
     public int getOrder() {
         return Ordered.HIGHEST_PRECEDENCE;

hsweb-logging/hsweb-access-logging-aop/src/main/java/org/hswebframework/web/logging/aop/DefaultAccessLoggerParser.java

@@ -7,7 +7,11 @@
 import org.springframework.core.annotation.AnnotationUtils;
 
 import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.HashSet;
 import java.util.Objects;
+import java.util.Set;
+import java.util.function.Predicate;
 import java.util.stream.Stream;
 
 
@@ -24,16 +28,33 @@ public LoggerDefine parse(MethodInterceptorHolder holder) {
         AccessLogger methodAnn = holder.findMethodAnnotation(AccessLogger.class);
         AccessLogger classAnn = holder.findClassAnnotation(AccessLogger.class);
         String action = Stream.of(classAnn, methodAnn)
-                .filter(Objects::nonNull)
-                .map(AccessLogger::value)
-                .reduce((c, m) -> c.concat("-").concat(m))
-                .orElse("");
+                              .filter(Objects::nonNull)
+                              .map(AccessLogger::value)
+                              .reduce((c, m) -> c.concat("-").concat(m))
+                              .orElse("");
         String describe = Stream.of(classAnn, methodAnn)
-                .filter(Objects::nonNull)
-                .map(AccessLogger::describe)
-                .flatMap(Stream::of)
-                .reduce((c, s) -> c.concat("\n").concat(s))
-                .orElse("");
-        return new LoggerDefine(action,describe);
+                                .filter(Objects::nonNull)
+                                .map(AccessLogger::describe)
+                                .flatMap(Stream::of)
+                                .reduce((c, s) -> c.concat("\n").concat(s))
+                                .orElse("");
+        return new LoggerDefine(action, describe);
+
+    }
+
+    @Override
+    public Predicate<String> ignoreParameter(MethodInterceptorHolder holder) {
+        AccessLogger methodAnn = holder.findMethodAnnotation(AccessLogger.class);
+        AccessLogger classAnn = holder.findClassAnnotation(AccessLogger.class);
+
+        Set<String> ignoreParameter = new HashSet<>();
+        if (methodAnn != null) {
+            ignoreParameter.addAll(Arrays.asList(methodAnn.ignoreParameter()));
+        }
+        if (classAnn != null) {
+            ignoreParameter.addAll(Arrays.asList(classAnn.ignoreParameter()));
+        }
+        return parameter -> ignoreParameter.contains("*") || ignoreParameter.contains(parameter);
     }
+
 }

hsweb-logging/hsweb-access-logging-aop/src/main/java/org/hswebframework/web/logging/aop/ReactiveAopAccessLoggerSupport.java

@@ -32,6 +32,7 @@
 import java.lang.reflect.Method;
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.function.Predicate;
 
 /**
  * 使用AOP记录访问日志,并触发{@link AccessLoggerListener#onLogger(AccessLoggerInfo)}
@@ -48,6 +49,7 @@ public class ReactiveAopAccessLoggerSupport extends StaticMethodMatcherPointcutA
     private ApplicationEventPublisher eventPublisher;
 
     private final Map<CacheKey, LoggerDefine> defineCache = new ConcurrentReferenceHashMap<>();
+    private final Map<CacheKey, Predicate<String>> ignoreParameterCache = new ConcurrentReferenceHashMap<>();
 
     private static final LoggerDefine UNSUPPORTED = new LoggerDefine();
 
@@ -126,6 +128,12 @@ private LoggerDefine createDefine(MethodInterceptorHolder holder) {
                 .orElse(UNSUPPORTED);
     }
 
+    private boolean ignoreParameter(String parameter, MethodInterceptorHolder holder) {
+        return loggerParsers
+                .stream()
+                .anyMatch(loggerParser -> loggerParser.ignoreParameter(holder).test(parameter));
+    }
+
     @SuppressWarnings("all")
     protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
         AccessLoggerInfo info = new AccessLoggerInfo();
@@ -141,6 +149,18 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
             info.setDescribe(define.getDescribe());
         }
 
+        info.setParameters(parseParameter(holder));
+        info.setTarget(holder.getTarget().getClass());
+        info.setMethod(holder.getMethod());
+        return info;
+
+    }
+
+    private Map<String, Object> parseParameter(MethodInterceptorHolder holder) {
+        Predicate<String> ignoreParameter = ignoreParameterCache.computeIfAbsent(new CacheKey(
+                ClassUtils.getUserClass(holder.getTarget()),
+                holder.getMethod()), method -> parameter -> ignoreParameter(parameter, holder));
+
         Map<String, Object> value = new ConcurrentHashMap<>();
 
         String[] names = holder.getArgumentsNames();
@@ -149,6 +169,9 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
 
         for (int i = 0; i < args.length; i++) {
             String name = names[i];
+            if (ignoreParameter.test(name)) {
+                continue;
+            }
             Object val = args[i];
             if (val == null) {
                 value.put(name, "null");
@@ -170,12 +193,7 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {
                 value.put(name, val);
             }
         }
-
-        info.setParameters(value);
-        info.setTarget(holder.getTarget().getClass());
-        info.setMethod(holder.getMethod());
-        return info;
-
+        return value;
     }
 
     @Override

hsweb-logging/hsweb-access-logging-api/src/main/java/org/hswebframework/web/logging/AccessLogger.java

@@ -45,4 +45,10 @@
      * @return 是否取消日志记录, 如果不想记录某些方法或者类, 设置为true即可
      */
     boolean ignore() default false;
+
+    /**
+     * @return 忽略记载方法的请求参数
+     * <p>如果不想记录方法全部或某些参数，则可以配置返回*或者对应参数名（多个用逗号分割）</p>
+     */
+    String[] ignoreParameter() default "";
 }