在 JAX-RS 用戶端中讀取回應主體

1. 概述

RESTful 服務是後端開發的核心元件。然而，處理 HTTP 回應有時會顯得很複雜。許多開發人員在處理 JAX-RS 中的 POST 請求的回應主體時面臨挑戰。

在本教學中，我們將探索 JAX-RS 用戶端 API，專注於揭開回應處理的神秘面紗，同時提供實用、可操作的解決方案。無論是經驗豐富的開發人員還是剛起步的開發人員，它也將為我們提供工具，以便自信地管理回應主體。

2. JAX-RS 客戶端 API 和常見挑戰

JAX-RS 是一種 Java API，用於在RESTful Web 服務中傳送和接收資料。客戶端 API 簡化了與 REST 服務的交互，使開發人員能夠：

• 建構 HTTP 請求
• 將其發送到伺服器
• 精準有效率地處理回應

在JAX-RS中的關鍵類別中， Response類別至關重要。它代表從伺服器收到的 HTTP 回應，並提供有效處理回應各個方面的方法。

在深入研究解決方案之前，確定開發人員面臨的常見挑戰會很有幫助：

• 意外的回應格式：有時，回應格式可能與客戶端期望的不匹配，因此難以解析或處理。
• 空響應：伺服器偶爾會回傳空白回應，導致處理邏輯出現問題。
• 錯誤處理：管理 HTTP 錯誤對於防止應用程式崩潰或資料不一致至關重要。

3. 使用 JAX-RS 用戶端

為了有效地使用 JAX-RS 中的回應主體，我們需要設定一個 JAX-RS 用戶端。在這個例子中，我們將使用 Jersey 作為實現，並使用 Jackson 進行 JSON 處理。

3.1. Maven 依賴項

首先，讓我們確保我們的pom.xml檔案中具有所需的Jersey 依賴項：

<dependency>

 <groupId>org.glassfish.jersey.core</groupId>

 <artifactId>jersey-client</artifactId>

 <version>3.0.4</version>

 </dependency>

 <dependency>

 <groupId>org.glassfish.jersey.media</groupId>

 <artifactId>jersey-media-json-jackson</artifactId>

 <version>3.0.4</version>

 </dependency>

3.2.建立基本 JAX-RS 用戶端

讓我們來看一個發送 POST 請求並讀取回應的範例：

public class GenericRestResponse {

 private final Logger logger;

 private final Client client;



 public GenericRestResponse(Client client, Logger logger) {

 this.client = client;

 this.logger = logger;

 }



 public GenericRestResponse() {

 this(ClientBuilder.newClient(), LoggerFactory.getLogger(GenericRestResponse.class));

 }



 public void sendRequest(String url, String jsonPayload) {

 WebTarget target = client.target(url);

 Response response = target.request(MediaType.APPLICATION_JSON)

 .post(Entity.entity(jsonPayload, MediaType.APPLICATION_JSON));



 try {

 if (response.getStatus() == Response.Status.OK.getStatusCode()) {

 String responseBody = response.readEntity(String.class);

 logger.info("Response Body: " + responseBody);

 } else {

 logger.error("Failed to get a successful response");

 }

 } catch (RuntimeException e) {

 logger.error("Error processing response", e);

 } finally {

 response.close();

 client.close();

 }

 }

 }

本範例示範如何建立完整的API互動工作流程。我們首先設定 REST 客戶端，其中Client和WebTarget物件用於定義 API 端點。

接下來，我們透過建立將在 POST 請求中傳送的 JSON 結構來準備請求負載。

這個過程繼續進行實際的 POST 請求，包括將準備好的有效負載傳送到伺服器並擷取回應。一旦我們收到回應，我們將透過檢查狀態是否為 HTTP 200 OK 來處理它，然後我們提取並列印回應主體。

最後，我們透過關閉Response和Client物件來實現適當的資源管理，以確保高效的資源利用並防止記憶體洩漏。

4.處理不同的內容類型

在大多數 Web 應用程式中，我們主要處理 JSON 和 XML 回應。讓我們看看如何處理這些不同的內容類型。

4.1. JSON 回應

對於 JSON 回應，讓我們看看如何使用 Jackson（一個使解析變得簡單的函式庫）來解析它們：

public class JsonResponse {

 private final Logger logger;

 private final Client client;

 private final String baseUrl;



