|
|
|
|
@ -1,375 +0,0 @@
|
|
|
|
|
package cn.iocoder.yudao.framework.operatelog.core.aop;
|
|
|
|
|
|
|
|
|
|
import cn.hutool.core.date.LocalDateTimeUtil;
|
|
|
|
|
import cn.hutool.core.exceptions.ExceptionUtil;
|
|
|
|
|
import cn.hutool.core.util.ArrayUtil;
|
|
|
|
|
import cn.hutool.core.util.StrUtil;
|
|
|
|
|
import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
|
|
|
|
|
import cn.iocoder.yudao.framework.common.pojo.CommonResult;
|
|
|
|
|
import cn.iocoder.yudao.framework.common.util.json.JsonUtils;
|
|
|
|
|
import cn.iocoder.yudao.framework.common.util.monitor.TracerUtils;
|
|
|
|
|
import cn.iocoder.yudao.framework.common.util.servlet.ServletUtils;
|
|
|
|
|
import cn.iocoder.yudao.framework.operatelog.core.enums.OperateTypeEnum;
|
|
|
|
|
import cn.iocoder.yudao.framework.operatelog.core.service.OperateLog;
|
|
|
|
|
import cn.iocoder.yudao.framework.operatelog.core.service.OperateLogFrameworkService;
|
|
|
|
|
import cn.iocoder.yudao.framework.web.core.util.WebFrameworkUtils;
|
|
|
|
|
import com.google.common.collect.Maps;
|
|
|
|
|
import io.swagger.v3.oas.annotations.tags.Tag;
|
|
|
|
|
import io.swagger.v3.oas.annotations.Operation;
|
|
|
|
|
import lombok.extern.slf4j.Slf4j;
|
|
|
|
|
import org.aspectj.lang.ProceedingJoinPoint;
|
|
|
|
|
import org.aspectj.lang.annotation.Around;
|
|
|
|
|
import org.aspectj.lang.annotation.Aspect;
|
|
|
|
|
import org.aspectj.lang.reflect.MethodSignature;
|
|
|
|
|
import org.springframework.core.annotation.AnnotationUtils;
|
|
|
|
|
import org.springframework.validation.BindingResult;
|
|
|
|
|
import org.springframework.web.bind.annotation.RequestMapping;
|
|
|
|
|
import org.springframework.web.bind.annotation.RequestMethod;
|
|
|
|
|
import org.springframework.web.multipart.MultipartFile;
|
|
|
|
|
|
|
|
|
|
import javax.annotation.Resource;
|
|
|
|
|
import javax.servlet.http.HttpServletRequest;
|
|
|
|
|
import javax.servlet.http.HttpServletResponse;
|
|
|
|
|
import java.lang.annotation.Annotation;
|
|
|
|
|
import java.lang.reflect.Array;
|
|
|
|
|
import java.time.LocalDateTime;
|
|
|
|
|
import java.util.*;
|
|
|
|
|
import java.util.function.Predicate;
|
|
|
|
|
import java.util.stream.IntStream;
|
|
|
|
|
|
|
|
|
|
import static cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants.INTERNAL_SERVER_ERROR;
|
|
|
|
|
import static cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants.SUCCESS;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 拦截使用 @OperateLog 注解，如果满足条件，则生成操作日志。
|
|
|
|
|
* 满足如下任一条件，则会进行记录：
|
|
|
|
|
* 1. 使用 @ApiOperation + 非 @GetMapping
|
|
|
|
|
* 2. 使用 @OperateLog 注解
|
|
|
|
|
* <p>
|
|
|
|
|
* 但是，如果声明 @OperateLog 注解时，将 enable 属性设置为 false 时，强制不记录。
|
|
|
|
|
*
|
|
|
|
|
* @author 芋道源码
|
|
|
|
|
*/
|
|
|
|
|
@Aspect
|
|
|
|
|
@Slf4j
|
|
|
|
|
public class OperateLogAspect {
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 用于记录操作内容的上下文
|
|
|
|
|
*
|
|
|
|
|
* @see OperateLog#getContent()
|
|
|
|
|
*/
|
|
|
|
|
private static final ThreadLocal<String> CONTENT = new ThreadLocal<>();
|
|
|
|
|
/**
|
|
|
|
|
* 用于记录拓展字段的上下文
|
|
|
|
|
*
|
|
|
|
|
* @see OperateLog#getExts()
|
|
|
|
|
*/
|
|
|
|
|
private static final ThreadLocal<Map<String, Object>> EXTS = new ThreadLocal<>();
|
|
|
|
|
|
|
|
|
|
@Resource
|
|
|
|
|
private OperateLogFrameworkService operateLogFrameworkService;
|
|
|
|
|
|
|
|
|
|
@Around("@annotation(operation)")
|
|
|
|
|
public Object around(ProceedingJoinPoint joinPoint, Operation operation) throws Throwable {
|
|
|
|
|
// 可能也添加了 @ApiOperation 注解
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog = getMethodAnnotation(joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog.class);
|
|
|
|
|
return around0(joinPoint, operateLog, operation);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
@Around("!@annotation(io.swagger.v3.oas.annotations.Operation) && @annotation(operateLog)")
|
|
|
|
|
// 兼容处理，只添加 @OperateLog 注解的情况
|
|
|
|
|
public Object around(ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog) throws Throwable {
|
|
|
|
|
return around0(joinPoint, operateLog, null);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private Object around0(ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog,
|
|
|
|
|
Operation operation) throws Throwable {
|
|
|
|
|
// 目前，只有管理员，才记录操作日志！所以非管理员，直接调用，不进行记录
|
|
|
|
|
Integer userType = WebFrameworkUtils.getLoginUserType();
|
|
|
|
|
if (!Objects.equals(userType, UserTypeEnum.ADMIN.getValue())) {
|
|
|
|
|
return joinPoint.proceed();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// 记录开始时间
|
|
|
|
|
LocalDateTime startTime = LocalDateTime.now();
|
|
|
|
|
try {
|
|
|
|
|
// 执行原有方法
|
|
|
|
|
Object result = joinPoint.proceed();
|
|
|
|
|
// 记录正常执行时的操作日志
|
|
|
|
|
this.log(joinPoint, operateLog, operation, startTime, result, null);
|
|
|
|
|
return result;
|
|
|
|
|
} catch (Throwable exception) {
|
|
|
|
|
this.log(joinPoint, operateLog, operation, startTime, null, exception);
|
|
|
|
|
throw exception;
|
|
|
|
|
} finally {
|
|
|
|
|
clearThreadLocal();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public static void setContent(String content) {
|
|
|
|
|
CONTENT.set(content);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public static void addExt(String key, Object value) {
|
|
|
|
|
if (EXTS.get() == null) {
|
|
|
|
|
EXTS.set(new HashMap<>());
|
|
|
|
|
}
|
|
|
|
|
EXTS.get().put(key, value);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void clearThreadLocal() {
|
|
|
|
|
CONTENT.remove();
|
|
|
|
|
EXTS.remove();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void log(ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog,
|
|
|
|
|
Operation operation,
|
|
|
|
|
LocalDateTime startTime, Object result, Throwable exception) {
|
|
|
|
|
try {
|
|
|
|
|
// 判断不记录的情况
|
|
|
|
|
if (!isLogEnable(joinPoint, operateLog)) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
// 真正记录操作日志
|
|
|
|
|
this.log0(joinPoint, operateLog, operation, startTime, result, exception);
|
|
|
|
|
} catch (Throwable ex) {
|
|
|
|
|
log.error("[log][记录操作日志时，发生异常，其中参数是 joinPoint({}) operateLog({}) apiOperation({}) result({}) exception({}) ]",
|
|
|
|
|
joinPoint, operateLog, operation, result, exception, ex);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void log0(ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog,
|
|
|
|
|
Operation operation,
|
|
|
|
|
LocalDateTime startTime, Object result, Throwable exception) {
|
|
|
|
|
OperateLog operateLogObj = new OperateLog();
|
|
|
|
|
// 补全通用字段
|
|
|
|
|
operateLogObj.setTraceId(TracerUtils.getTraceId());
|
|
|
|
|
operateLogObj.setStartTime(startTime);
|
|
|
|
|
// 补充用户信息
|
|
|
|
|
fillUserFields(operateLogObj);
|
|
|
|
|
// 补全模块信息
|
|
|
|
|
fillModuleFields(operateLogObj, joinPoint, operateLog, operation);
|
|
|
|
|
// 补全请求信息
|
|
|
|
|
fillRequestFields(operateLogObj);
|
|
|
|
|
// 补全方法信息
|
|
|
|
|
fillMethodFields(operateLogObj, joinPoint, operateLog, startTime, result, exception);
|
|
|
|
|
|
|
|
|
|
// 异步记录日志
|
|
|
|
|
operateLogFrameworkService.createOperateLog(operateLogObj);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void fillUserFields(OperateLog operateLogObj) {
|
|
|
|
|
operateLogObj.setUserId(WebFrameworkUtils.getLoginUserId());
|
|
|
|
|
operateLogObj.setUserType(WebFrameworkUtils.getLoginUserType());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void fillModuleFields(OperateLog operateLogObj,
|
|
|
|
|
ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog,
|
|
|
|
|
Operation operation) {
|
|
|
|
|
// module 属性
|
|
|
|
|
if (operateLog != null) {
|
|
|
|
|
operateLogObj.setModule(operateLog.module());
|
|
|
|
|
}
|
|
|
|
|
if (StrUtil.isEmpty(operateLogObj.getModule())) {
|
|
|
|
|
Tag tag = getClassAnnotation(joinPoint, Tag.class);
|
|
|
|
|
if (tag != null) {
|
|
|
|
|
// 优先读取 @Tag 的 name 属性
|
|
|
|
|
if (StrUtil.isNotEmpty(tag.name())) {
|
|
|
|
|
operateLogObj.setModule(tag.name());
|
|
|
|
|
}
|
|
|
|
|
// 没有的话，读取 @API 的 description 属性
|
|
|
|
|
if (StrUtil.isEmpty(operateLogObj.getModule()) && ArrayUtil.isNotEmpty(tag.description())) {
|
|
|
|
|
operateLogObj.setModule(tag.description());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
// name 属性
|
|
|
|
|
if (operateLog != null) {
|
|
|
|
|
operateLogObj.setName(operateLog.name());
|
|
|
|
|
}
|
|
|
|
|
if (StrUtil.isEmpty(operateLogObj.getName()) && operation != null) {
|
|
|
|
|
operateLogObj.setName(operation.summary());
|
|
|
|
|
}
|
|
|
|
|
// type 属性
|
|
|
|
|
if (operateLog != null && ArrayUtil.isNotEmpty(operateLog.type())) {
|
|
|
|
|
operateLogObj.setType(operateLog.type()[0].getType());
|
|
|
|
|
}
|
|
|
|
|
if (operateLogObj.getType() == null) {
|
|
|
|
|
RequestMethod requestMethod = obtainFirstMatchRequestMethod(obtainRequestMethod(joinPoint));
|
|
|
|
|
OperateTypeEnum operateLogType = convertOperateLogType(requestMethod);
|
|
|
|
|
operateLogObj.setType(operateLogType != null ? operateLogType.getType() : null);
|
|
|
|
|
}
|
|
|
|
|
// content 和 exts 属性
|
|
|
|
|
operateLogObj.setContent(CONTENT.get());
|
|
|
|
|
operateLogObj.setExts(EXTS.get());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void fillRequestFields(OperateLog operateLogObj) {
|
|
|
|
|
// 获得 Request 对象
|
|
|
|
|
HttpServletRequest request = ServletUtils.getRequest();
|
|
|
|
|
if (request == null) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
// 补全请求信息
|
|
|
|
|
operateLogObj.setRequestMethod(request.getMethod());
|
|
|
|
|
operateLogObj.setRequestUrl(request.getRequestURI());
|
|
|
|
|
operateLogObj.setUserIp(ServletUtils.getClientIP(request));
|
|
|
|
|
operateLogObj.setUserAgent(ServletUtils.getUserAgent(request));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void fillMethodFields(OperateLog operateLogObj,
|
|
|
|
|
ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog,
|
|
|
|
|
LocalDateTime startTime, Object result, Throwable exception) {
|
|
|
|
|
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
|
|
|
|
|
operateLogObj.setJavaMethod(methodSignature.toString());
|
|
|
|
|
if (operateLog == null || operateLog.logArgs()) {
|
|
|
|
|
operateLogObj.setJavaMethodArgs(obtainMethodArgs(joinPoint));
|
|
|
|
|
}
|
|
|
|
|
if (operateLog == null || operateLog.logResultData()) {
|
|
|
|
|
operateLogObj.setResultData(obtainResultData(result));
|
|
|
|
|
}
|
|
|
|
|
operateLogObj.setDuration((int) (LocalDateTimeUtil.between(startTime, LocalDateTime.now()).toMillis()));
|
|
|
|
|
// （正常）处理 resultCode 和 resultMsg 字段
|
|
|
|
|
if (result instanceof CommonResult) {
|
|
|
|
|
CommonResult<?> commonResult = (CommonResult<?>) result;
|
|
|
|
|
operateLogObj.setResultCode(commonResult.getCode());
|
|
|
|
|
operateLogObj.setResultMsg(commonResult.getMsg());
|
|
|
|
|
} else {
|
|
|
|
|
operateLogObj.setResultCode(SUCCESS.getCode());
|
|
|
|
|
}
|
|
|
|
|
// （异常）处理 resultCode 和 resultMsg 字段
|
|
|
|
|
if (exception != null) {
|
|
|
|
|
operateLogObj.setResultCode(INTERNAL_SERVER_ERROR.getCode());
|
|
|
|
|
operateLogObj.setResultMsg(ExceptionUtil.getRootCauseMessage(exception));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static boolean isLogEnable(ProceedingJoinPoint joinPoint,
|
|
|
|
|
cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog operateLog) {
|
|
|
|
|
// 有 @OperateLog 注解的情况下
|
|
|
|
|
if (operateLog != null) {
|
|
|
|
|
return operateLog.enable();
|
|
|
|
|
}
|
|
|
|
|
// 没有 @ApiOperation 注解的情况下，只记录 POST、PUT、DELETE 的情况
|
|
|
|
|
return obtainFirstLogRequestMethod(obtainRequestMethod(joinPoint)) != null;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static RequestMethod obtainFirstLogRequestMethod(RequestMethod[] requestMethods) {
|
|
|
|
|
if (ArrayUtil.isEmpty(requestMethods)) {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
return Arrays.stream(requestMethods).filter(requestMethod ->
|
|
|
|
|
requestMethod == RequestMethod.POST
|
|
|
|
|
|| requestMethod == RequestMethod.PUT
|
|
|
|
|
|| requestMethod == RequestMethod.DELETE)
|
|
|
|
|
.findFirst().orElse(null);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static RequestMethod obtainFirstMatchRequestMethod(RequestMethod[] requestMethods) {
|
|
|
|
|
if (ArrayUtil.isEmpty(requestMethods)) {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
// 优先，匹配最优的 POST、PUT、DELETE
|
|
|
|
|
RequestMethod result = obtainFirstLogRequestMethod(requestMethods);
|
|
|
|
|
if (result != null) {
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
// 然后，匹配次优的 GET
|
|
|
|
|
result = Arrays.stream(requestMethods).filter(requestMethod -> requestMethod == RequestMethod.GET)
|
|
|
|
|
.findFirst().orElse(null);
|
|
|
|
|
if (result != null) {
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
// 兜底，获得第一个
|
|
|
|
|
return requestMethods[0];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static OperateTypeEnum convertOperateLogType(RequestMethod requestMethod) {
|
|
|
|
|
if (requestMethod == null) {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
switch (requestMethod) {
|
|
|
|
|
case GET:
|
|
|
|
|
return OperateTypeEnum.GET;
|
|
|
|
|
case POST:
|
|
|
|
|
return OperateTypeEnum.CREATE;
|
|
|
|
|
case PUT:
|
|
|
|
|
return OperateTypeEnum.UPDATE;
|
|
|
|
|
case DELETE:
|
|
|
|
|
return OperateTypeEnum.DELETE;
|
|
|
|
|
default:
|
|
|
|
|
return OperateTypeEnum.OTHER;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static RequestMethod[] obtainRequestMethod(ProceedingJoinPoint joinPoint) {
|
|
|
|
|
RequestMapping requestMapping = AnnotationUtils.getAnnotation( // 使用 Spring 的工具类，可以处理 @RequestMapping 别名注解
|
|
|
|
|
((MethodSignature) joinPoint.getSignature()).getMethod(), RequestMapping.class);
|
|
|
|
|
return requestMapping != null ? requestMapping.method() : new RequestMethod[]{};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
@SuppressWarnings("SameParameterValue")
|
|
|
|
|
private static <T extends Annotation> T getMethodAnnotation(ProceedingJoinPoint joinPoint, Class<T> annotationClass) {
|
|
|
|
|
return ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(annotationClass);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
@SuppressWarnings("SameParameterValue")
|
|
|
|
|
private static <T extends Annotation> T getClassAnnotation(ProceedingJoinPoint joinPoint, Class<T> annotationClass) {
|
|
|
|
|
return ((MethodSignature) joinPoint.getSignature()).getMethod().getDeclaringClass().getAnnotation(annotationClass);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static String obtainMethodArgs(ProceedingJoinPoint joinPoint) {
|
|
|
|
|
// TODO 提升：参数脱敏和忽略
|
|
|
|
|
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
|
|
|
|
|
String[] argNames = methodSignature.getParameterNames();
|
|
|
|
|
Object[] argValues = joinPoint.getArgs();
|
|
|
|
|
// 拼接参数
|
|
|
|
|
Map<String, Object> args = Maps.newHashMapWithExpectedSize(argValues.length);
|
|
|
|
|
for (int i = 0; i < argNames.length; i++) {
|
|
|
|
|
String argName = argNames[i];
|
|
|
|
|
Object argValue = argValues[i];
|
|
|
|
|
// 被忽略时，标记为 ignore 字符串，避免和 null 混在一起
|
|
|
|
|
args.put(argName, !isIgnoreArgs(argValue) ? argValue : "[ignore]");
|
|
|
|
|
}
|
|
|
|
|
return JsonUtils.toJsonString(args);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static String obtainResultData(Object result) {
|
|
|
|
|
// TODO 提升：结果脱敏和忽略
|
|
|
|
|
if (result instanceof CommonResult) {
|
|
|
|
|
result = ((CommonResult<?>) result).getData();
|
|
|
|
|
}
|
|
|
|
|
return JsonUtils.toJsonString(result);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static boolean isIgnoreArgs(Object object) {
|
|
|
|
|
Class<?> clazz = object.getClass();
|
|
|
|
|
// 处理数组的情况
|
|
|
|
|
if (clazz.isArray()) {
|
|
|
|
|
return IntStream.range(0, Array.getLength(object))
|
|
|
|
|
.anyMatch(index -> isIgnoreArgs(Array.get(object, index)));
|
|
|
|
|
}
|
|
|
|
|
// 递归，处理数组、Collection、Map 的情况
|
|
|
|
|
if (Collection.class.isAssignableFrom(clazz)) {
|
|
|
|
|
return ((Collection<?>) object).stream()
|
|
|
|
|
.anyMatch((Predicate<Object>) OperateLogAspect::isIgnoreArgs);
|
|
|
|
|
}
|
|
|
|
|
if (Map.class.isAssignableFrom(clazz)) {
|
|
|
|
|
return isIgnoreArgs(((Map<?, ?>) object).values());
|
|
|
|
|
}
|
|
|
|
|
// obj
|
|
|
|
|
return object instanceof MultipartFile
|
|
|
|
|
|| object instanceof HttpServletRequest
|
|
|
|
|
|| object instanceof HttpServletResponse
|
|
|
|
|
|| object instanceof BindingResult;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|
YunaiV
2 years ago