Web 服務精靈可協助您從現有的 WSDL 文件建立架構 Bean。架構 Bean 包含一組方法,對應於 WSDL 文件中說明的作業。當建立 Bean 時,每個方法都有一項任意實作,您可編輯 Bean 來取代它。
開始之前
必要條件:
- 如果您使用 WebSphere® Application Server,強烈建議您在執行 Web 服務精靈之前先啟動伺服器,因為啟動 WebSphere Application Server 可能需要花費數分鐘,視電腦的速度而定。
如果要啟動伺服器,請在「伺服器」視圖中選取它(視窗 > 顯示視圖 > 伺服器),然後按一下滑鼠右鍵選取啟動。
- 建立或探索 WSDL 文件並匯入至專案。
您只能使用含有 service 元素的 WSDL 檔。
註: SOAP over JMS Web 服務支援 WebSphere Application Server 8.0 版或更新版本;但不支援
WebSphere Application Server Liberty。如果您要使用 SOAP over JMS,WSDL 檔必須使用下列其中一個傳輸屬性 URI 值:
- http://www.w3.org/TR/soapjms/
- http://www.w3.org/2010/soapjms/
如需 WSDL 檔中的 SOAP over JMS 宣告的相關資訊,請參閱規格:
SOAP over Java™ Message Service 1.0:工作草案
- 建立 EJB 專案並新增至新的 EAR 專案。
- 建立空的 Web 專案(如果使用 SOAP over HTTP 作為傳輸方法)或 EJB 專案(如果使用 SOAP over JMS 作為傳輸方法)當作路由器專案。您建立的專案必須新增至與包含 Enterprise Bean 的 EJB 專案相同的 EAR。如需路由器模組的相關資訊,請參閱建立路由器模組。
- 如果要使用 SOAP over JMS,您必須為 JMS 建立伺服器及伺服器配置,如建立 SOAP over JMS 的伺服器及伺服器配置。
關於這項作業
如果要使用 WebSphere JAX-WS 執行時期環境從 WSDL 文件建立架構 Java Bean,請執行下列動作:
程序
- 切換至 Java EE 視景(視窗 > 開啟視景 > Java EE)。
- 在「企業瀏覽器」視圖中,選取您已建立或匯入的 WSDL 檔。
- 按一下檔案 > 新建 > 其他。選取 Web 服務,以顯示各種 Web 服務精靈。選取 Web 服務精靈。按下一步。
- 「Web 服務」頁面:選取由上而下 EJB Web 服務作為 Web 服務類型。您也可以選擇執行下列動作:
- 使用滑塊選取您要完成的 Web 服務開發階段。這會在剩餘的精靈畫面上設定數個預設值:
- 開發:這會開發 Web 服務的 WSDL 定義及實作。其中包括建立模組之類的作業,在適當情況下,模組將包含產生的程式碼、WSDL 檔、部署描述子及 Java 檔。
- 組合:這會確保當目標應用程式伺服器有需要時,負責管理 Web 服務或用戶端的專案會與 EAR 相關聯。
- 部署:這會建立服務的部署程式碼。
- 安裝:這會在目標伺服器上安裝及配置 Web 模組和 EAR。需要對 WSDL 檔的端點所做的任何變更都在此階段中完成。
- 啟動:這會在服務安裝於伺服器之後啟動伺服器。
- 測試:這會提供各種選項來測試服務,例如使用「通用服務用戶端」、「Web 服務瀏覽器」或範例 JSP。
- 選取伺服器:畫面上會顯示預設伺服器。如果您要將服務部署到不同的伺服器,請按一下伺服器鏈結並指定另一部伺服器。
- 選取執行時期:畫面上會顯示預設執行時期。如果要將服務部署到 IBM® JAX-WS 執行時期,請按一下執行時期鏈結,並在開啟的視窗中選取它。
此作業支援下列伺服器執行時期環境:
- WebSphere Application Server 7.0 版或更新版本
- WebSphere Application Server Liberty 8.5.5 版
- 選取服務專案:畫面上會顯示工作區中選取的專案。僅支援 EJB 專案。如果要選取不同的專案和 EAR,請按一下專案鏈結或輸入名稱,讓精靈會為您建立專案。 請確定選為「用戶端 Web 專案」的專案與「服務 Web 專案」不同,否則,用戶端產生的構件會改寫服務。對於 JAX-WS Web 服務,伺服器和用戶端專案可以共用相同的 EAR。
- 如果您要建立用戶端,請選取要產生的 Proxy 類型,並對用戶端重複這些步驟。 稍後可以使用使用 IBM WebSphere JAX-WS 執行時期環境從 WSDL 文件產生 Web 服務用戶端中概述的步驟建立用戶端
- 監視 Web 服務:這會透過 TCP/IP 監視器傳送 Web 服務資料流量,讓您能夠監看 Web 服務所產生的 SOAP 資料流量,並測試此資料流量是否符合 WS-I 標準。另外,您也可以手動設定 TCP/IP 監視器,如使用 TCP/IP 監視器來測試 Web 服務所述。
- 發佈 Web 服務。
- 「WebSphere JAX-WS 由上而下 EJB Web 服務配置」頁面:
- 輸出資料夾:輸入將於其中產生 EJB 架構的位置,或接受預設值。
- 目標套件:輸入產生的 Java 的套件名稱,或接受預設值。
- EJB Web 服務連結:選擇 Web 服務是否使用 HTTP 或 JMS 連結。
- 啟用封套樣式:啟用從 WSDL 至 Java 的封套樣式對映。對於實作 document/literal 封套型樣的 WSDL 文件,在 XML 綱目中會宣告一個根元素,並利用它來作為訊息流程的作業封套。
要求和回應都有各自的封套元素定義。簡單說,就是與作業(封套元素)同名的元素會分開,以使其每個內容元素都變成所產生之 Java 方法簽章的參數。
- 啟用 MTOM 支援:如果您選取此勾選框,則會啟用「SOAP 訊息傳輸最佳化機制」,將二進位內容的傳輸最佳化。如需 MTOM 的相關資訊,請參閱:MTOM 概觀
- 要產生的 JAX-WS 程式碼版本:WebSphere Application Server 傳統版 7.0 版,支援符合 JAX-WS 2.0 或 2.1 標準的程式碼。WebSphere Application
Server 傳統版 8.0 版、8.5 版和 WebSphere Application Server Liberty 8.5.5 版支援符合 JAX-WS 2.0、2.1 或 2.2 標準的程式碼。
- 將 WSDL 複製到專案:選取此選項將 WSDL 檔複製到服務專案,否則將在需要時由執行時期動態產生必要的 WSDL。如果您打算稍後建立用戶端或為其他使用者發佈 WSDL,這是很方便的選項。
- 產生可序列化 JAXB 類別:在 WebSphere Application Server 傳統版和 WebSphere Application Server Liberty 8.5.5 版中,
當您啟用 Java 6 資料類型,
您可以選擇產生會實作 java.io.Serializable 的 JAXB 類別。未實作此介面的類別不會將其任何狀態序列化或解除序列化。
- 指定 JAX-WS 或 JAXB 連結檔:如果您已建立 JAX-WS 或 JAXB 自訂連結檔,請選取這個勾選框,以利用它們來建立這項 Web 服務。
如果選取此選項,精靈的下一頁可讓您瀏覽至自訂連結宣告檔。
- 自訂服務實作類別名稱:如果您要變更預設埠名稱至服務實作類別名稱的對映,請選取此勾選框。
- 產生綱目程式庫:這可讓您產生綱目程式碼來加入至綱目程式庫。如果您選取綱目程式庫,在後續一個頁面上,您可以自訂 XSD 文件或 XSD 文件群組與專案之間的對映。
- 產生 Web 服務部署描述子:就 JAX-WS Web 服務而言,部署資訊是由執行時期動態產生;不再需要靜態部署描述子。選取這個勾選框將會產生部署描述子。
- 容許供應商延伸:如果您選取此勾選框,-extension 選項會新增至 wsgen 或 wsimport 指令。
-extension 選項指定是否對 JAX-WS 規格未指定的功能啟用或接受自訂延伸。
使用延伸會導致應用程式不可攜,或不能與其他實作交互操作。
如需詳細資料,請參閱 WebSphere Application Server 資訊中心的 JAX-WS 應用程式的 wsgen 指令及 JAX-WS 應用程式的 wsimport 指令主題。
- 視前一頁所選擇的選項而定,下列頁面可能會提示您自訂 Web 服務實作:
- 「WebSphere JAX-WS JMS 連結配置」頁面:如果您選擇使用 JMS 作為 Web 服務的傳輸方法,您需要在此頁面輸入連結的相關資訊。
- JMS 目的地:選取佇列或主題作為目的地類型。
- 目的地 JNDI 名稱:目的地佇列或主題的 JNDI 名稱。
- JMS Connection Factory:Connection Factory 的 JNDI 名稱。
- 起始環境定義 Factory 名稱:要使用的起始環境定義 Factory 的名稱。這會對映至 java.naming.factory.initial 內容。
- JNDI 提供者 URL:這會對映至 java.naming.provider.url 內容。
- 遞送模式:指出要求訊息是否應該為持續性。
- 要求訊息生命期限:要求訊息的生命期限(毫秒)。值 0 表示生命期限無限。
- JMS 要求訊息優先順序:與要求訊息相關聯的 JMS 優先順序。0 為最低優先順序,9 為最高優先順序。
- 回覆名稱:要求分派到的埠元件名稱。
- Connection Factory 使用者 ID:用來存取 Connection Factory 的使用者 ID。
- Connection Factory 密碼:用來存取 Connection Factory 的密碼。
- 使用 SOAP/JMS 交互作業能力通訊協定:選取此選項可確保 Web 服務符合「W3C SOAP-JMS 連結工作小組」所提出的通訊協定。如需相關資訊,請參閱此網站:SOAP-JMS 連結工作小組憲章
- 定義自訂 JMS 內容:選取此選項會開啟頁面讓您輸入內容值配對。
- 「自訂連結宣告」頁面:如果您選擇指定 JAX-WS 或 JAXB 連結檔,您可以在此頁面瀏覽至檔案。
- 「服務實作配置」頁面:對於 WSDL 檔中定義的每一個埠,您可以輸入服務實作類別的名稱,或接受預設值。
- 「綱目專案配置」頁面:如果您選擇產生綱目程式庫,請利用這個頁面來自訂 XSD 文件與專案之間的對映。只有當所有綱目相依關係都在不同的 targetNamespaces 中時,此特性才有作用;否則,ObjectFactory.java 中會發生編譯錯誤。
- 「WebSphere JAX-WS 路由器專案配置」頁面: 當目標設為 WebSphere Application Server 執行時期環境,而不是 WebSphere Application Server Liberty 8.5.5 版時,將會顯示此頁面。
- HTTP 路由器:輸入要作為路由器模組的專案名稱。路由器模組提供特定傳輸的 Web 服務端點。
- JMS 路由器:輸入要作為路由器模組的專案名稱。路由器模組提供特定傳輸的 Web 服務端點。
- MDB 部署機制:選取 JMS 啟動規格或接聽器埠作為訊息驅動 Bean 部署機制。
- ActivationSpec JNDI 名稱:輸入用來部署此訊息驅動 Bean 的啟動規格的 JNDI 名稱。此名稱必須符合定義給 WebSphere Application Server 的啟動規格名稱。
- 接聽器輸入埠名稱:輸入路由器模組的接聽器埠名稱。
- 「測試 Web 服務」頁面:如果您選擇從步驟 4a 測試 Web 服務,請為產生的 Web 服務選取測試機能,然後按一下啟動。這會在「Web 服務瀏覽器」或「通用服務用戶端」中開啟 Web 服務。
請注意,如果 Web 服務使用 HTTP 傳輸,您只能使用「Web 服務瀏覽器」來測試。請選取您要測試的作業,輸入必要的資訊,然後按一下執行。結果會顯示在「狀態」窗格中。按下一步。
- 「WebSphere JAX-WS Web 服務用戶端配置」頁面:如果您選擇產生用戶端,您可以在此頁面指定下列選項:
- 輸出資料夾:這是將產生用戶端程式碼的位置。
- 目標套件:Web 服務用戶端精靈會產生一些 Java 檔。
依預設會根據 WSDL 檔中指定的名稱空間來建立套件名稱。如果要置換此預設行為,您可以指定自己的套件名稱。
- 產生可攜式用戶端:選取這個勾選框,可讓您在各機器之間或各 WebSphere Application Server 或 WebSphere Application Server Liberty 8.5.5 版實例之間,移動您的 Web 服務用戶端程式碼。如果選取此選項,則會將 WSDL 文件及其依賴的所有 XML 綱目和其他 WSDL 文件,複製到用戶端專案的 WEB-INF/wsdl 下,然後將一個指向此副本的 file:relativeURL 注入 JAX-WS 服務類別的靜態起始設定區塊中。
- 為產生的用戶端啟用非同步呼叫:如果選擇啟用非同步用戶端,則會對 Web 服務中的每一個方法再多建立兩個方法。
這些是輪詢和回呼方法,可讓用戶端以非同步方式運作。
- 指定 JAX-WS 或 JAXB 連結檔:如果您已建立 JAX-WS 或 JAXB 自訂連結檔,請選取此勾選框,以利用它們建立 Web 服務用戶端。
如果選取此選項,精靈的下一頁可讓您瀏覽至自訂連結宣告檔。
- 自訂用戶端 Proxy 類別名稱:如果您要變更預設埠名稱至服務實作類別名稱的對映,請選取此勾選框
- 產生 Web 服務部署描述子:就 JAX-WS Web 服務而言,部署資訊是由執行時期動態產生;不再需要靜態部署描述子。選取這個勾選框將會產生部署描述子。
- 要產生的 JAX-WS 程式碼版本:對於 WebSphere Application Server 7.0 版,您可以選擇產生符合 JAX-WS 2.0 或 2.1 標準的程式碼。對於 WebSphere Application Server
8.0 版、8.5 版及 WebSphere Application Server Liberty 8.5.5 版,您可以選擇產生符合 JAX-WS 2.0、2.1 或 2.2 標準的程式碼。
- 「自訂連結宣告」頁面:如果您選擇指定 JAX-WS 或 JAXB 連結檔,您可以在此頁面瀏覽至檔案。
- 「服務實作配置」頁面:「Proxy 產生配置」頁面:對於每一個定義的埠,您可以輸入 Proxy 類別的名稱,或接受預設值。
- 「Web 服務用戶端測試」頁面:
- 測試產生的 Proxy:如果選取此選項,Web 瀏覽器中會啟動範例用戶端,讓您測試功能。
- 選取測試機能。您可以在「通用服務用戶端」或「Web 服務瀏覽器」中測試產生的 Proxy,也可以產生並使用範例 JAX-WS 2.0 JSP。
- 資料夾:如果您選擇透過 JSP 測試 Proxy,您可以選取 JSP 所在的資料夾,也可以選取 JSP 中包含的方法。
- 方法:選取要公開的方法。如果您選擇啟用非同步呼叫,則應該也會列出非同步方法。
- 在伺服器執行測試:這會自動啟動伺服器。
結果
建立 Web 服務之後,視您選取的選項而定,可能會有下列情形:
- Java 編輯器中會開啟實作 Bean。這包含架構程式碼,可用來測試 Web 服務的基本功能,或者,您可以在測試服務之前實作所需的商業邏輯。
- 如果您選擇使用 JAX-WS 2.0 JSP 來測試產生的 Proxy,Web 瀏覽器中會在下列 URL 啟動 Proxy:http://localhost:port/WebProjectClient/sampleBeanName/WebServiceName/TestClient.jsp
您可以使用此範例應用程式選取方法、輸入方法的值,然後按一下呼叫,以測試 Web 服務。
方法的結果會顯示在「結果」窗格中。由於這是使用任意方法實作的 Java Bean 架構,傳回的值為 -3。
- 如果您選擇使用「通用測試用戶端」來測試產生的 Proxy,瀏覽器視窗中會使用與下列相似的 URL 啟動它:http://localhost:port/UTC/preload?object=BeanPackage.BeanServiceProxy。
在「物件」下,展開 Proxy stub 來顯示 Web 服務的方法。按一下您要測試的方法,在「參數」窗格中輸入值,然後按一下呼叫。將產生結果。
- 如果您選擇使用「Web 服務瀏覽器」來測試 Web 服務,則會開啟瀏覽器。請選取您要測試的作業,輸入必要的資訊,然後按一下執行。結果會顯示在「狀態」窗格中。