知識庫 / REST RSS 訂閱

4.2. 充分利用自定義異常

為了瞭解如何使用自定義異常，讓我們定義一個用於購買 股票 的方法：

@POST
@Path("/{wallet}/buy/{ticker}")
@Produces(MediaType.APPLICATION_JSON)
public Response postBuyStock(
  @PathParam("wallet") String walletId, @PathParam("ticker") String id) {
    Optional<Stock> stock = stocksRepository.findById(id);
    stock.orElseThrow(InvalidTradeException::new);

    Optional<Wallet> w = walletsRepository.findById(walletId);
    w.orElseThrow(InvalidTradeException::new);

    Wallet wallet = w.get();
    Double price = stock.get()
      .getPrice();

    if (!wallet.hasFunds(price)) {
        RestErrorResponse response = new RestErrorResponse();
        response.setSubject(wallet);
        response.setMessage("insufficient balance");
        throw new WebApplicationException(Response.status(Status.NOT_ACCEPTABLE)
          .entity(response)
          .build());
    }

    wallet.addBalance(-price);
    walletsRepository.save(wallet);

    return Response.ok(wallet)
      .build();
}

本方法中，我們使用迄今為止創建的一切。 如果股票或錢包不存在，我們拋出 InvalidTradeException 。 並且，如果資金不足，我們將構建一個 RestErrorResponse ，其中包含我們的 Wallet ，並將其作為 WebApplicationException 拋出。

4.3. 用例示例

首先，讓我們創建一個 股票：

$ curl 'http://localhost:8080/jersey/exception-handling/stocks' -H 'Content-Type: application/json' -d '{
    "id": "STOCK",
    "price": 51.57
}'

{"id": "STOCK", "price": 51.57}

然後購買它需要一個 錢包：

$ curl 'http://localhost:8080/jersey/exception-handling/wallets' -H 'Content-Type: application/json' -d '{
    "id": "WALLET",
    "balance": 100.0
}'

{"balance": 100.0, "id": "WALLET"}

之後，我們將使用我們的錢包購買股票。

$ curl -X POST 'http://localhost:8080/jersey/exception-handling/wallets/WALLET/buy/STOCK'

{"balance": 48.43, "id": "WALLET"}

我們將在響應中獲取更新後的餘額。如果嘗試再次購買，我們將收到詳細的 RestErrorResponse：

{
    "message": "insufficient balance",
    "subject": {
        "balance": 48.43,
        "id": "WALLET"
    }
}

5. 未處理異常與 <em ExceptionMapper</em>>

為了明確説明，僅僅拋出 <em WebApplicationException</em>> 並無法阻止默認錯誤頁的顯示。我們需要為我們的 <em Response</em>> 指定一個實體，而 <em InvalidTradeException</em>> 並不適用。 儘管我們盡力處理所有情況，但未處理的異常仍然可能發生。 因此，最好先處理這些異常。 藉助 <em ExceptionMapper</em>>，我們可以定義針對特定異常類型的處理點，並在提交 <em Response</em>> 之前對其進行修改。

public class ServerExceptionMapper implements ExceptionMapper<WebApplicationException> {
    @Override
    public Response toResponse(WebApplicationException exception) {
        String message = exception.getMessage();
        Response response = exception.getResponse();
        Status status = response.getStatusInfo().toEnum();

        return Response.status(status)
          .entity(status + ": " + message)
          .type(MediaType.TEXT_PLAIN)
          .build();
    }
}

例如，我們只是將異常信息傳遞到我們的 Response 中，這將顯示我們返回的內容。隨後，我們可以進一步檢查狀態碼，在構建 Response 之前：

switch (status) {
    case METHOD_NOT_ALLOWED:
        message = "HTTP METHOD NOT ALLOWED";
        break;
    case INTERNAL_SERVER_ERROR:
        message = "internal validation - " + exception;
        break;
    default:
        message = "[unhandled response code] " + exception;
}

5.1. 處理特定異常

如果經常拋出特定的 Exception，我們可以為它創建一個 ExceptionMapper。 在我們的端點中，我們使用 IllegalArgumentException 進行簡單的驗證，因此我們先為它創建一個映射器。 這一次，使用 JSON 響應：

public class IllegalArgumentExceptionMapper
  implements ExceptionMapper<IllegalArgumentException> {
    @Override
    public Response toResponse(IllegalArgumentException exception) {
        return Response.status(Response.Status.EXPECTATION_FAILED)
          .entity(build(exception.getMessage()))
          .type(MediaType.APPLICATION_JSON)
          .build();
    }

    private RestErrorResponse build(String message) {
        RestErrorResponse response = new RestErrorResponse();
        response.setMessage("an illegal argument was provided: " + message);
        return response;
    }
}

現在，每當應用程序中出現未處理的 IllegalArgumentException 時，我們的 IllegalArgumentExceptionMapper 將會處理它。

5.2. 配置

為了激活我們的異常映射器，我們需要返回到我們的 Jersey 資源配置並註冊它們：

public ExceptionHandlingConfig() {
    // packages ...
    register(IllegalArgumentExceptionMapper.class);
    register(ServerExceptionMapper.class);
}

這足以消除默認錯誤頁面。然後，根據拋出的異常類型，Jersey 會使用我們的異常映射器，當未處理的異常發生時。例如，嘗試獲取不存在的 Stock 時，IllegalArgumentExceptionMapper 將被使用：

$ curl 'http://localhost:8080/jersey/exception-handling/stocks/NONEXISTENT'

{"message": "an illegal argument was provided: ticker"}

同樣，對於其他未處理的異常，更廣泛的 ServerExceptionMapper 將被使用。例如，當我們使用錯誤的 HTTP 方法時：

$ curl -X POST 'http://localhost:8080/jersey/exception-handling/stocks/STOCK'

Method Not Allowed: HTTP 405 Method Not Allowed

6. 結論

在本文中，我們探討了使用 Jersey 處理異常的多種方法。此外，我們還了解了其重要性以及如何進行配置。隨後，我們構建了一個簡單的場景，以便應用這些方法。最終，我們擁有一個更友好、更安全的 API。