Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 7 commits into from
Mar 27, 2024
Merged

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

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9807583
refactor: 去掉登录接口忽略日志记载注释
goten7 Mar 26, 2024
3e858b2
feat: 添加操作日志是否忽略支持记录当前参数配置
goten7 Mar 26, 2024
56ad57d
feat: 登录接口记录操作日志用户认证信息
goten7 Mar 26, 2024
e19dc43
feat: 优化日志记录上下文缺失的情况
goten7 Mar 26, 2024
996990c
feat: 优化参数为数组
goten7 Mar 27, 2024
53e9c78
feat: 优化参数为数组
goten7 Mar 27, 2024
ebd4ec8
feat: 优化
goten7 Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion ...src/main/java/org/hswebframework/web/authorization/basic/web/AuthorizationController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.*;
Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -121,6 +123,25 @@ private Mono<Map<String, Object>> doLogin(Mono<Map<String, Object>> parameter) {
});
}

@EventListener
public void fillLoggerInfoAuth(AuthorizationSuccessEvent event) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

单独写一个类来处理此事件

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()) {
Expand Down
9 changes: 9 additions & 0 deletions ...cess-logging-aop/src/main/java/org/hswebframework/web/logging/aop/AccessLoggerParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
25 changes: 23 additions & 2 deletions ...-logging-aop/src/main/java/org/hswebframework/web/logging/aop/AopAccessLoggerSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Predicate;
import java.util.stream.Collectors;

/**
* 使用AOP记录访问日志,并触发{@link AccessLoggerListener#onLogger(AccessLoggerInfo)}
Expand Down Expand Up @@ -61,7 +65,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))
Expand All @@ -71,7 +76,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());

Expand All @@ -86,6 +91,22 @@ protected AccessLoggerInfo createLogger(MethodInterceptorHolder holder) {

}

private Map<String, Object> parseParameter(MethodInterceptorHolder holder) {
Predicate<String> ignoreParameter = loggerParsers
.stream()
.map(parser -> parser.ignoreParameter(holder))
.filter(Objects::nonNull)
.reduce(Predicate::and)
.orElse(p -> false);

return holder
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

使用Maps.filter...来处理。减少Map对象的创建。

.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;
Expand Down
44 changes: 35 additions & 9 deletions ...gging-aop/src/main/java/org/hswebframework/web/logging/aop/DefaultAccessLoggerParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,14 @@
import org.hswebframework.web.logging.AccessLogger;
import org.hswebframework.web.logging.LoggerDefine;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.util.StringUtils;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Objects;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;


Expand All @@ -24,16 +29,37 @@ 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("");
Set<String> ignoreParameter = Stream
.of(classAnn, methodAnn)
.filter(Objects::nonNull)
.map(AccessLogger::ignoreParameter)
.filter(StringUtils::hasText)
.collect(Collectors.toSet());
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 = 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);
.map(AccessLogger::ignoreParameter)
.flatMap(s-> Arrays.stream(s.split(",")))
.filter(StringUtils::hasText)
.collect(Collectors.toSet());
return parameter -> ignoreParameter.contains("*") || ignoreParameter.contains(parameter);
}
}
30 changes: 24 additions & 6 deletions ...-aop/src/main/java/org/hswebframework/web/logging/aop/ReactiveAopAccessLoggerSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)}
Expand All @@ -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();

Expand Down Expand Up @@ -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();
Expand All @@ -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();
Expand All @@ -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");
Expand All @@ -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
Expand Down
6 changes: 6 additions & 0 deletions ...g/hsweb-access-logging-api/src/main/java/org/hswebframework/web/logging/AccessLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,10 @@
* @return 是否取消日志记录, 如果不想记录某些方法或者类, 设置为true即可
*/
boolean ignore() default false;

/**
* @return 忽略记载方法的请求参数
* <p>如果不想记录方法全部或某些参数，则可以配置返回*或者对应参数名（多个用逗号分割）</p>
*/
String ignoreParameter() default "";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

建议使用数组，并且支持 * 进行通配。

}