 public JsonResponse(Client client, Logger logger, String baseUrl) {

 this.client = client;

 this.logger = logger;

 this.baseUrl = baseUrl;

 }



 public User fetchUserData(int userId) {

 WebTarget target = client.target(baseUrl);

 String jsonPayload = String.format("{\"id\":%d}", userId);



 try (Response response = target.request(MediaType.APPLICATION_JSON)

 .post(Entity.entity(jsonPayload, MediaType.APPLICATION_JSON))) {



 if (response.getStatus() == Response.Status.OK.getStatusCode()) {

 return response.readEntity(User.class);

 } else {

 logger.error("Failed to get user data. Status: {}", response.getStatus());

 return null;

 }

 } catch (Exception e) {

 logger.error("Error processing user data", e);

 return null;

 }

 }

 }

此處發送了一個帶有 JSON 有效負載的 POST 請求。使用readEntity()方法將回應主體解析為User物件。此方法將回應內容直接讀取並反序列化到指定的類別（ User ）中，以方便處理。我們必須確保User類別被正確註釋，以便 JSON 映射與 Jackson 無縫協作。

4.2. XML 回應

對於 XML 回應，JAXB 是一個可靠的選擇：

public class XMLResponse {

 private final Logger logger;

 private final Client client;

 private final String baseUrl;



 public XMLResponse(Client client, Logger logger, String baseUrl) {

 this.client = client;

 this.logger = logger;

 this.baseUrl = baseUrl;

 }



 public Product fetchProductData(int productId) {

 WebTarget target = client.target(baseUrl);

 String xmlPayload = String.format("%d", productId);



 try (Response response = target.request(MediaType.APPLICATION_XML)

 .post(Entity.entity(xmlPayload, MediaType.APPLICATION_XML))) {



 if (response.getStatus() == Response.Status.OK.getStatusCode()) {

 JAXBContext jaxbContext = JAXBContext.newInstance(Product.class);

 Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();

 return (Product) unmarshaller.unmarshal(response.readEntity(InputStream.class));

 } else {

 logger.error("Failed to get product data. Status: {}", response.getStatus());

 return null;

 }

 } catch (JAXBException e) {

 logger.error("Error unmarshalling product data", e);

 return null;

 } catch (Exception e) {

 logger.error("Error processing product data", e);

 return null;

 }

 }

 }

在此範例中，我們將 XML 有效負載作為 POST 請求傳送。 readEntity()方法將回應提取為InputStream ，然後 JAXB 的Unmarshaller類別將其反序列化為Product物件。為了確保正確的 XML 映射，我們必須使用 JAXB 註解（ @XmlRootElement 、 @XmlElement等）對Product類別進行註解。

5. 錯誤處理與回應狀態

在管理 HTTP 回應時，有效的錯誤處理至關重要。在閱讀正文之前，我們應該始終驗證回應狀態：

if (response.getStatus() != 200) {

 logger.error("Error: " + response.getStatus());

 }

實施適當的日誌記錄實踐對於確保有效調試和監控 API 互動至關重要。這有助於我們追蹤請求-回應流，識別錯誤並提高系統可觀察性。

6.最佳實務與先進技術

讓我們看看使用 JAX-RS API 發送或接收請求時的一些最佳實踐：

• 優化效能：我們使用連線池來減少延遲並有效管理資源。
• 確保安全：我們透過身份驗證、加密和資料驗證機制來保護 API 互動的安全。
• 可擴展性規劃：我們應該設計客戶端來優雅地處理增加的流量。

對於複雜的場景，我們應該考慮實作自訂訊息正文閱讀器。這些對於處理自訂回應類型或處理大型資料集很有用。此外，非同步處理增強了回應能力，特別是對於長時間運行的請求或串流資料。

• 自訂訊息正文讀取器：自訂訊息正文讀取器允許我們定義如何從 HTTP 回應中反序列化特定/自訂資料類型，從而對解析過程提供精細的控制。
• 非同步處理：非同步處理是 JAX-RS 的功能，可提高效能，特別是在處理長時間運行的請求或串流資料時。

7. 結論

在本文中，我們了解如何有效處理 HTTP 回應並使用 JAX-RS 用戶端 API 和最佳實踐建立 RESTful 應用程式。之後，我們探討了一些進階主題，例如自訂訊息正文閱讀器或非同步處理以提高效能。

與往常一樣，本文的完整原始碼位於 GitHub 上。