快捷導(dǎo)航

基于Spring實現(xiàn)自定義錯誤信息返回詳解

更新時間：2025年03月20日 14:45:28 作者：夢想歌

這篇文章主要為大家詳細(xì)介紹了如何基于Spring實現(xiàn)自定義錯誤信息返回效果,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

背景

Spring 提供了 @RestControllerAdvice 用來實現(xiàn) HTTP 協(xié)議的全局異常處理。在異常信息的處理上通常只返回特定的 Response 對象，如下。

@Slf4j
@RestControllerAdvice
public class RestExceptionResolver {

	@ExceptionHandler(Exception.class)
	public ResponseEntity<?> processException(Exception ex) {
		BodyBuilder builder;
		Response response;
		ResponseStatus responseStatus =
			AnnotationUtils.findAnnotation(ex.getClass(), ResponseStatus.class);
		if (responseStatus != null) {
			builder = ResponseEntity.status(responseStatus.value());
			response = Response.buildFailure("500", responseStatus.reason());
		} else {
			builder = ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR);
			response = Response.buildFailure("500", ex.getMessage());
		}
		this.process(ex, response);
		return builder.body(response);
	}
}

作為基礎(chǔ)框架，筆者就遇到項目A 要求返回 Response1 對象，項目B 要求返回 Response2 對象，這個時候，適配起來就很痛苦，例如下方的代碼。

@Slf4j
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = false)
@ToString(callSuper = true)
@Data
public class Response extends DTO {

	private static final long serialVersionUID = 1L;

	private boolean success;

	private String errCode; // 項目A 要求錯誤碼是字符型

	private String errMessage; // 項目A 要求用這個名字

	private int code; // 項目B 要求錯誤碼是整型

	private String message; // 項目B 要求用這個名字
}

另外，@RestControllerAdvice 只適用于 Web 異常捕獲，我們還要考慮其他組件的情況，例如 Dubbo 捕獲 RPC 異常、Sentinel 組件觸發(fā)限流、Spring Security 安全框架拋出認(rèn)證異常。

目標(biāo)

不需要修改基礎(chǔ)框架，允許業(yè)務(wù)方自行擴展異常返回對象。

實現(xiàn)

將 Response 提煉為 Builder 模式，改為 ResponseBuilder.builder() 構(gòu)建返回對象。

@Slf4j
@RestControllerAdvice
public class RestExceptionHandler {

	@ExceptionHandler(Exception.class)
	public ResponseEntity<?> resolveException(Exception ex) {
		BodyBuilder builder;
		Object response;
		ResponseStatus status = AnnotationUtils.findAnnotation(ex.getClass(), ResponseStatus.class);
		if (status != null) {
			builder = ResponseEntity.status(status.value());
			response = ResponseBuilder.builder().buildFailure("500", status.reason());
		} else {
			builder = ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR);
			response = ResponseBuilder.builder().buildFailure("500", ex.getMessage());
		}
		this.postProcess(ex);
		return builder.body(response);
	}
}

public interface ResponseBuilder<T> {

	static ResponseBuilder<?> builder() {
		// 嘗試從業(yè)務(wù)項目獲取自定義的 Spring Bean
		ResponseBuilder<?> builder = ApplicationContextHelper.getBean(ResponseBuilder.class);
		if (builder != null) {
			return builder;
		}
		// 如果業(yè)務(wù)項目沒有自定義 Bean，返回默認(rèn)的 Builder
		return DefalutResponseBuilder.getInstance();
	}

	T buildSuccess();

	<Body> T buildSuccess(Body data);

	T buildFailure(String errCode, String errMessage, Object... params);
}

public class DefalutResponseBuilder implements ResponseBuilder<Response> {

    private static final DefaultResponseBuilder INSTANCE = new DefaultResponseBuilder();

    private DefaultResponseBuilder() {}

    public static DefaultResponseBuilder getInstance() {
        return INSTANCE;
    }

	@Override
	public Response buildSuccess() {
		Response response = new Response();
		response.setSuccess(true);
		return response;
	}

	@Override
	public <Body> Response buildSuccess(Body data) {
		SingleResponse<Body> response = new SingleResponse<>();
		response.setSuccess(true);
		response.setData(data);
		return response;
	}

	@Override
	public Response buildFailure(String errCode, String errMessage, Object... params) {
		Response response = new Response();
		response.setSuccess(false);
		response.setErrCode(errCode);
		response.setErrMessage(MessageFormatter.arrayFormat(message, placeholders).getMessage());
		return response;
	}
}

@Slf4j
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = false)
@ToString(callSuper = true)
@Data
public class Response extends DTO {

	private static final long serialVersionUID = 1L;

	private boolean success;

	private String errCode;

	private String errMessage;
}

業(yè)務(wù)方覺得 Response 不能滿足需求，重新定義了新對象，如下。

@Slf4j
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = false)
@ToString(callSuper = true)
@Data
public class CustomResponse {

	private static final long serialVersionUID = 1L;

	private boolean success;

	private int code; // 要求錯誤碼是整型

	private String message; // 前端要求用這個名字
}

創(chuàng)建 CustomResponseBuilder 包裝 CustomResponse 對象，并標(biāo)記 @Component 注解，放入 Spring Bean 管理。

@Component
public class CustomResponseBuilder implements ResponseBuilder<CustomResponse> {

	@Override
	public CustomResponse buildSuccess() {
		CustomResponse response = new CustomResponse();
		response.setSuccess(true);
		return response;
	}

	@Override
	public <Body> CustomResponse buildSuccess(Body data) {
		// 略
	}

	@Override
	public CustomResponse buildFailure(int code, String message, Object... params) {
		CustomResponse response = new CustomResponse();
		response.setSuccess(false);
		response.setCode(code);
		response.setMessage(MessageFormatter.arrayFormat(message, placeholders).getMessage());
		return response;
	}
}

上述已提到 ResponseBuilder.builder() 優(yōu)先查找 Spring Bean，所以 CustomResponseBuilder 覆蓋了框架內(nèi)置的 DefaultResponseBuilder 類，全局異常捕獲器返回結(jié)果時，就能返回業(yè)務(wù)方自定義的 CustomResponse 對象，這樣，不需要改動框架，就能滿足業(yè)務(wù)需求。