建立 JAX-RS Web 服務

開始之前

您需要有已安裝並啟動 Java™ 5.0 或更新版本 JVM 支援的伺服器,才能部署 Web 服務。這包括:
  • WebSphere® Application Server 7.0 版或 8.0 版,選取以安裝 Feature Pack for Web 2.0 AND MOBILE 及 WebSphere Application Server 開發工具
依預設,在安裝 WebSphere Application Server 時,會為您建立一部伺服器。您可以在「伺服器」視圖中看到這部伺服器。

如果選擇部署至 WebSphere Application Server 之外的伺服器,則無法使用 IBM® JAX-RS 程式庫,必須透過「專案資料類型 > JAX-RS」喜好設定頁面,安裝並配置您自己的 JAX-RS 程式庫。

如需在 WebSphere Application Server 上使用 JAX-RS Web 服務的詳細資訊,請參閱:WebSphere Application Server 資訊中心

建立啟用 JAX-RS 的 Web 專案

關於這項作業

JAX-RS Web 服務必須位於已啟用 JAX-RS 資料類型的專案中。
限制: [Liberty]如果要使用 JAX-RS 2.0 API, 請建立「使用者檔案庫」,並新增 com.ibm.ws.javaee.jaxrs.2.0_1.0.0.jar(位於 Liberty 執行時期的 dev/api/spec 資料夾中)。在專案的 Java 建置路徑中, 將這個「使用者檔案庫」移至 Liberty 伺服器類別路徑儲存器之前。

[WebSphere Application Server 傳統版] WebSphere Application Server 傳統版第 9 版支援 JAX-RS 1.1 和 2.0。您在專案中使用的 JAX-RS 版本, 必須符合您在 WebSphere Application Server 傳統版第 9 版安裝架構中使用的 JAX-RS 版本。如果這些版本不符合, 在您將專案部署到伺服器時,工具會顯示警告。如果您建立 JAX-RS 專案時,沒有指定資料類型層次, 依預設,工具會使用 JAX-RS 2.0。

[WebSphere Application Server 傳統版]將 JAX-RS 1.1 模組新增到 Web 專案時,工具會將下列檔案新增到類別路徑儲存器中:
com.ibm.ws.jaxrs.jar
com.ibm.ws.prereq.jaxrs.jar
javax.j2ee.jaxrs.jar
[WebSphere Application Server 傳統版]將 JAX-RS 2.0 模組新增到 Web 專案時,工具會將下列檔案新增到類別路徑儲存器中:
com.ibm.ws.jaxrs20.jar
com.ibm.ws.prereq.jaxrs20.jar
javax.ws.rs-api-2.0.jar

