在 Java RESTful API 開發(fā)中，處理錯(cuò)誤和異常是確保 API 可靠性和易用性的重要部分。一個(gè)良好的錯(cuò)誤處理機(jī)制不僅能夠幫助開發(fā)者調(diào)試問題，還能向客戶端提供明確的錯(cuò)誤信息。RESTful API 的錯(cuò)誤處理需要遵循一些標(biāo)準(zhǔn)和最佳實(shí)踐，以確保 API 統(tǒng)一、易于維護(hù)、并且對(duì)客戶端友好。
RESTful API 錯(cuò)誤處理的標(biāo)準(zhǔn)和最佳實(shí)踐

    使用合適的 HTTP 狀態(tài)碼
        RESTful API 應(yīng)該使用標(biāo)準(zhǔn)的 HTTP 狀態(tài)碼來表示不同類型的錯(cuò)誤。常見的 HTTP 狀態(tài)碼包括：
            400 Bad Request: 請(qǐng)求有誤，如參數(shù)缺失或格式錯(cuò)誤。
            401 Unauthorized: 用戶未認(rèn)證或認(rèn)證失敗。
            403 Forbidden: 已認(rèn)證但無權(quán)限訪問資源。
            404 Not Found: 請(qǐng)求的資源不存在。
            409 Conflict: 請(qǐng)求與服務(wù)器當(dāng)前狀態(tài)沖突，比如重復(fù)數(shù)據(jù)。
            422 Unprocessable Entity: 請(qǐng)求格式正確，但語義錯(cuò)誤，無法處理請(qǐng)求內(nèi)容（通常用于校驗(yàn)失敗）。
            500 Internal Server Error: 服務(wù)器內(nèi)部錯(cuò)誤。
            503 Service Unavailable: 服務(wù)不可用，可能是服務(wù)器超載或維護(hù)中。

    標(biāo)準(zhǔn)化錯(cuò)誤響應(yīng)結(jié)構(gòu)
        返回一致的錯(cuò)誤響應(yīng)格式，使客戶端能夠解析和處理錯(cuò)誤。典型的錯(cuò)誤響應(yīng)結(jié)構(gòu)包括 status、error、message 和 timestamp 等字段。

    示例錯(cuò)誤響應(yīng) JSON：

    json

{
  "timestamp": "2024-09-28T12:34:56.789Z",
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid input data",
  "path": "/api/v1/resource"
}

提供有意義的錯(cuò)誤消息

    錯(cuò)誤消息應(yīng)簡(jiǎn)潔明了，清楚地描述問題，但避免暴露服務(wù)器內(nèi)部信息或堆棧跟蹤，以防止安全漏洞。

使用全局異常處理器

    使用 Spring Boot 時(shí)，可以通過 @ControllerAdvice 和 @ExceptionHandler 注解創(chuàng)建全局異常處理器，以統(tǒng)一處理所有控制器拋出的異常。

示例全局異常處理器：

java

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.context.request.WebRequest;

@ControllerAdvice
public class GlobalExceptionHandler {

    // 處理自定義異常
    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleResourceNotFoundException(
            ResourceNotFoundException ex, WebRequest request) {
        ErrorResponse errorResponse = new ErrorResponse(
                HttpStatus.NOT_FOUND.value(),
                "Resource Not Found",
                ex.getMessage(),
                request.getDescription(false));
        return new ResponseEntity<>(errorResponse, HttpStatus.NOT_FOUND);
    }

    // 處理所有其他異常
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGlobalException(Exception ex, WebRequest request) {
        ErrorResponse errorResponse = new ErrorResponse(
                HttpStatus.INTERNAL_SERVER_ERROR.value(),
                "Internal Server Error",
                "An unexpected error occurred",
                request.getDescription(false));
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

// 自定義錯(cuò)誤響應(yīng)類
class ErrorResponse {
    private int status;
    private String error;
    private String message;
    private String path;

    // 構(gòu)造方法、getters 和 setters
}

自定義異常類

    定義自定義異常類，以清晰地表達(dá)不同的業(yè)務(wù)錯(cuò)誤，并在全局異常處理器中捕獲這些異常。

示例自定義異常類：

java

public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}

記錄錯(cuò)誤日志

    使用日志記錄庫（如 SLF4J、Logback）記錄錯(cuò)誤和異常的詳細(xì)信息，以便后續(xù)分析和調(diào)試。
    日志中包含詳細(xì)的異常信息，但不應(yīng)將這些詳細(xì)信息直接返回給客戶端。

來自 “ ITPUB博客 ” ，鏈接：https://blog.itpub.net/70040412/viewspace-3034382/  原作者：mingtian66