feat: add API response and error handling

master
chenyuan 4 weeks ago
parent d2b93b6ea4
commit 3a13cfb34b

@ -82,6 +82,11 @@
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webmvc-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>

@ -0,0 +1,19 @@
package com.yau.digitalrmb.shared.api;
import java.time.Instant;
public record ApiResponse<T>(
String code,
String message,
T data,
String traceId,
Instant timestamp
) {
public static <T> ApiResponse<T> success(T data, String traceId) {
return new ApiResponse<>(ErrorCode.SUCCESS.name(), "success", data, traceId, Instant.now());
}
public static <T> ApiResponse<T> failure(ErrorCode errorCode, String message, String traceId) {
return new ApiResponse<>(errorCode.name(), message, null, traceId, Instant.now());
}
}

@ -0,0 +1,10 @@
package com.yau.digitalrmb.shared.api;
public enum ErrorCode {
SUCCESS,
VALIDATION_ERROR,
UNAUTHORIZED,
FORBIDDEN,
RESOURCE_NOT_FOUND,
INTERNAL_ERROR
}

@ -0,0 +1,16 @@
package com.yau.digitalrmb.shared.exception;
import com.yau.digitalrmb.shared.api.ErrorCode;
public class BusinessException extends RuntimeException {
private final ErrorCode errorCode;
public BusinessException(ErrorCode errorCode, String message) {
super(message);
this.errorCode = errorCode;
}
public ErrorCode getErrorCode() {
return errorCode;
}
}

@ -0,0 +1,21 @@
package com.yau.digitalrmb.shared.interfaces;
import com.yau.digitalrmb.shared.api.ApiResponse;
import com.yau.digitalrmb.shared.web.TraceIdFilter;
import jakarta.validation.constraints.NotBlank;
import org.slf4j.MDC;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@Validated
@RestController
@RequestMapping("/api/v1/diagnostics")
public class DiagnosticController {
@GetMapping("/validation")
public ApiResponse<String> validate(@RequestParam @NotBlank String value) {
return ApiResponse.success(value, MDC.get(TraceIdFilter.MDC_KEY));
}
}

@ -0,0 +1,39 @@
package com.yau.digitalrmb.shared.web;
import com.yau.digitalrmb.shared.api.ApiResponse;
import com.yau.digitalrmb.shared.api.ErrorCode;
import com.yau.digitalrmb.shared.exception.BusinessException;
import jakarta.validation.ConstraintViolationException;
import org.slf4j.MDC;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.UUID;
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler({ConstraintViolationException.class, MethodArgumentNotValidException.class})
@ResponseStatus(HttpStatus.BAD_REQUEST)
public ApiResponse<Void> handleValidation(Exception exception) {
return ApiResponse.failure(ErrorCode.VALIDATION_ERROR, exception.getMessage(), traceId());
}
@ExceptionHandler(BusinessException.class)
public ApiResponse<Void> handleBusiness(BusinessException exception) {
return ApiResponse.failure(exception.getErrorCode(), exception.getMessage(), traceId());
}
@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ApiResponse<Void> handleUnexpected(Exception exception) {
return ApiResponse.failure(ErrorCode.INTERNAL_ERROR, "系统内部错误", traceId());
}
private String traceId() {
String traceId = MDC.get(TraceIdFilter.MDC_KEY);
return traceId == null ? UUID.randomUUID().toString() : traceId;
}
}

@ -0,0 +1,34 @@
package com.yau.digitalrmb.shared.web;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
import java.util.UUID;
@Component
public class TraceIdFilter extends OncePerRequestFilter {
public static final String HEADER_NAME = "X-Trace-Id";
public static final String MDC_KEY = "traceId";
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
throws ServletException, IOException {
String traceId = request.getHeader(HEADER_NAME);
if (traceId == null || traceId.isBlank()) {
traceId = UUID.randomUUID().toString();
}
MDC.put(MDC_KEY, traceId);
response.setHeader(HEADER_NAME, traceId);
try {
filterChain.doFilter(request, response);
} finally {
MDC.remove(MDC_KEY);
}
}
}

@ -0,0 +1,29 @@
package com.yau.digitalrmb.shared;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@SpringBootTest
@AutoConfigureMockMvc(addFilters = false)
@ActiveProfiles("test")
class GlobalExceptionHandlerTest {
@Autowired
private MockMvc mvc;
@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("$.traceId").isNotEmpty());
}
}
Loading…
Cancel
Save