补充日志
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
## 代码实现原则
|
||||
- 优先保证业务正确性、可维护性、可读性,再考虑炫技。
|
||||
- 修改代码时忽略.sql文件,如果遇到需要改表结构,直接发我sql。
|
||||
## 日志规范
|
||||
- 关键业务节点必须补充必要日志,方便线上排查。
|
||||
- 不要打印密码、Token、手机号、身份证、支付密钥等敏感信息。
|
||||
- 异常日志必须包含足够定位问题的信息。
|
||||
## 回复规范
|
||||
- 永远用中文回复。
|
||||
@@ -64,10 +64,14 @@ java -jar cadworld-adminapi/target/cadworld-adminapi-0.0.1-SNAPSHOT.jar
|
||||
|
||||
资源通过后台上传和读取,无需客户端直连 MinIO。MinIO 实现首次使用时检查 bucket,不存在时尝试创建,因此账号需有对应权限。线上地址配置应包含实际域名及反向代理路径,上传和下载地址均使用 `/admin-api` 前缀。
|
||||
|
||||
接口文档:`http://127.0.0.1:8992/swagger-ui.html`;OpenAPI:`/api-docs`。日志配置集中在 `cadworld-common`,按应用名输出 `cadworld-adminapi.log` 和独立的 `cadworld-adminapi-error.log`,并携带请求编号。普通日志按天及 100 MB 滚动,保留 30 天、最多 10 GB;ERROR 日志按天及 50 MB 滚动,保留 60 天、最多 5 GB。归档文件保存在 `logs/archive`(支持 `LOG_PATH` 覆盖)。测试环境项目包日志为 DEBUG,生产环境为 INFO。
|
||||
接口文档:`http://127.0.0.1:8992/swagger-ui.html`;OpenAPI:`/api-docs`。日志配置集中在 `cadworld-common`,按应用名输出 `cadworld-adminapi.log` 和独立的 `cadworld-adminapi-error.log`,并携带请求编号。普通日志按天及 100 MB 滚动,保留 30 天、最多 10 GB;ERROR 日志按天及 50 MB 滚动,保留 60 天、最多 5 GB。归档文件保存在 `logs/archive`(支持 `LOG_PATH` 覆盖)。测试环境项目包日志为 DEBUG,生产环境为 INFO;Mapper 日志保持 INFO,避免 SQL 参数输出敏感数据。
|
||||
|
||||
全部后台业务接口通过 `@ApiRequestLog` 提供中文说明,统一输出请求开始与结束日志,包含路由模板、请求编号、结果、HTTP 状态、业务错误码及耗时。成功记录 INFO,业务或参数失败记录 WARN,服务异常记录 ERROR。文件流上传、下载以及 MVC 之前的 multipart 超限也覆盖;不输出请求体、查询参数、文件内容或完整对象路径。接口运行日志写入运行日志文件;数据库操作日志继续按组件库和接口库写操作的既有范围记录。
|
||||
|
||||
## 后台接口
|
||||
|
||||
前端联调文档:[后台接口文档](cadworld-adminapi/docs/admin-api.md),按模块列出全部业务接口、入参及返回示例、上传流程和错误处理。
|
||||
|
||||
响应沿用 `{code, message, data, requestId}`,分页数据为 `{items, page, size, total}`。新建用户和操作日志列表的页码从 1 开始,默认每页 20,最多 100。
|
||||
|
||||
| 路径 | 方法及行为 |
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
+4
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import com.linkerbot.cadworld.audit.AuditOperation;
|
||||
|
||||
import com.linkerbot.cadworld.service.client.ObjectStorageClient;
|
||||
@@ -34,6 +36,7 @@ public class ComponentAssetController {
|
||||
private final ObjectStorageClient objectStorageClient;
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "UPLOAD")
|
||||
@ApiRequestLog("上传组件资源文件")
|
||||
@PutMapping("/upload")
|
||||
@ResponseStatus(HttpStatus.NO_CONTENT)
|
||||
public void upload(
|
||||
@@ -50,6 +53,7 @@ public class ComponentAssetController {
|
||||
);
|
||||
}
|
||||
|
||||
@ApiRequestLog("下载组件资源文件")
|
||||
@GetMapping("/**")
|
||||
public void download(HttpServletRequest request, HttpServletResponse response) throws IOException {
|
||||
String requestUri = request.getRequestURI();
|
||||
|
||||
+13
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import com.linkerbot.cadworld.audit.AuditOperation;
|
||||
|
||||
import com.linkerbot.cadworld.common.api.ApiResponse;
|
||||
@@ -44,6 +46,7 @@ public class ComponentController {
|
||||
private final ComponentUrdfUploadService componentUrdfUploadService;
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "CREATE")
|
||||
@ApiRequestLog("新增组件")
|
||||
@PostMapping
|
||||
public ApiResponse<ComponentResponse> create(
|
||||
@Valid @RequestBody CreateComponentRequest request
|
||||
@@ -52,6 +55,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "PREPARE_UPLOAD")
|
||||
@ApiRequestLog("创建封面上传会话")
|
||||
@PostMapping("/cover-image-upload-sessions")
|
||||
public ApiResponse<PrepareCoverImageUploadSessionResponse> prepareCoverImageUploadSession(
|
||||
) {
|
||||
@@ -59,6 +63,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "PREPARE_UPLOAD_URL")
|
||||
@ApiRequestLog("获取封面上传地址")
|
||||
@PostMapping("/cover-image-upload-sessions/upload-url")
|
||||
public ApiResponse<PrepareObjectUploadUrlResponse> prepareCoverImageObjectUploadUrl(
|
||||
@Valid @RequestBody PrepareObjectUploadUrlRequest request
|
||||
@@ -67,6 +72,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "COMPLETE_UPLOAD")
|
||||
@ApiRequestLog("完成封面上传")
|
||||
@PostMapping("/cover-image-upload-sessions/complete")
|
||||
public ApiResponse<CompleteCoverImageUploadResponse> completeCoverImageUploadSession(
|
||||
@Valid @RequestBody CompleteCoverImageUploadRequest request
|
||||
@@ -75,6 +81,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "PREPARE_UPLOAD")
|
||||
@ApiRequestLog("创建模型上传会话")
|
||||
@PostMapping("/urdf-upload-sessions")
|
||||
public ApiResponse<PrepareUrdfUploadSessionResponse> prepareUrdfUploadSession(
|
||||
) {
|
||||
@@ -82,6 +89,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "PREPARE_UPLOAD_URL")
|
||||
@ApiRequestLog("获取模型上传地址")
|
||||
@PostMapping("/urdf-upload-sessions/upload-url")
|
||||
public ApiResponse<PrepareObjectUploadUrlResponse> prepareUrdfObjectUploadUrl(
|
||||
@Valid @RequestBody PrepareObjectUploadUrlRequest request
|
||||
@@ -90,6 +98,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "COMPLETE_UPLOAD")
|
||||
@ApiRequestLog("完成模型上传")
|
||||
@PostMapping("/urdf-upload-sessions/complete")
|
||||
public ApiResponse<CompleteUrdfUploadResponse> completeUrdfUploadSession(
|
||||
@Valid @RequestBody CompleteUrdfUploadRequest request
|
||||
@@ -97,6 +106,7 @@ public class ComponentController {
|
||||
return ApiResponse.success(componentUrdfUploadService.completeUploadSession(operatorProvider.userId(), request));
|
||||
}
|
||||
|
||||
@ApiRequestLog("查询组件列表")
|
||||
@GetMapping
|
||||
public ApiResponse<PageResponse<ComponentListItemResponse>> list(
|
||||
@RequestParam(defaultValue = "1") long page,
|
||||
@@ -106,12 +116,14 @@ public class ComponentController {
|
||||
return ApiResponse.success(componentService.listComponents(page, Math.min(size, 100), keyword));
|
||||
}
|
||||
|
||||
@ApiRequestLog("查询组件详情")
|
||||
@GetMapping("/{id}")
|
||||
public ApiResponse<ComponentResponse> detail(@PathVariable Long id) {
|
||||
return ApiResponse.success(componentService.getComponent(id));
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "UPDATE")
|
||||
@ApiRequestLog("修改组件")
|
||||
@PutMapping("/{id}")
|
||||
public ApiResponse<ComponentResponse> update(
|
||||
@PathVariable Long id,
|
||||
@@ -121,6 +133,7 @@ public class ComponentController {
|
||||
}
|
||||
|
||||
@AuditOperation(module = "COMPONENT", action = "DELETE")
|
||||
@ApiRequestLog("删除组件")
|
||||
@DeleteMapping("/{id}")
|
||||
public ApiResponse<SuccessResponse> delete(
|
||||
@PathVariable Long id
|
||||
|
||||
+3
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import com.fasterxml.jackson.databind.JsonNode;
|
||||
import com.linkerbot.cadworld.common.api.ApiResponse;
|
||||
import com.linkerbot.cadworld.service.InterfaceBrepService;
|
||||
@@ -17,6 +19,7 @@ import org.springframework.web.multipart.MultipartFile;
|
||||
public class InterfaceBrepController {
|
||||
private final InterfaceBrepService service;
|
||||
|
||||
@ApiRequestLog("解析 STEP 精确拓扑")
|
||||
@PostMapping(value = "/analyze", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
|
||||
public ApiResponse<JsonNode> analyze(@RequestPart("file") MultipartFile file) {
|
||||
return ApiResponse.success(service.analyze(file));
|
||||
|
||||
+8
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import com.linkerbot.cadworld.audit.AuditOperation;
|
||||
|
||||
import com.fasterxml.jackson.databind.JsonNode;
|
||||
@@ -23,16 +25,22 @@ import org.springframework.web.bind.annotation.*;
|
||||
public class InterfaceDefinitionController {
|
||||
private final InterfaceDefinitionService service;
|
||||
private final ObjectStorageClient objectStorageClient;
|
||||
@ApiRequestLog("查询接口列表")
|
||||
@GetMapping public ApiResponse<List<JsonNode>> list(@RequestParam(required = false) String keyword) { return ApiResponse.success(service.list(keyword)); }
|
||||
@ApiRequestLog("查询接口详情")
|
||||
@GetMapping("/{id}") public ApiResponse<JsonNode> get(@PathVariable String id) { return ApiResponse.success(service.get(id)); }
|
||||
@AuditOperation(module = "INTERFACE", action = "CREATE")
|
||||
@ApiRequestLog("新增接口定义")
|
||||
@PostMapping public ApiResponse<JsonNode> create(@RequestBody JsonNode request) { return ApiResponse.success(service.create(request)); }
|
||||
@AuditOperation(module = "INTERFACE", action = "UPDATE")
|
||||
@ApiRequestLog("修改接口定义")
|
||||
@PutMapping("/{id}") public ApiResponse<JsonNode> update(@PathVariable String id, @RequestBody JsonNode request) { return ApiResponse.success(service.update(id, request)); }
|
||||
@AuditOperation(module = "INTERFACE", action = "DELETE")
|
||||
@ApiRequestLog("删除接口定义")
|
||||
@DeleteMapping("/{id}") public ApiResponse<SuccessResponse> delete(@PathVariable String id) { service.delete(id); return ApiResponse.success(SuccessResponse.ok()); }
|
||||
|
||||
@AuditOperation(module = "INTERFACE", action = "UPLOAD")
|
||||
@ApiRequestLog("上传接口源文件")
|
||||
@PostMapping("/{id}/assets")
|
||||
public ApiResponse<String> uploadAsset(@PathVariable String id,
|
||||
@RequestParam int geometryRevision,
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import static com.linkerbot.cadworld.mechanicalinterface.InterfaceGeometry.*;
|
||||
import com.linkerbot.cadworld.common.api.ApiResponse;
|
||||
import com.linkerbot.cadworld.mechanicalinterface.MechanicalInterfaceSolver;
|
||||
@@ -18,11 +20,13 @@ public class InterfacePoseController {
|
||||
private final InterfaceDefinitionService definitions;
|
||||
private final MechanicalInterfaceSolver solver;
|
||||
private final ObjectMapper objectMapper;
|
||||
@ApiRequestLog("计算接口姿态候选")
|
||||
@PostMapping("/pose-candidates")
|
||||
public ApiResponse<CandidateSet> candidates(@PathVariable String id,@RequestBody JsonNode body){
|
||||
PoseRequest request=read(body,PoseRequest.class);
|
||||
return ApiResponse.success(solver.enumeratePortPoses(definitions.geometryDefinition(id,request.definitionRevision()),request));
|
||||
}
|
||||
@ApiRequestLog("确认组件端口姿态")
|
||||
@PostMapping("/confirm-port")
|
||||
public ApiResponse<Port> confirm(@PathVariable String id,@RequestBody JsonNode body){
|
||||
Port request=read(body,Port.class);
|
||||
|
||||
+4
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import com.linkerbot.cadworld.common.api.ApiResponse;
|
||||
import com.linkerbot.cadworld.common.api.PageResponse;
|
||||
import com.linkerbot.cadworld.entity.OperationLog;
|
||||
@@ -18,6 +20,7 @@ import org.springframework.web.bind.annotation.*;
|
||||
public class OperationLogController {
|
||||
private final OperationLogService service;
|
||||
|
||||
@ApiRequestLog("查询操作日志列表")
|
||||
@GetMapping
|
||||
public ApiResponse<PageResponse<OperationLog>> list(
|
||||
@RequestParam(defaultValue = "1") @Min(1) long page,
|
||||
@@ -31,6 +34,7 @@ public class OperationLogController {
|
||||
return ApiResponse.success(service.list(page, Math.min(size, 100), module, action, success, operatorId, from, to));
|
||||
}
|
||||
|
||||
@ApiRequestLog("查询操作日志详情")
|
||||
@GetMapping("/{id}")
|
||||
public ApiResponse<OperationLog> get(@PathVariable Long id) { return ApiResponse.success(service.get(id)); }
|
||||
}
|
||||
|
||||
+7
@@ -1,5 +1,7 @@
|
||||
package com.linkerbot.cadworld.controller;
|
||||
|
||||
import com.linkerbot.cadworld.logging.ApiRequestLog;
|
||||
|
||||
import com.linkerbot.cadworld.common.api.ApiResponse;
|
||||
import com.linkerbot.cadworld.common.api.PageResponse;
|
||||
import com.linkerbot.cadworld.dto.common.SuccessResponse;
|
||||
@@ -21,6 +23,7 @@ import org.springframework.web.bind.annotation.*;
|
||||
public class UserManagementController {
|
||||
private final UserManagementService service;
|
||||
|
||||
@ApiRequestLog("查询用户列表")
|
||||
@GetMapping
|
||||
public ApiResponse<PageResponse<UserResponse>> list(
|
||||
@RequestParam(defaultValue = "1") @Min(1) long page,
|
||||
@@ -31,15 +34,19 @@ public class UserManagementController {
|
||||
return ApiResponse.success(service.list(page, Math.min(size, 100), keyword, userType, status));
|
||||
}
|
||||
|
||||
@ApiRequestLog("查询用户详情")
|
||||
@GetMapping("/{id}")
|
||||
public ApiResponse<UserResponse> get(@PathVariable Long id) { return ApiResponse.success(service.get(id)); }
|
||||
|
||||
@ApiRequestLog("创建用户")
|
||||
@PostMapping
|
||||
public ApiResponse<UserResponse> create(@Valid @RequestBody SaveUserRequest request) { return ApiResponse.success(service.create(request)); }
|
||||
|
||||
@ApiRequestLog("修改用户")
|
||||
@PutMapping("/{id}")
|
||||
public ApiResponse<UserResponse> update(@PathVariable Long id, @Valid @RequestBody SaveUserRequest request) { return ApiResponse.success(service.update(id, request)); }
|
||||
|
||||
@ApiRequestLog("逻辑删除用户")
|
||||
@DeleteMapping("/{id}")
|
||||
public ApiResponse<SuccessResponse> delete(@PathVariable Long id) {
|
||||
service.delete(id);
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
package com.linkerbot.cadworld.logging;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/** 接口运行日志中的业务说明,不改变数据库操作日志的记录范围。 */
|
||||
@Target(ElementType.METHOD)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
public @interface ApiRequestLog {
|
||||
String value();
|
||||
}
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
package com.linkerbot.cadworld.logging;
|
||||
|
||||
import com.linkerbot.cadworld.common.api.ApiResponse;
|
||||
import org.springframework.core.MethodParameter;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.converter.HttpMessageConverter;
|
||||
import org.springframework.http.server.ServerHttpRequest;
|
||||
import org.springframework.http.server.ServerHttpResponse;
|
||||
import org.springframework.http.server.ServletServerHttpRequest;
|
||||
import org.springframework.web.bind.annotation.RestControllerAdvice;
|
||||
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
|
||||
|
||||
/** 只提取业务错误码,不记录响应数据或可能包含敏感字段的错误提示。 */
|
||||
@RestControllerAdvice
|
||||
public class ApiRequestLogResponseAdvice implements ResponseBodyAdvice<Object> {
|
||||
@Override
|
||||
public boolean supports(MethodParameter parameter, Class<? extends HttpMessageConverter<?>> converter) {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Object beforeBodyWrite(Object body, MethodParameter parameter, MediaType contentType,
|
||||
Class<? extends HttpMessageConverter<?>> converter,
|
||||
ServerHttpRequest request, ServerHttpResponse response) {
|
||||
if (request instanceof ServletServerHttpRequest servlet && body instanceof ApiResponse<?> envelope) {
|
||||
servlet.getServletRequest().setAttribute(ApiRequestLoggingFilter.RESULT_CODE_ATTRIBUTE,
|
||||
envelope.getCode());
|
||||
}
|
||||
return body;
|
||||
}
|
||||
}
|
||||
+123
@@ -0,0 +1,123 @@
|
||||
package com.linkerbot.cadworld.logging;
|
||||
|
||||
import com.linkerbot.cadworld.common.api.ApiCode;
|
||||
import com.linkerbot.cadworld.common.api.RequestIdHolder;
|
||||
import jakarta.servlet.FilterChain;
|
||||
import jakarta.servlet.ServletException;
|
||||
import jakarta.servlet.http.HttpServletRequest;
|
||||
import jakarta.servlet.http.HttpServletResponse;
|
||||
import java.io.IOException;
|
||||
import java.util.List;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.beans.factory.annotation.Qualifier;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.Order;
|
||||
import org.springframework.stereotype.Component;
|
||||
import org.springframework.web.filter.OncePerRequestFilter;
|
||||
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
|
||||
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
|
||||
import org.springframework.web.util.ServletRequestPathUtils;
|
||||
import org.springframework.web.util.pattern.PathPattern;
|
||||
|
||||
/**
|
||||
* 在 multipart 解析前记录接口开始,在响应完成后记录结果;不读取请求参数、文件或响应内容。
|
||||
* 路径只输出路由模板,避免关键词、文件名等用户输入进入日志。
|
||||
*/
|
||||
@Slf4j
|
||||
@Component
|
||||
@Order(Ordered.HIGHEST_PRECEDENCE + 2)
|
||||
public class ApiRequestLoggingFilter extends OncePerRequestFilter {
|
||||
static final String RESULT_CODE_ATTRIBUTE = "cadworld.runtimeLogResultCode";
|
||||
|
||||
private final List<Endpoint> endpoints;
|
||||
|
||||
public ApiRequestLoggingFilter(
|
||||
@Qualifier("requestMappingHandlerMapping") RequestMappingHandlerMapping mappings) {
|
||||
endpoints = mappings.getHandlerMethods().entrySet().stream()
|
||||
.filter(entry -> entry.getValue().hasMethodAnnotation(ApiRequestLog.class))
|
||||
.map(entry -> new Endpoint(entry.getKey(),
|
||||
entry.getValue().getMethodAnnotation(ApiRequestLog.class).value()))
|
||||
.toList();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean shouldNotFilter(HttpServletRequest request) {
|
||||
return !request.getRequestURI().startsWith(request.getContextPath() + "/admin-api/");
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
|
||||
throws ServletException, IOException {
|
||||
MatchedEndpoint endpoint;
|
||||
try {
|
||||
endpoint = resolveEndpoint(request);
|
||||
} catch (RuntimeException failure) {
|
||||
// 日志定位失败不能改变原接口的处理结果,也不输出可能包含用户输入的异常消息。
|
||||
log.warn("接口日志定位失败 method={} exceptionType={}",
|
||||
request.getMethod(), failure.getClass().getSimpleName());
|
||||
endpoint = null;
|
||||
}
|
||||
if (endpoint == null) {
|
||||
chain.doFilter(request, response);
|
||||
return;
|
||||
}
|
||||
|
||||
long started = System.nanoTime();
|
||||
String requestId = RequestIdHolder.get();
|
||||
log.info("接口开始 description={} method={} path={} requestId={}",
|
||||
endpoint.description(), request.getMethod(), endpoint.pattern().getPatternString(), requestId);
|
||||
Throwable failure = null;
|
||||
try {
|
||||
chain.doFilter(request, response);
|
||||
} catch (IOException | ServletException | RuntimeException | Error exception) {
|
||||
failure = exception;
|
||||
throw exception;
|
||||
} finally {
|
||||
long durationMs = (System.nanoTime() - started) / 1_000_000;
|
||||
String code = (String) request.getAttribute(RESULT_CODE_ATTRIBUTE);
|
||||
boolean success = failure == null && response.getStatus() < 400
|
||||
&& (code == null || ApiCode.OK.equals(code));
|
||||
String resultCode = code == null ? "HTTP_" + response.getStatus() : code;
|
||||
String exceptionType = failure == null ? "-" : failure.getClass().getSimpleName();
|
||||
String message = "接口结束 description={} method={} path={} requestId={} result={} httpStatus={} "
|
||||
+ "code={} durationMs={} exceptionType={}";
|
||||
Object[] values = {endpoint.description(), request.getMethod(), endpoint.pattern().getPatternString(),
|
||||
requestId, success ? "SUCCESS" : "FAILURE", response.getStatus(), resultCode,
|
||||
durationMs, exceptionType};
|
||||
if (failure != null || response.getStatus() >= 500) {
|
||||
log.error(message, values);
|
||||
} else if (!success) {
|
||||
log.warn(message, values);
|
||||
} else {
|
||||
log.info(message, values);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private MatchedEndpoint resolveEndpoint(HttpServletRequest request) {
|
||||
if (!ServletRequestPathUtils.hasParsedRequestPath(request)) {
|
||||
ServletRequestPathUtils.parseAndCache(request);
|
||||
}
|
||||
MatchedEndpoint best = null;
|
||||
for (Endpoint endpoint : endpoints) {
|
||||
// 只匹配路径及 HTTP 方法,避免提前解析 multipart 或访问请求参数。
|
||||
// 即使 Content-Type 不合法,也能记录对应接口的最终失败结果。
|
||||
if (endpoint.mapping().getMethodsCondition().getMatchingCondition(request) == null) {
|
||||
continue;
|
||||
}
|
||||
var matchingPaths = endpoint.mapping().getPathPatternsCondition().getMatchingCondition(request);
|
||||
if (matchingPaths == null) {
|
||||
continue;
|
||||
}
|
||||
PathPattern pattern = matchingPaths.getFirstPattern();
|
||||
if (best == null || pattern.compareTo(best.pattern()) < 0) {
|
||||
best = new MatchedEndpoint(endpoint.description(), pattern);
|
||||
}
|
||||
}
|
||||
return best;
|
||||
}
|
||||
|
||||
private record Endpoint(RequestMappingInfo mapping, String description) { }
|
||||
|
||||
private record MatchedEndpoint(String description, PathPattern pattern) { }
|
||||
}
|
||||
@@ -1,8 +1,8 @@
|
||||
spring:
|
||||
datasource:
|
||||
url: ${APP_DB_URL:jdbc:mysql://39.105.93.138:3306/cadworld?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai}
|
||||
username: ${APP_DB_USERNAME:}
|
||||
password: ${APP_DB_PASSWORD:}
|
||||
username: ${APP_DB_USERNAME:root}
|
||||
password: ${APP_DB_PASSWORD:mysql_QRWm4M}
|
||||
driver-class-name: com.mysql.cj.jdbc.Driver
|
||||
hikari:
|
||||
pool-name: CadworldAdminHikariCP
|
||||
|
||||
@@ -68,4 +68,6 @@ logging:
|
||||
level:
|
||||
root: INFO
|
||||
com.linkerbot.cadworld: INFO
|
||||
# 即使测试环境开启项目 DEBUG,也不输出可能包含手机号、模型数据等信息的 SQL 参数。
|
||||
com.linkerbot.cadworld.mapper: INFO
|
||||
org.springframework.web: INFO
|
||||
|
||||
@@ -34,6 +34,9 @@ class AdminApiTest {
|
||||
@Autowired JdbcTemplate jdbc;
|
||||
@Autowired OperationLogService logs;
|
||||
@Autowired TransactionTemplate transactions;
|
||||
@Autowired
|
||||
@org.springframework.beans.factory.annotation.Qualifier("requestMappingHandlerMapping")
|
||||
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping mappings;
|
||||
|
||||
@BeforeEach
|
||||
void clean() {
|
||||
@@ -42,6 +45,64 @@ class AdminApiTest {
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void allManagementEndpointsHaveRuntimeLogDescriptions() {
|
||||
var handlers = mappings.getHandlerMethods().values().stream()
|
||||
.filter(handler -> handler.getBeanType().getPackageName()
|
||||
.equals("com.linkerbot.cadworld.controller"))
|
||||
.toList();
|
||||
assertThat(handlers).hasSize(29);
|
||||
for (var handler : handlers) {
|
||||
var description = handler.getMethodAnnotation(com.linkerbot.cadworld.logging.ApiRequestLog.class);
|
||||
assertThat(description).as(handler.toString()).isNotNull();
|
||||
assertThat(description.value()).isNotBlank();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void requestLogsCoverSuccessfulAndRejectedCallsWithoutSensitiveValues() throws Exception {
|
||||
String phone = "13800000001";
|
||||
String token = "PRIVATE_UPLOAD_TOKEN";
|
||||
String password = "PRIVATE_PASSWORD";
|
||||
var applicationLogger = (ch.qos.logback.classic.Logger) org.slf4j.LoggerFactory.getLogger("com.linkerbot.cadworld");
|
||||
var previousLevel = applicationLogger.getLevel();
|
||||
var mapperLogger = (ch.qos.logback.classic.Logger) org.slf4j.LoggerFactory.getLogger("com.linkerbot.cadworld.mapper");
|
||||
var sqlLogs = new ch.qos.logback.core.read.ListAppender<ch.qos.logback.classic.spi.ILoggingEvent>();
|
||||
sqlLogs.start();
|
||||
mapperLogger.addAppender(sqlLogs);
|
||||
applicationLogger.setLevel(ch.qos.logback.classic.Level.DEBUG);
|
||||
try (var captured = new com.linkerbot.cadworld.logging.ApiRequestLogCapture()) {
|
||||
mvc.perform(post("/admin-api/users").header("X-Request-Id", "user-create-log")
|
||||
.contentType(MediaType.APPLICATION_JSON)
|
||||
.content(json.writeValueAsString(Map.of("phone", phone, "nickname", "日志测试用户",
|
||||
"uploadSessionToken", token, "password", password))))
|
||||
.andExpect(status().isOk());
|
||||
mvc.perform(get("/admin-api/users").header("X-Request-Id", "user-list-log")
|
||||
.param("keyword", phone).param("token", token))
|
||||
.andExpect(status().isOk());
|
||||
mvc.perform(post("/admin-api/users").header("X-Request-Id", "user-rejected-log")
|
||||
.contentType(MediaType.APPLICATION_JSON)
|
||||
.content(json.writeValueAsString(Map.of("phone", phone, "nickname", "日志测试用户",
|
||||
"userType", "PRIVATE_INVALID_TYPE", "uploadSessionToken", token))))
|
||||
.andExpect(status().isUnprocessableEntity());
|
||||
|
||||
assertThat(captured.messages()).hasSize(6);
|
||||
String messages = String.join("\n", captured.messages());
|
||||
assertThat(messages).contains("description=创建用户", "description=查询用户列表",
|
||||
"requestId=user-list-log", "result=SUCCESS", "httpStatus=200", "code=OK",
|
||||
"requestId=user-rejected-log", "result=FAILURE", "httpStatus=422",
|
||||
"code=INVALID_REQUEST", "durationMs=");
|
||||
assertThat(messages).doesNotContain(phone, token, password, "PRIVATE_INVALID_TYPE", "keyword=");
|
||||
assertThat(captured.events().getLast().getLevel()).isEqualTo(ch.qos.logback.classic.Level.WARN);
|
||||
assertThat(sqlLogs.list).isEmpty();
|
||||
assertThat(logCount()).isZero();
|
||||
} finally {
|
||||
applicationLogger.setLevel(previousLevel);
|
||||
mapperLogger.detachAppender(sqlLogs);
|
||||
sqlLogs.stop();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void userCrudFiltersAndLogicalDeletionKeepPhoneReserved() throws Exception {
|
||||
JsonNode created = send("/admin-api/users", Map.of("phone", "13812345678", "nickname", "测试用户"));
|
||||
|
||||
@@ -35,9 +35,18 @@ class UploadHttpTest {
|
||||
});
|
||||
HttpHeaders headers = new HttpHeaders();
|
||||
headers.setContentType(MediaType.MULTIPART_FORM_DATA);
|
||||
var response = http.postForEntity("/admin-api/interfaces/missing/assets?geometryRevision=1", new HttpEntity<>(body, headers), String.class);
|
||||
assertThat(response.getStatusCode()).isEqualTo(HttpStatus.PAYLOAD_TOO_LARGE);
|
||||
assertThat(jdbc.queryForObject("SELECT COUNT(*) FROM sys_operation_log WHERE module='INTERFACE' AND action='UPLOAD' AND http_status=413 AND success=FALSE AND target_id='missing'", Long.class))
|
||||
.isEqualTo(1);
|
||||
headers.set("X-Request-Id", "oversize-runtime-log");
|
||||
try (var captured = new com.linkerbot.cadworld.logging.ApiRequestLogCapture()) {
|
||||
var response = http.postForEntity("/admin-api/interfaces/missing/assets?geometryRevision=1", new HttpEntity<>(body, headers), String.class);
|
||||
assertThat(response.getStatusCode()).isEqualTo(HttpStatus.PAYLOAD_TOO_LARGE);
|
||||
org.awaitility.Awaitility.await().atMost(java.time.Duration.ofSeconds(5)).untilAsserted(() -> {
|
||||
assertThat(jdbc.queryForObject("SELECT COUNT(*) FROM sys_operation_log WHERE module='INTERFACE' AND action='UPLOAD' AND http_status=413 AND success=FALSE AND target_id='missing'", Long.class))
|
||||
.isEqualTo(1);
|
||||
assertThat(captured.messages()).hasSize(2);
|
||||
assertThat(captured.messages().getLast()).contains("description=上传接口源文件",
|
||||
"requestId=oversize-runtime-log", "result=FAILURE", "httpStatus=413",
|
||||
"code=INVALID_REQUEST");
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
package com.linkerbot.cadworld.logging;
|
||||
|
||||
import ch.qos.logback.classic.Level;
|
||||
import ch.qos.logback.classic.Logger;
|
||||
import ch.qos.logback.classic.spi.ILoggingEvent;
|
||||
import ch.qos.logback.core.AppenderBase;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.CopyOnWriteArrayList;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/** 捕获请求日志,包括真实 Servlet 服务线程产生的日志。 */
|
||||
public final class ApiRequestLogCapture implements AutoCloseable {
|
||||
private final Logger logger = (Logger) LoggerFactory.getLogger(ApiRequestLoggingFilter.class);
|
||||
private final Level previousLevel = logger.getLevel();
|
||||
private final List<ILoggingEvent> events = new CopyOnWriteArrayList<>();
|
||||
private final AppenderBase<ILoggingEvent> appender = new AppenderBase<>() {
|
||||
@Override
|
||||
protected void append(ILoggingEvent event) {
|
||||
event.prepareForDeferredProcessing();
|
||||
events.add(event);
|
||||
}
|
||||
};
|
||||
|
||||
public ApiRequestLogCapture() {
|
||||
appender.start();
|
||||
logger.setLevel(Level.INFO);
|
||||
logger.addAppender(appender);
|
||||
}
|
||||
|
||||
public List<ILoggingEvent> events() {
|
||||
return List.copyOf(events);
|
||||
}
|
||||
|
||||
public List<String> messages() {
|
||||
return events().stream().map(ILoggingEvent::getFormattedMessage).toList();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void close() {
|
||||
logger.detachAppender(appender);
|
||||
logger.setLevel(previousLevel);
|
||||
appender.stop();
|
||||
}
|
||||
}
|
||||
+81
@@ -0,0 +1,81 @@
|
||||
package com.linkerbot.cadworld.logging;
|
||||
|
||||
import ch.qos.logback.classic.Level;
|
||||
import com.linkerbot.cadworld.common.api.RequestIdHolder;
|
||||
import com.linkerbot.cadworld.common.web.RequestIdFilter;
|
||||
import java.io.IOException;
|
||||
import java.util.Map;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.mock.web.MockHttpServletRequest;
|
||||
import org.springframework.mock.web.MockHttpServletResponse;
|
||||
import org.springframework.web.bind.annotation.RequestMethod;
|
||||
import org.springframework.web.method.HandlerMethod;
|
||||
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
|
||||
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
|
||||
import org.springframework.web.util.pattern.PathPatternParser;
|
||||
|
||||
import static org.assertj.core.api.Assertions.*;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
class ApiRequestLoggingFilterTest {
|
||||
@Test
|
||||
void binaryUploadLogs204WithoutReadingParametersOrFileContent() throws Exception {
|
||||
var filter = filter("/admin-api/component-assets/upload", RequestMethod.PUT);
|
||||
var request = spy(new MockHttpServletRequest("PUT", "/admin-api/component-assets/upload"));
|
||||
request.setQueryString("objectKey=13800000001-secret-token.txt");
|
||||
request.setContent("private file content".getBytes(java.nio.charset.StandardCharsets.UTF_8));
|
||||
request.addHeader("X-Request-Id", "binary-log-test");
|
||||
var response = new MockHttpServletResponse();
|
||||
try (var captured = new ApiRequestLogCapture()) {
|
||||
new RequestIdFilter().doFilter(request, response, (req, res) ->
|
||||
filter.doFilter(req, res, (innerRequest, innerResponse) -> response.setStatus(204)));
|
||||
|
||||
assertThat(captured.messages()).hasSize(2);
|
||||
assertThat(captured.messages().getLast()).contains("description=测试接口", "result=SUCCESS",
|
||||
"httpStatus=204", "code=HTTP_204", "requestId=binary-log-test");
|
||||
assertThat(String.join("\n", captured.messages()))
|
||||
.doesNotContain("13800000001", "secret-token", "private file content");
|
||||
verify(request, never()).getParameter(anyString());
|
||||
verify(request, never()).getParameterMap();
|
||||
verify(request, never()).getInputStream();
|
||||
assertThat(response.getContentAsByteArray()).isEmpty();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void downloadFailureRetainsOriginalExceptionAndHidesSensitiveMessagesAndFilePath() throws Exception {
|
||||
var filter = filter("/admin-api/component-assets/**", RequestMethod.GET);
|
||||
var request = new MockHttpServletRequest("GET", "/cadworld/admin-api/component-assets/13800000001-private-token.png");
|
||||
request.setContextPath("/cadworld");
|
||||
request.addHeader("X-Request-Id", "download-log-test");
|
||||
var response = new MockHttpServletResponse();
|
||||
IOException failure = new IOException("password=private-password, phone=13800000001");
|
||||
try (var captured = new ApiRequestLogCapture()) {
|
||||
assertThatThrownBy(() -> new RequestIdFilter().doFilter(request, response, (req, res) ->
|
||||
filter.doFilter(req, res, (innerRequest, innerResponse) -> { throw failure; })))
|
||||
.isSameAs(failure);
|
||||
|
||||
assertThat(captured.events()).hasSize(2);
|
||||
assertThat(captured.events().getLast().getLevel()).isEqualTo(Level.ERROR);
|
||||
assertThat(captured.messages().getLast()).contains("result=FAILURE", "exceptionType=IOException",
|
||||
"path=/admin-api/component-assets/**", "requestId=download-log-test");
|
||||
assertThat(String.join("\n", captured.messages()))
|
||||
.doesNotContain("13800000001", "private-token", "private-password");
|
||||
assertThat(captured.events().getLast().getThrowableProxy()).isNull();
|
||||
assertThat(RequestIdHolder.get()).isNull();
|
||||
}
|
||||
}
|
||||
|
||||
private ApiRequestLoggingFilter filter(String path, RequestMethod method) throws Exception {
|
||||
var options = new RequestMappingInfo.BuilderConfiguration();
|
||||
options.setPatternParser(PathPatternParser.defaultInstance);
|
||||
var mapping = RequestMappingInfo.paths(path).methods(method).options(options).build();
|
||||
var handler = new HandlerMethod(this, getClass().getDeclaredMethod("endpoint"));
|
||||
var mappings = mock(RequestMappingHandlerMapping.class);
|
||||
when(mappings.getHandlerMethods()).thenReturn(Map.of(mapping, handler));
|
||||
return new ApiRequestLoggingFilter(mappings);
|
||||
}
|
||||
|
||||
@ApiRequestLog("测试接口")
|
||||
void endpoint() { }
|
||||
}
|
||||
Reference in New Issue
Block a user