產生 JAX-RS 2.0 資源的範例用戶端程式碼

您可以從 REST 專案位址產生 Java™ API for RESTful Web Services (JAX-RS) 資源的範例用戶端程式碼。

開始之前

重要: 適用於 Liberty
在 WebSphere® Application Server Developer Tools for Eclipse 中完成下列設定:
  • 將 Liberty 執行時期新增至喜好設定。
  • 在「伺服器」視圖中建立 Liberty 伺服器。
  • 建立 Web 專案並在專案中定義一或多個 REST 服務。否則,若未定義任何服務,REST 節點就沒有子項。

程序

  1. 展開 your_REST_project > 服務 > REST。
  2. 用滑鼠右鍵按一下位址或其中一個子項,並選取產生 > JAX-RS 用戶端。 這時會顯示「JAX-RS 2.0 用戶端」對話框。
    1. 在來源資料夾欄位中接受預設值,或為產生的用戶端指定目的地資料夾。
    2. 在名稱欄位中接受預設值,或指定用戶端的 Java 類別名稱。
    3. 在套件欄位中接受預設值,或指定用戶端的 Java 套件名稱。
    4. 選取您要用來產生用戶端程式碼的資源。
    5. 產生新的過濾器類別。
      1. 選取產生 JAX-RS 用戶端過濾器。
      2. 接受預設值或指定過濾器類別的名稱。

      此選項會建立一個基本型類別,此類別實作 JAX-RS 2.0 javax.ws.rs.client 套件中的 ClientRequestFilter 和 ClientResponseFilter 介面。在產生新的過濾器類別之後,您可以完成介面方法的實作細節。

  3. 選擇性的: 如果要在相同的專案中產生 JAXB 類別和用戶端,請選取使用 XML 綱目來產生 JAXB。

    JAX-RS 服務的資源方法可能有 JAXB 類別作為方法引數或傳回類型。如果您沒有 JAXB 原始檔,但有 XML 綱目,您可以產生 JAXB 類別供用戶端程式碼存取。

    1. 按下一步。

      這時會顯示「JAX-RS 用戶端與 JAXB」對話框。

    2. 選擇性的: 在 JAXB 目標 Java 套件欄位中,提供您要用於 JAXB 產生的類別的 Java 套件。

      此值會透過 -p 選項來傳給連結編譯器或 Java Architecture for XML Binding Compiler (XJC) 工具。

    3. 按一下瀏覽...,以瀏覽至您要用來產生 JAXB 類別的 XSD 檔案。

      您也可以在 XML 綱目中輸入 XSD 檔案。此值會透過 -b 選項來傳給連結編譯器或 XJC 工具。

    4. 選擇性的: 如果要提供使用者定義的 JAXB 連結檔,請選取指定 JAXB 連結檔。

      如果您選取此選項,您可以按一下新增,以新增自訂連結宣告檔案。您也可以強調顯示檔案,然後選取移除,以移除檔案。

    5. 選擇性的: 如果要容許供應商延伸,請選取容許供應商延伸。

      處理某些 XML 綱目文件時,可能需要此選項。此值會透過 -extension 選項來傳給連結編譯器或 XJC 工具。

  4. 按一下完成。

結果

您已產生 JAX-RS 資源的範例用戶端程式碼。

如果您完成選用的步驟來產生 JAXB 類別,則在與 JAX-RS 用戶端相同的專案中也已產生 JAXB 類別。

使用可用來存取 JAX-RS 服務的 JAX-RS 2.0 用戶端 API 也可讓您產生新的 Java 類別檔。 JAX-RS 服務的每個註解方法都有對應的 JAX-RS 用戶端方法,此方法是從 JAX-RS 服務方法上的註釋產生。 JAX-RS 服務方法包括 @PathParam、@QueryParam、@Consumes、@Produces、@Path,以及資源方法,例如 @GET、@PUT 或 @POST。

限制: JAX-RS 用戶端產生演算法所影響的所有類別都必須遵守下列限制:
  • 這些類別必須是以 Java Architecture for XML Binding (JAXB) 標註的字串、基本元素、JAX-RS API 類別或使用者類別。這些類別不能是二進位。
  • 所有類別必須是原始格式,才能讓演算法找到。如果類別不是在與 JAX-RS 服務相同的專案中,則無法產生 JAX-RS 用戶端。

下一步

在範例中新增程式碼,讓用戶端程式碼可運作並符合您的 JAX-RS 2.0 用戶端程式碼需求。 如果要測試範例,請在 JSP 或 Servlet 中新增用戶端程式碼。用戶端程式碼必須在 Servlet 儲存器中,因為不支援獨立式 Java 應用程式。有了可運作的 JAX-RS 2.0 用戶端程式碼之後,請使用該用戶端程式碼來啟動 JAX-RS 2.0 服務。
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_jaxrs_scc_jaxrs.html