From dbf45e590212da3d3bd66611805f52cfd74fea8a Mon Sep 17 00:00:00 2001 From: chenyuan Date: Fri, 14 Aug 2026 15:54:41 +0800 Subject: [PATCH] fix: return numeric api response codes --- .../security/config/SecurityConfig.java | 2 +- .../digitalrmb/shared/api/ApiResponse.java | 14 ++++++------ .../yau/digitalrmb/shared/api/ErrorCode.java | 22 ++++++++++++++----- .../security/SecurityConfigTest.java | 1 + .../shared/GlobalExceptionHandlerTest.java | 11 ++++++++-- 5 files changed, 34 insertions(+), 16 deletions(-) diff --git a/src/main/java/com/yau/digitalrmb/security/config/SecurityConfig.java b/src/main/java/com/yau/digitalrmb/security/config/SecurityConfig.java index 52a9668..8ce7ef4 100644 --- a/src/main/java/com/yau/digitalrmb/security/config/SecurityConfig.java +++ b/src/main/java/com/yau/digitalrmb/security/config/SecurityConfig.java @@ -75,7 +75,7 @@ public class SecurityConfig { String traceId = response.getHeader(TraceIdFilter.HEADER_NAME); if (traceId == null) traceId = UUID.randomUUID().toString(); String message = code == ErrorCode.UNAUTHORIZED ? "未登录或登录已失效" : "无访问权限"; - response.getWriter().write("{\"code\":\"" + code.name() + "\",\"message\":\"" + message + response.getWriter().write("{\"code\":" + code.getCode() + ",\"message\":\"" + message + "\",\"data\":null,\"traceId\":\"" + traceId + "\"}"); } } diff --git a/src/main/java/com/yau/digitalrmb/shared/api/ApiResponse.java b/src/main/java/com/yau/digitalrmb/shared/api/ApiResponse.java index 6fb4048..37d3ca7 100644 --- a/src/main/java/com/yau/digitalrmb/shared/api/ApiResponse.java +++ b/src/main/java/com/yau/digitalrmb/shared/api/ApiResponse.java @@ -11,9 +11,9 @@ import java.time.Instant; @ApiModel(description = "接口统一响应结构") @Schema(description = "接口统一响应结构") public class ApiResponse { - @Schema(description = "业务响应码，SUCCESS表示成功", example = "SUCCESS") - private final String code; - @Schema(description = "业务响应消息", example = "success") + @Schema(description = "业务响应码；与 HTTP 状态码一致", example = "200") + private final int code; + @Schema(description = "业务响应消息", example = "操作成功") private final String message; @Schema(description = "接口实际返回的业务数据") private final T data; @@ -22,18 +22,18 @@ public class ApiResponse { @Schema(description = "服务器生成响应的时间", example = "2026-08-05T21:00:00Z") private final Instant timestamp; - public ApiResponse(String code, String message, T data, String traceId, Instant timestamp) { + public ApiResponse(int code, String message, T data, String traceId, Instant timestamp) { this.code = code; this.message = message; this.data = data; this.traceId = traceId; this.timestamp = timestamp; } - public String code() { return code; } + public int code() { return code; } public String message() { return message; } public T data() { return data; } public String traceId() { return traceId; } public Instant timestamp() { return timestamp; } - public static ApiResponse success(T data, String traceId) { return new ApiResponse(ErrorCode.SUCCESS.name(), "操作成功", data, traceId, Instant.now()); } - public static ApiResponse failure(ErrorCode errorCode, String message, String traceId) { return new ApiResponse(errorCode.name(), message, null, traceId, Instant.now()); } + public static ApiResponse success(T data, String traceId) { return new ApiResponse(ErrorCode.SUCCESS.getCode(), "操作成功", data, traceId, Instant.now()); } + public static ApiResponse failure(ErrorCode errorCode, String message, String traceId) { return new ApiResponse(errorCode.getCode(), message, null, traceId, Instant.now()); } } diff --git a/src/main/java/com/yau/digitalrmb/shared/api/ErrorCode.java b/src/main/java/com/yau/digitalrmb/shared/api/ErrorCode.java index 96a8b91..3d3c985 100644 --- a/src/main/java/com/yau/digitalrmb/shared/api/ErrorCode.java +++ b/src/main/java/com/yau/digitalrmb/shared/api/ErrorCode.java @@ -1,10 +1,20 @@ package com.yau.digitalrmb.shared.api; public enum ErrorCode { - SUCCESS, - VALIDATION_ERROR, - UNAUTHORIZED, - FORBIDDEN, - RESOURCE_NOT_FOUND, - INTERNAL_ERROR + SUCCESS(200), + VALIDATION_ERROR(400), + UNAUTHORIZED(401), + FORBIDDEN(403), + RESOURCE_NOT_FOUND(404), + INTERNAL_ERROR(500); + + private final int code; + + ErrorCode(int code) { + this.code = code; + } + + public int getCode() { + return code; + } } diff --git a/src/test/java/com/yau/digitalrmb/security/SecurityConfigTest.java b/src/test/java/com/yau/digitalrmb/security/SecurityConfigTest.java index 200f75b..ab1d28d 100644 --- a/src/test/java/com/yau/digitalrmb/security/SecurityConfigTest.java +++ b/src/test/java/com/yau/digitalrmb/security/SecurityConfigTest.java @@ -28,6 +28,7 @@ class SecurityConfigTest { .andExpect(status().isUnauthorized()) .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON)) .andExpect(content().encoding(StandardCharsets.UTF_8)) + .andExpect(jsonPath("$.code").value(401)) .andExpect(jsonPath("$.message").value("未登录或登录已失效")); } } diff --git a/src/test/java/com/yau/digitalrmb/shared/GlobalExceptionHandlerTest.java b/src/test/java/com/yau/digitalrmb/shared/GlobalExceptionHandlerTest.java index 918e0c6..7aa0c29 100644 --- a/src/test/java/com/yau/digitalrmb/shared/GlobalExceptionHandlerTest.java +++ b/src/test/java/com/yau/digitalrmb/shared/GlobalExceptionHandlerTest.java @@ -20,11 +20,18 @@ class GlobalExceptionHandlerTest { @Autowired private MockMvc mvc; + @Test + void successfulResponseUsesNumericCode() throws Exception { + mvc.perform(get("/api/v1/diagnostics/validation").param("value", "valid")) + .andExpect(status().isOk()) + .andExpect(jsonPath("$.code").value(200)); + } + @Test void blankParameterReturnsStandardBadRequest() throws Exception { mvc.perform(get("/api/v1/diagnostics/validation").param("value", "")) .andExpect(status().isBadRequest()) - .andExpect(jsonPath("$.code").value("VALIDATION_ERROR")) + .andExpect(jsonPath("$.code").value(400)) .andExpect(jsonPath("$.traceId").isNotEmpty()); } @@ -32,7 +39,7 @@ class GlobalExceptionHandlerTest { void invalidRequestBodyReturnsChineseValidationMessage() throws Exception { mvc.perform(post("/api/v1/auth/login").contentType("application/json").content("{}")) .andExpect(status().isBadRequest()) - .andExpect(jsonPath("$.code").value("VALIDATION_ERROR")) + .andExpect(jsonPath("$.code").value(400)) .andExpect(jsonPath("$.message").value("请求参数校验失败")); } }