Java API for XML based Web Services
Java™ API for XML-based Web Services (JAX-WS)(又稱為 JSR-224)是新一代的 Web 服務程式設計模型,延伸 Java API for XML-based RPC (JAX-RPC) 程式設計模型所提供的基礎。 JAX-WS 使用動態 Proxy 和 Java 註釋,讓 Java 應用程式有更高的平台獨立性,簡化 Web 服務和用戶端的開發。 本產品包含的 Web 服務工具支援 JAX-WS 2.0、2.1 及 2.2。
JAX-WS 是新的程式設計模型,透過支援標準的註釋型模型來開發 Web 服務應用程式和用戶端,簡化應用程式開發。 JAX-WS 程式設計標準本身在策略上配合目前的產業趨勢,朝向更以文件為中心的傳訊模型發展,取代 JAX-RPC 定義的遠端程序呼叫程式設計模型。 儘管本產品仍支援 JAX-RPC 程式設計模型及應用程式,但 JAX-RPC 有一些限制,且不支援目前許多以文件為中心的服務。 JAX-WS 是開發 Web 服務的策略性程式設計模型,也是 Java EE 5 平台不可或缺的一部分。
- Java 應用程式有更高的平台獨立性
- 使用 JAX-WS API 讓 Java 應用程式有更高的平台獨立性,簡化 Web 服務和用戶端的開發。 JAX-WS 利用動態 Proxy,而 JAX-RPC 使用產生的 stub。動態 Proxy 用戶端會根據產生的或提供的「服務端點介面 (SEI)」來呼叫 Web 服務。 動態 Proxy 用戶端類似於 JAX-RPC 程式設計模型中的 stub 用戶端。 雖然 JAX-WS 動態 Proxy 用戶端和 JAX-RPC stub 用戶端都是基於從 WSDL 檔產生的「服務端點介面 (SEI)」,但有一項重大差異。 動態 Proxy 用戶端是在執行時期使用 Java 5 動態 Proxy 功能自動產生,而基於 JAX-RPC 的 stub 用戶端是工具產生的非可攜式 Java 檔。 不同於 JAX-RPC stub 用戶端,動態 Proxy 用戶端在供應商的不同應用程式伺服器上執行之前,並不需要重新產生 stub,因為產生的介面不需要特定的供應商資訊。 如需使用動態 Proxy 用戶端的相關資訊,請參閱 JAX-WS 2.0 規格第 4 章。
- 註釋
JAX-WS 引進支援以 meta 資料標註 Java 類別,以指出 Java 類別是 Web 服務。 JAX-WS 支援使用以 Java 程式設計語言 (JSR 175) 規格的「Meta 資料機能」為基礎的註釋、Java 平台 (JSR 181) 規格的 Web 服務 meta 資料,以及 JAX-WS 2.0 規格所定義的註釋。 在 Java 來源和 Java 類別中使用註釋可以簡化 Web 服務的開發,您可以定義一些額外的資訊,而這些資訊通常取自於部署描述子檔案、WSDL 檔,或將 XML 和 WSDL 檔的 meta 資料對映到來源構件。
例如,您可以在 Java 來源中內嵌一個簡單的 @WebService 標籤,將 Bean 公開為 Web 服務。
@WebService public class QuoteBean implements StockQuote { public float getQuote(String sym) { ... } }註釋 @WebService 向伺服器執行時期環境表示將這個 Bean 的所有公用方法公開為 Web 服務。 在個別的方法或參數上新增更多註釋可以控制更多精細層次。 使用註釋可讓您更輕鬆地將 Java 構件公開為 Web 服務。 此外,由於構件是透過一些由上而下的對映工具從 WSDL 檔開始建立,在程式碼和 Java 類別內併入註解,就能擷取 meta 資料及原始檔。
- 非同步呼叫 Web 服務
在 JAX-WS 中,可以同步和非同步地呼叫 Web 服務。非同步呼叫 Web 服務時,JAX-WS 新增支援輪詢機制與回呼機制。 在輪詢模型中,用戶端可以發出要求、取得回應物件,輪詢此物件以判定伺服器是否已回應。 伺服器回應時會擷取實際回應。使用輪詢模型,用戶端不必等待回應傳回,就可以繼續處理其他工作。 使用回呼模型,用戶端提供回呼處理常式來接受和處理入埠回應物件。 輪詢和回呼模型可讓用戶端專注於繼續處理工作,同時提供更動態和更有效率的模型來呼叫 Web 服務。
例如,Web 服務介面有方法可處理同步和非同步要求。
@WebService public interface CreditRatingService { // 同步作業 Score getCreditScore(Customer customer); // 非同步作業及輪詢 Response<Score> getCreditScoreAsync(Customer customer); // 非同步作業及回呼 Future<?> getCreditScoreAsync(Customer customer, AsyncHandler<Score> handler); }使用回呼機制的非同步呼叫需要由用戶端程式設計師提供額外輸入。 回呼處理常式是一個物件,其中包含擷取非同步回應時將執行的應用程式碼。 以下是非同步回呼處理常式的程式碼範例:
CreditRatingService svc = ...; Future<?> invocation = svc.getCreditScoreAsync(customerFred, new AsyncHandler<Score>() { public void handleResponse ( Response<Score> response) { Score score = response.get(); // 在這裡執行工作... } } );以下是非同步輪詢用戶端的程式碼範例:
CreditRatingService svc = ...; Response<Score> response = svc.getCreditScoreAsync(customerFred); while (!response.isDone()) { // 等待時執行一些工作 } // 因為使用通用類型,不需要強制轉型 Score score = response.get(); </Score>- 使用資源注入
JAX-WS 支援資源注入以進一步簡化 Web 服務的開發。 JAX-WS 使用 Java EE 5 的這項主要特性,將原本在 Java 執行時期環境中建立和起始設定一般資源的負載,從 Web 服務應用程式轉移到應用程式儲存器環境本身。 對於資源注入及其於執行時期環境中的應用程式生命週期,JAX-WS 提供支援 JSR-250 中定義的一個註釋子集。
應用程式伺服器也支援使用 @Resource 或 @WebServiceRef 註釋來宣告 JAX-WS 管理的用戶端,以及要求注入 JAX-WS 服務和埠。 在欄位或方法上使用這些註釋時會導致注入 JAX-WS 服務或埠實例。 使用這些註釋也會導致註釋所指定的類型連結到 JNDI 名稱空間。
@Resource 註釋由 Java Platform Enterprise Edition 5 (Java EE 5) 中包含的「JSR-250 共用註釋」規格所定義。 在服務端點實作類別內,您可以對 javax.xml.ws.WebServiceContext 類型的變數加上 @Resource 註釋,以要求資源注入及收集該特定端點呼叫相關的 javax.xml.ws.WebServiceContext 介面。 針對與特定方法呼叫相關聯的要求,您可以從 WebServiceContext 介面使用 getMessageContext() 方法來收集 MessageContext。
下列範例說明使用 @Resource 和 @WebServiceRef 註釋來注入資源:@WebService public class MyService { @Resource private WebServiceContext ctx; @Resource private SampleService svc; @WebServiceRef private SamplePort port; public String echo (String input) { … } }如需資源注入的相關資訊,請參閱 JAX-WS 規格第 5.2.1 節和第 5.3 節。
- JAXB 2.2 的資料連結
- JAX-WS 利用 JAXB API 和工具作為 Java 物件與 XML 文件之間對映時的連結技術。
JAX-WS 工具依賴 JAXB 工具作為 Java 物件與 XML 文件之間進行雙向對映時的預設資料連結。
JAXB 資料連結取代 JAX-RPC 規格所說明的資料連結。
WebSphere® Application Server 7.0 版支援 JAXB 2.1 規格。在資料連結方面,JAX-WS 2.1 需要 JAXB 2.1。JAXB 2.1 提供改良的編譯支援、@XMLSeeAlso 註釋的支援及完整的綱目 1.0 支援等加強功能。
WebSphere Application Server 8.0 版或更新版本及 WebSphere Application Server Liberty 8.5.5 版支援 JAXB 2.2 規格。 在資料連結方面,JAX-WS 2.2 需要 JAXB 2.2。JAXB 2.2 對其註釋已提供少數加強功能來改善綱目產生,並與 JAX-WS 更密切整合。
- 動態及靜態用戶端
- JAX-WS 的動態用戶端程式設計 API 稱為分派用戶端 (javax.xml.ws.Dispatch)。分派用戶端是 XML 傳訊導向的用戶端。
資料以 PAYLOAD 或 MESSAGE 模式來傳送。
使用 PAYLOAD 模式時,分派用戶端只負責提供 <soap:Body> 元素的內容,而 JAX-WS 會新增 <soap:Envelope> 和 <soap:Header> 元素。
使用 MESSAGE 模式時,分派用戶端負責提供整個 SOAP 封套,包括 <soap:Envelope>、<soap:Header> 及 <soap:Body> 元素,而 JAX-WS 不會對訊息新增任何額外的元素。分派用戶端支援使用回呼或輪詢機制進行非同步呼叫。
</soap:Body></soap:Header></soap:Envelope></soap:Header></soap:Envelope></soap:Body>
JAX-WS 的靜態用戶端程式設計模型稱為 Proxy 用戶端。 Proxy 用戶端會根據產生的或提供的「服務端點介面 (SEI)」來呼叫 Web 服務。
- MTOM 支援
- 使用 JAX-WS 時,您可以隨著 Web 服務要求一起傳送二進位附件,例如影像或檔案。 JAX-WS 根據「訊息傳輸最佳化機制 (MTOM)」的規定,新增支援將二進位資料的傳輸最佳化。
- 多重有效負載結構
- JAX-WS 向使用者公開下列連結技術: XML Source、SOAP Attachments API for Java (SAAJ) 1.3,以及 Java Architecture for XML Binding (JAXB) 2.0。XML Source 可讓使用者將 javax.xml.transform.Source 傳給執行時期,這代表傳給執行時期的 Source 物件中的資料。 SAAJ 1.3 現在能夠透過介面傳遞整個 SOAP 文件,而不只是內容本身。 這是由用戶端透過介面傳遞 SAAJ SOAPMessage 物件來完成。JAX-WS 將 JAXB 2.0 支援當作 Java 與 XML 之間選擇的資料連結技術。
- SOAP 1.2 支援
- JAX-WS 2.0 中已新增 SOAP 1.2 的支援。JAX-WS 支援 SOAP 1.1 與 SOAP 1.2。SOAP 1.2 提供 SOAP 處理模型更具體的定義,在缺少 Web Services-Interoperability (WS-I) 設定檔時,移除有時因含糊不清而導致的交互作業問題。 SOAP 1.2 應該會降低不同供應商在實作 SOAP 1.2 時發生交互作業問題的可能性。它無法與舊版本交互作業。
- 支援方法參數和傳回類型
- JAX-WS 2.2 支援方法參數和傳回類型。在 JAX-WS Web 服務作業中,您可以使用作業參數及選用的傳回類型來定義 Web 服務作業。
如果作業參數和傳回類型定義空的 targetNamespace 內容,也就是使用 @WebParam 或 @WebResult 註釋將 targetNamespace 內容的值指定為 "",JAX-WS 執行時期環境會有下列行為:
- 如果作業是文件樣式,則參數樣式為 WRAPPED,參數不會對映到標頭。空的名稱空間會與作業參數和傳回類型相對映。
- 如果參數樣式不是 WRAPPED,則會使用以 @WebParam 或 @WebResult 註釋指定的 targetNamespace 參數值。
JAX-WS 2.1.6
- 方法以 @WebMethod 或 @WebMethod(exclude=false) 標註,而包含類別具有 @WebService 註釋
- 方法沒有 @WebMethod 註釋,但包含類別具有 @WebService 註釋,沒有其他方法以 @WebMethod 或 @WebMethod(exclude=false) 標註
- 方法具有 @WebMethod 或 @WebMethod(exclude=false) 註釋。
- 方法沒有 @WebMethod 註釋,但包含類別具有 @WebService 註釋。
public class Base
{
@WebMethod(exclude=false)
public void superExposed(String s) {}
public String supernoanno(String s) {}
}
@WebService
public class BeanImpl extends Base
{
@WebMethod(exclude=false)
public void exposed(String s) {}
public String nonpublic(String s) {}
}
在 JAX-WS 2.1.6 之前,唯一公開的方法是 public
void exposed(String s)。JAX-WS 2.1.6 以及更新版本中會公開下列方法:public void exposed(String s)
public String nonpublic(String s)
public void superExposed(String s)
WebSphere Application Server 7.0.0.7 版以及更新版本透過 IBM® JDK 6 SR6 納入這些變更。如果要讓工作台在您使用 JAX-WS 2.1.6 時提供指引,請移至,然後將 JAX-WS 2.1.6 方法公開指引設定設為 true。
JAX-WS 2.2
- WebSphere Application Server Liberty 8.5.5 版
- WebSphere Application Server 8.5 版
- WebSphere Application Server 8.0 版
JAX-WS 2.2 規格取代且包含 JAX-WS 2.1 規格內的函數。JAX-WS 2.2 新增支援用戶端使用 WebServiceFeature 相關的註釋,例如 @MTOM、@Addressing 及 @RespectBinding 註釋。JAX-WS 2.1 先前已在伺服器上增加對這些註釋的支援。 此外,Java EE 1.3 規格的 Web 服務引進支援 WebServiceFeature 相關的這些註釋,也支援在用戶端和伺服器上使用部署描述子元素來配置這些特性。 在資料連結方面,JAX-WS 2.2 需要 Java Architecture for XML Binding (JAXB) 2.2 版。
如需 JAX-WS 的相關資訊,請參閱 JSR-224 正式規格:JSR 224: Java API for XML-Based Web Services (JAX-WS) 2.0
