175 lines
6.2 KiB
Java
175 lines
6.2 KiB
Java
package org.springblade.core.boot.logger;
|
|
|
|
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.springblade.core.launch.constant.AppConstant;
|
|
import org.springblade.core.tool.jackson.JsonUtil;
|
|
import org.springblade.core.tool.utils.BeanUtil;
|
|
import org.springblade.core.tool.utils.ClassUtil;
|
|
import org.springblade.core.tool.utils.StringUtil;
|
|
import org.springblade.core.tool.utils.WebUtil;
|
|
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
|
import org.springframework.context.annotation.Profile;
|
|
import org.springframework.core.MethodParameter;
|
|
import org.springframework.core.io.InputStreamSource;
|
|
import org.springframework.web.bind.annotation.PathVariable;
|
|
import org.springframework.web.bind.annotation.RequestBody;
|
|
import org.springframework.web.bind.annotation.RequestParam;
|
|
import org.springframework.web.context.request.WebRequest;
|
|
import org.springframework.web.multipart.MultipartFile;
|
|
|
|
import javax.servlet.http.HttpServletRequest;
|
|
import javax.servlet.http.HttpServletResponse;
|
|
import java.io.InputStream;
|
|
import java.lang.reflect.Method;
|
|
import java.util.*;
|
|
import java.util.concurrent.TimeUnit;
|
|
import java.util.concurrent.atomic.AtomicBoolean;
|
|
|
|
/**
|
|
* Spring boot 控制器 请求日志,方便代码调试
|
|
*
|
|
* @author L.cm
|
|
*/
|
|
@Slf4j
|
|
@Aspect
|
|
@AutoConfiguration
|
|
@Profile({AppConstant.DEV_CODE, AppConstant.TEST_CODE})
|
|
public class RequestLogAspect {
|
|
|
|
/**
|
|
* AOP 环切 控制器 R 返回值
|
|
*
|
|
* @param point JoinPoint
|
|
* @return Object
|
|
* @throws Throwable 异常
|
|
*/
|
|
@Around(
|
|
"execution(!static org.springblade.core.tool.api.R *(..)) && " +
|
|
"(@within(org.springframework.stereotype.Controller) || " +
|
|
"@within(org.springframework.web.bind.annotation.RestController))"
|
|
)
|
|
public Object aroundApi(ProceedingJoinPoint point) throws Throwable {
|
|
MethodSignature ms = (MethodSignature) point.getSignature();
|
|
Method method = ms.getMethod();
|
|
Object[] args = point.getArgs();
|
|
// 请求参数处理
|
|
final Map<String, Object> paraMap = new HashMap<>(16);
|
|
for (int i = 0; i < args.length; i++) {
|
|
// 读取方法参数
|
|
MethodParameter methodParam = ClassUtil.getMethodParameter(method, i);
|
|
// PathVariable 参数跳过
|
|
PathVariable pathVariable = methodParam.getParameterAnnotation(PathVariable.class);
|
|
if (pathVariable != null) {
|
|
continue;
|
|
}
|
|
RequestBody requestBody = methodParam.getParameterAnnotation(RequestBody.class);
|
|
String parameterName = methodParam.getParameterName();
|
|
Object value = args[i];
|
|
// 如果是body的json则是对象
|
|
if (requestBody != null && value != null) {
|
|
paraMap.putAll(BeanUtil.toMap(value));
|
|
continue;
|
|
}
|
|
// 处理 List
|
|
if (value instanceof List) {
|
|
value = ((List) value).get(0);
|
|
}
|
|
// 处理 参数
|
|
if (value instanceof HttpServletRequest) {
|
|
paraMap.putAll(((HttpServletRequest) value).getParameterMap());
|
|
} else if (value instanceof WebRequest) {
|
|
paraMap.putAll(((WebRequest) value).getParameterMap());
|
|
} else if (value instanceof MultipartFile) {
|
|
MultipartFile multipartFile = (MultipartFile) value;
|
|
String name = multipartFile.getName();
|
|
String fileName = multipartFile.getOriginalFilename();
|
|
paraMap.put(name, fileName);
|
|
} else if (value instanceof HttpServletResponse) {
|
|
} else if (value instanceof InputStream) {
|
|
} else if (value instanceof InputStreamSource) {
|
|
} else if (value instanceof List) {
|
|
List<?> list = (List<?>) value;
|
|
AtomicBoolean isSkip = new AtomicBoolean(false);
|
|
for (Object o : list) {
|
|
if ("StandardMultipartFile".equalsIgnoreCase(o.getClass().getSimpleName())) {
|
|
isSkip.set(true);
|
|
break;
|
|
}
|
|
}
|
|
if (isSkip.get()) {
|
|
paraMap.put(parameterName, "此参数不能序列化为json");
|
|
continue;
|
|
}
|
|
} else {
|
|
// 参数名
|
|
RequestParam requestParam = methodParam.getParameterAnnotation(RequestParam.class);
|
|
String paraName;
|
|
if (requestParam != null && StringUtil.isNotBlank(requestParam.value())) {
|
|
paraName = requestParam.value();
|
|
} else {
|
|
paraName = methodParam.getParameterName();
|
|
}
|
|
paraMap.put(paraName, value);
|
|
}
|
|
}
|
|
HttpServletRequest request = WebUtil.getRequest();
|
|
String requestURI = Objects.requireNonNull(request).getRequestURI();
|
|
String requestMethod = request.getMethod();
|
|
|
|
// 构建成一条长 日志,避免并发下日志错乱
|
|
StringBuilder beforeReqLog = new StringBuilder(300);
|
|
// 日志参数
|
|
List<Object> beforeReqArgs = new ArrayList<>();
|
|
beforeReqLog.append("\n\n================ Request Start ================\n");
|
|
// 打印路由
|
|
beforeReqLog.append("===> {}: {}");
|
|
beforeReqArgs.add(requestMethod);
|
|
beforeReqArgs.add(requestURI);
|
|
// 请求参数
|
|
if (paraMap.isEmpty()) {
|
|
beforeReqLog.append("\n");
|
|
} else {
|
|
beforeReqLog.append(" Parameters: {}\n");
|
|
beforeReqArgs.add(JsonUtil.toJson(paraMap));
|
|
}
|
|
// 打印请求头
|
|
Enumeration<String> headers = request.getHeaderNames();
|
|
while (headers.hasMoreElements()) {
|
|
String headerName = headers.nextElement();
|
|
String headerValue = request.getHeader(headerName);
|
|
beforeReqLog.append("===Headers=== {} : {}\n");
|
|
beforeReqArgs.add(headerName);
|
|
beforeReqArgs.add(headerValue);
|
|
}
|
|
beforeReqLog.append("================ Request End ================\n");
|
|
// 打印执行时间
|
|
long startNs = System.nanoTime();
|
|
log.info(beforeReqLog.toString(), beforeReqArgs.toArray());
|
|
// aop 执行后的日志
|
|
StringBuilder afterReqLog = new StringBuilder(200);
|
|
// 日志参数
|
|
List<Object> afterReqArgs = new ArrayList<>();
|
|
afterReqLog.append("\n\n================ Response Start ================\n");
|
|
try {
|
|
Object result = point.proceed();
|
|
// 打印返回结构体
|
|
afterReqLog.append("===Result=== {}\n");
|
|
afterReqArgs.add(JsonUtil.toJson(result));
|
|
return result;
|
|
} finally {
|
|
long tookMs = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNs);
|
|
afterReqLog.append("<=== {}: {} ({} ms)\n");
|
|
afterReqArgs.add(requestMethod);
|
|
afterReqArgs.add(requestURI);
|
|
afterReqArgs.add(tookMs);
|
|
afterReqLog.append("================ Response End ================\n");
|
|
log.info(afterReqLog.toString(), afterReqArgs.toArray());
|
|
}
|
|
}
|
|
|
|
}
|