用來建立 Web 服務的註釋概觀

您可以在 Java™ 程式碼中使用註釋,來建立 Web 服務。註釋指定 Web 服務實作相關聯的 meta 資料。

Java API for XML-Based Web Services (JAX-WS) 程式設計標準有賴於註釋來簡化 Web 服務的開發。註釋說明 Web 服務的兩個層面: 如何以 Web 服務形式來存取伺服器端服務實作,以及用戶端 Java 類別如何存取 Web 服務。

JAX-WS 程式設計標準支援標註含有 meta 資料的 Java 類別,此 meta 資料用來將服務端點應用程式定義成 Web 服務,以及用來指定用戶端如何存取服務。JAX-WS 標準支援使用註釋,且這些註釋以一些「Java 規格要求 (JSR)」為基礎:
  • Java 程式設計語言 meta 資料機能 (JSR 175)
  • Java 平台 Web 服務 meta 資料 (JSR 181)
  • Java API for XML-Based Web Services (JAX-WS) 2.0 (JSR 224)
  • Java 平台共用註釋 (JSR 250)
利用 JSR 181 標準中的註釋,您可以標註服務實作類別或服務介面。然後您可以使用精靈或將應用程式發佈至伺服器,來產生 Web 服務。同時在 Java 原始碼和 Java 類別內使用註釋,可簡化 Web 服務的開發。如果您依這種方式來使用註釋,它會定義更多的資訊,而這些資訊通常取自部署描述子檔案、Web 服務說明語言 (WSDL) 檔案,或是 XML 和 WSDL 中之 meta 資料至原始檔構件的對映。

您可以利用註釋,來配置連結和處理程式鏈;以及設定 portType、服務與其他 WSDL 參數的名稱。您也可以在建置時期使用註釋,將 Java 對映至 WSDL 和綱目,以及在執行時期控制 JAX-WS 執行時期如何處理和回應 Web 服務的呼叫。

產品會使用您透過 Web 服務用戶端精靈所建立之用戶端中的註釋。精靈會產生用戶端 Proxy,以及含有註釋的靜態服務類別。這些註釋指定用戶端如何存取 Web 服務。

如需您可以使用之註釋的詳細資訊,請參閱相關參照。

支援的註釋型 Web 服務實務

工具和 WebSphere® 執行時期環境支援下列 Web 服務實務:

表 1. 支援的執行時期環境. 註釋型 Web 服務實務支援的執行時期。
實務 執行時期環境 註解
由下而上 Java Bean WebSphere Application Server 7.0 版及更新版本 可單獨使用註釋或搭配 Web 服務精靈來完成。如果 Bean 已有 @javax.jws.WebService 註釋,精靈中有許多欄位會停用,因為精靈不需要為您產生委派 Bean。您只能選擇產生 WSDL 檔案。如果您只新增 @javax.jws.WebService 到您的 Java Bean,且希望啟用其他選項(例如 SOAP 1.2 連結或 MTOM),請結束精靈,然後看是移除該註釋,或使用註釋說明文件繼續建立 Web 服務。精靈不會讓您在已局部標註的既存 Bean 中附加新的註釋。
由下而上 EJB 2.x 無 無法透過註釋來支援
由下而上 EJB 3.0 WebSphere Application Server 7.0 版及更新版本 無法混合使用註釋和 Web 服務精靈。必須使用註釋,並將 EJB Bean 部署至應用程式伺服器。
結合發展 Java Bean WebSphere Application Server 7.0 版及更新版本 此實務可讓您使用 wsdlLocation 屬性,將 Web 服務中所標註的 Java Bean 對映至 WSDL 文件。
附註:如果您想使用 SOAP 1.2:
@javax.xml.ws.BindingType (value=javax.xml.ws.soap.SOAPBinding.SOAP12HTTP_BINDING) 
您必須指定 @WebService 註釋的 wsdlLocation 屬性,如下例所示:
@javax.jws.WebService (targetNamespace="http://p/", ..., wsdlLocation="WEB-INF/wsdl/EchoService.wsdl")
您無法使用 WebSphere Application Server 動態產生的 WSDL 檔案,但是必須事先建立一個 WSDL 檔案。或者,您可以使用 Web 服務精靈,當您從 Java Bean 產生 Web 服務時,如果您選擇使用 SOAP 1.2,此精靈會為您產生 WSDL 檔案。

如需相關資訊,請參閱:從 Java Bean 和 WSDL 檔建立 Web 服務。

結合發展 EJB 3.0 WebSphere Application Server 7.0 版及更新版本 此實務可讓您使用 wsdlLocation 屬性,將 Web 服務中所標註的 EJB Bean 對映至 WSDL 文件。

如需相關資訊,請參閱:從 EJB Bean 和 WSDL 檔案建立 Web 服務。

範例

舉例來說,您可以在 Java 原始檔中內含 @WebService 標籤,將 Bean 顯露成 Web 服務。
@WebService

public class QuoteBean implements StockQuote {

       public float getQuote(String sym) { ... }

}

@WebService 註釋是告知伺服器執行時期環境,將該 Bean 中的所有公用方法顯露成 Web 服務。您可以在個別的方法或參數中新增其他註釋,來控制更多的精細程度。使用註釋可讓您更輕鬆地將 Java 構件公開為 Web 服務。此外,當您使用某些由上而下的對映工具(從 WSDL 檔案啟動)來建立構件時,會將註釋包含在原始檔和 Java 類別內,藉此擷取 meta 資料以及原始檔。

Icon that indicates the type of topic Concept topic
Timestamp icon Last updated: last_date

File name: cwsandoc001.html