程序

  1. 在 Java EE 視景中,用滑鼠右鍵按一下企業應用程式專案,並選取新建 > Web 專案,以開啟 Web 專案精靈。
  2. 在名稱欄位中,輸入新 Web 專案的名稱。
  3. 在「專案範本」區段中,選取您要使用的 Web 範本類型:選取簡式,以建立簡式 Web 專案。
  4. 在「程式設計模型」區段中,選取您要使用的程式設計模型:選取 Java EE 程式設計模型。按下一步,以配置新的 Web 專案。
  5. 在部署頁面上,從可用的配置選項清單中,按一下部署以開啟「部署配置」頁面。
    • 您可以從下拉方框中選取另一個目標執行時期,來變更目標執行時期。按一下變更特性,以開啟「專案資料類型」視窗。在「專案資料類型」頁面上,選取 JAX-RS(REST Web 服務),然後按一下確定。
    • 按一下新增 WebSphere 連結及延伸的支援,或者清除此欄位。
    • 在 Web 模組版本欄位中,選取您要使用的 Web 模組版本。
    • 在 EAR 成員資格欄位中,如果您要包括 EAR 成員資格,按一下將專案新增至 EAR;如果您不想將 Web 專案新增至 EAR 檔,則清除此欄位。
    • EAR 專案名稱欄位會出現存在的 EAR 檔名稱。您可以按一下瀏覽,以選取不同的 EAR 檔。
    註: 如果您為新的 Web 專案選取「僅用戶端」程式設計模型,則無法使用此部署選項。
  6. 從可用的配置選項清單中,按一下 REST 服務。
    1. 在 JAX-RS 實作程式庫欄位中,選取適用於您的伺服器版本的程式庫,例如 IBM WebSphere Application Server 8.0 版 JAX-RS 程式庫或 IBM WebSphere Application Server 8.5 版 JAX-RS 程式庫。
      進一步瞭解程式庫: 您已安裝的每一個 WebSphere Test Environment 的 JAX-RS 程式庫會列在此下拉方框中。如果您想要使用非 WebSphere 程式庫,可利用「使用者程式庫」喜好設定頁面來匯入該程式庫。如果選取「使用者程式庫」,則可以啟動「使用者程式庫」喜好設定頁面並新增程式庫。在建立專案之後,如果要變更程式庫,您可以用滑鼠右鍵按一下專案,然後選取喜好設定 > 專案資料類型 > JAX-RS。您還可以選取不讓精靈為您配置程式庫,在這種情況下,您必須手動配置類別路徑。
    2. 如果使用的 WebSphere Application Server 版本低於第 8 版,請勾選程式庫會隨這個應用程式一起併入,並選擇將程式庫併入為共用程式庫。這會將 JAX-RS JAR 新增至類別路徑,以及在加強型 EAR 中新增「共用程式庫」項目。
    3. 依預設會選取更新部署描述子,因為您將需要使用 web.xml 來配置安全限制及其他行為。即使您稍早在精靈中已選擇不產生部署描述子,也會產生 web.xml,並以 JAX-RS Servlet 資訊更新。只有在選取的「Web 模組」資料類型是 3.0 版或更高版本時,才能使用此選項。
    4. 如果您已選擇更新部署描述子,則能夠變更 Servlet 名稱及 Servlet 類別名稱,以及變更 URL 對映型樣。
  7. 從可用的配置選項清單中,按一下 Java 以開啟 Java 配置頁面。
    • 在建置路徑上的來源資料夾欄位中,接受 src 預設目錄,或按一下新增資料夾、編輯... 或移除,為原始檔指定資料夾。
    • 在預設輸出資料夾:欄位中,指定輸出檔的資料夾,或是接受預設值 (WebContent\WEB-INF\classes)。
  8. 從可用的配置選項清單中,按一下 Web 模組。在「Web 模組配置」頁面上:
    • 在環境定義根目錄欄位中,輸入 Web 專案根目錄的名稱,或接受預設值(這是 Web 專案的名稱)。
    • 在內容目錄欄位中,輸入內容目錄的名稱,或接受預設值 (WebContent)。
    • 如果您想建立部署描述子,請選取產生 web.xml 部署描述子。您也可以稍後將部署描述子新增至 Web 模組。
  9. 按一下完成。

建立 JAX-RS Web 服務

程序

  1. 在 Web 專案中,建立套件(用滑鼠右鍵按一下 Java 資源 > 來源,然後選取新建 > 套件)。將 Web 服務的類別匯入套件中。
  2. 開啟 WebContent/WEB-INF/web.xml。在「設計」視圖中,選取 Servlet JAX-RS Servlet,然後按一下新增,並將「起始設定」參數新增至 JAX-RS Servlet,名稱及值欄位則保留空白。儲存 web.xml,並忽略可能顯示的任何錯誤。
  3. 在「標記」視圖中,選取關於 param-name 的 web.xml 錯誤,按一下滑鼠右鍵選取「快速修正程式」。瀏覽至應用程式並選取。
  4. 將包含 JAX-RS 專案的 EAR 新增至伺服器,然後啟動伺服器。

結果

每個 Web 應用程式都必須有環境定義根目錄,才能成功部署 Web 應用程式。在應用程式組合或應用程式部署期間,應用程式部署描述子中會定義每一個 Web 模組的環境定義根目錄。環境定義根目錄會結合 WAR 檔中已定義的 Servlet 對映,編寫完整的 URL,供使用者輸入以存取 Servlet。 每一個已部署的 Web 應用程式的環境定義根目錄在伺服器上都必須是唯一的。環境定義根目錄也可以是空的。

比方說,如果 Web 應用程式使用 sample/application/ 作為環境定義根目錄,則 Web 應用程式要求 URL 的開頭為 http://<hostname>:<port>/sample/application/。Servlet 的 URL 型樣會附加到 Web 應用程式的環境定義根目錄之後。比方說,如果環境定義根目錄是 sample/application/,且 Servlet URL 對映是 rest/api/*,則 JAX-RS Web 應用程式的基本 URI 是 http://<hostname>:<port>/sample/application/rest/api。

編輯 JAX-RS 專案

在建立 JAX-RS Web 服務之後,如果要對它進行編輯,可以用滑鼠右鍵按一下專案,然後選取內容 > 專案資料類型 > JAX-RS。從這個頁面中,您可以變更:
  • 程式庫類型
  • JAX-RS Servlet 名稱
  • JAX-RS Servlet 類別名稱
  • URL 對映型樣
比方說,如果將專案移轉至不同的伺服器,則可以將程式庫提供者變更為新伺服器支援的提供者。
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: tjaxrswebservcreate.html