概覽
CXF frontends 是一組編程的API，被用來開發和發布webservice。CXF支持兩種類型的frontend－－JAX-WS和簡單frontend。這章將對JAX-WS frontend提供更加詳細的解釋。我們同樣也會展示如何使用簡單frontend API來構建一個webservice。這個章節將會關注使用如下兩種frontend來開發基于SOAP的web服務：
- JAX-WS frontend
- 簡單 frontend
關于JAX-WS frontend，我們將說明如下內容：
- 使用編碼優先的開發方式來開發webservice
- 使用契約優先的開發方式來開發webservice
- 構建一個動態客戶端或消費者
- 基于Provider and Dispatch的實現
- 理解webservice上下文
JAX-WS frontend
CXF支持由Java Community Process(JCP)提供的JAX-WS 2.0 API 規范。JAX-WS是一個由JCP制訂的正式規范，它定義了API用來構建，開發和部署webservice。CXF提供了它自己的JAX-WS實現來附加在JAX-WS標準規范上。CXF JAX-WS frontend為構建不同種類的webservice提供了不公的API。拋開提供標準的基于WSDL的開發不講，它還在Provider and Dispatch接口的形式中提供了用于構建基于XML服務的API。
有兩種方式來開發基于SOAP的JAX-WS webservice－編碼優先和契約優先。正如名字顯示的那樣，在編碼優先的開發模式中，你將從編碼開始，然后將它轉化成WSDL。編碼優先的開發方式適用于：在實現方法的輸入和輸出的對象格式較簡單時，并且你想要將它們快速地暴露為webservice的時候。編碼優先的開發方式是更簡單的，因為你將從Java對象開始，而不必考慮如何生成WSDL和XSD，而這個過程會在Java對象無法被按照你的意愿映射到XML元素的時候導致一些問題。注意，像CXF Java2WSDL 這樣基于實現方法的輸入輸出格式的工具，將會生成契約，包括為你生成XSD格式。比如，你不能暴露一個Map或者Collection作為一個輸出信息格式，因為沒有標準的做法將它映射到XML schema，而這將會導致交互上的問題。
在契約優先的開發方式中，開發者從一個已經存在的WSDL artifact來構建webservice。契約優先的開發方式適用于：當你已經有了一個XML schema為webservice的操作定義了輸入輸出消息的格式的時候，或者想要更好的控制XML如何被映射到Java對象的時候。契約優先的開發方式需要你很精通XSD和WSDL契約，因為你將使用這些契約開始創建你的model。如果你在創建基于工業標準的服務，你或許需要從契約優先的開發方式開始，因為工業消息的格式通常是XML schema的。
如果兩種方式你都熟悉，并且知道對象是如何映射到XML的，你可以使用編碼優先的開發方式。CXF不僅支持這些開發方式，而且為多種數據綁定機制提供了支持，這些機制將幫助你把Java對象映射到XML。
我們將從編碼優先的開發方式開始。
編碼優先的開發方式
在這個部分，我們將以開發一個Java類，并且通過注解它將它轉化成一個service類開始。你將遵循如下的步驟完成webservice的開發：
- 創建Service Endpoint Interface(SEI)
- 添加Java注解
- 發布服務
- 開發一個消費者
- 運行編碼優先的例子
創建Service Endpoint Interface(SEI)
Service Endpoint Interface是一個Java接口，它定義了一個被用來暴露為服務的業務方法。這個服務方法被一個服務類實現。一個SEI可以通過兩種不同的方式來構建：
- 從零構建一個SEI組件
- 將存在的業務功能轉化成基于服務的組件
第一個方式－－從零構建一個SEI組件的方式是指，開發一個全新的webservice而不依賴于任何已經存在的代碼或WSDL契約。它推薦你從寫服務接口開始，然后創建這個服務的實現類。寫服務接口總是好的實踐，因為它為你的服務方法提供了一個適當的客戶端視圖。之后，實現類可以實現定義在接口中的方法。
第二個方式是指，拿到已經存在的業務功能，然后把它轉化成基于服務的組件。大多數時候，你已經開發過了業務邏輯，你只是想把它們作為服務方法暴露出去。你可以通過如下的方式來完成這個過程：開發一個SEI，并只定義那些你想要暴露成為一個服務方法的業務方法，然后使已經存在的Java代碼實現那個SEI。另一個常用的方式是：創建包裝后的SEI和一個實現類，這個實現類可以使用已經存在的實現類來完成自己的功能。
我們將從零創建一個SEI組件開始。我們開發一個OrderProcessSEI并且實現它。下面的代碼顯示了這個OrderProcessSEI：
package demo.order;
public interface OrderProcess {
String processOrder(Order order);
}
你可以看到，上面的代碼是一個簡單的POJO接口。它定義了一個抽象方法processOrder，它接收一個Orderbean作為一個參數。OrderProcessImpl實現類實現了processOrder方法，并且這個方法將在之后作為一個webservice方法暴露出來。
我們接下來將實現這個接口的業務邏輯。你將要寫這個OrderProcessImpl來實現OrderProcessSEI。下面的代碼顯示這個OrderProcessImpl類：
package demo.order;
public class OrderProcessImpl implements OrderProcess {
public String processOrder(Order order) {
System.out.println("Processing order...");
String orderID = validate(order);
return orderID;
}
}
上面的代碼是一個簡單的POJO實現類，它實現類processOrder方法。這個方法簡單地校驗了訂單，并返回一個唯一的訂單ID。簡單起見，我們返回了一個靜態的訂單ID作為我們實現的一部分。在下一個部分，我們將通過注解它們的方式把SEI和實現類轉化成為webservice組件。
添加Java注解
Webservice注解被添加到一個Java類用來將其暴露成為一個服務組件。JAX-WS使用Java 5注解，它是Web Services Metadata為Java Platform規范(JSR-181)提供的，用來將一個組件轉化成為一個webservice。這些注解簡單地標記，被用來為一個特定的組件或者方法定義一個特定上下文。每一個注解被一個或多個上下文的屬性所支持。在這個部分，我們將向我們的OrderProcessSEI和實現類添加注解，并將它們轉化成一個服務組件。在這個部分，我們將覆蓋如下的webservice注解：
- javax.jws.WebService
- javax.jws.soap.SOAPBinding
javax.jws.WebService
一個Java組件可以通過添加一個@WebService注解的方式被轉化成為一個服務。這個注解必須被同時定義在SEI和實現類中。@WebService注解被定義在javax.jws.WebService接口。
@WebService注解支持如下的屬性：
讓我們注解我們的OrderProcessSEI和OrderProcessImpl實現類。下面的代碼展示了@WebService注解的使用：
package demo.order;
import javax.jws.WebService;
@WebService
public interface OrderProcess {
String processOrder(Order order);
}
@WebService被直接聲明在接口或者類之上。它注解了這個類或者接口作為一個webservice的類或者接口。在上面的代碼中，OrderProcess接口通過@WebService注解，來被定義成為一個webservice接口。
讓我們看一下OrderProcessImpl實現類。下面的代碼展示了被注解的OrderProcessImpl實現類：
package demo.order;
import javax.jws.WebService;
@WebService(serviceName="OrderProcessService",
portName="OrderProcessPort")
public class OrderProcessImpl implements OrderProcess {
public String processOrder(Order order) {
System.out.println("Processing order...");
String orderID = validate(order);
return orderID;
}
}
和SEI類似，你在類之上聲明@WebService。你將定義兩個屬性－－serviceName和portName。serviceName屬性被賦值為OrderProcessService。這個服務名稱被消費者用來獲取遠程接口的句柄來調用服務方法。端口名稱簽名了endpoint名稱。服務的endpoint也同樣作為一個服務端口在服務發布的地方被調用。這里的名字是OrderProcessPort。
有許多其它可選的注解被用來和@WebService搭配使用，用來更加完整地描述一個webservice。其它注解可以添加更精細的細節到一個服務上。總是推薦你使用這些注解來描述你的webservice，以便于生成的WSDL文檔有更多的被這些注解指定的細節。如果你沒有使用這些可選的注解，那么WSDL將被按照默認的規則生成，正如前面表格中討論的一樣。
javax.jws.soap.SOAPBinding
@SOAPBinding注解被定義在javax.jws.soap.SOAPBinding接口中。這個注解在你想要為你的服務制定SOAP綁定的時候使用。
這個注解支持如下的屬性：
SOAP綁定在webservice交互中扮演著重要的角色。讓我們更加詳細地看看兩種風格的SOAP綁定。
RPC 風格 v.s Document 風格
Webservice的SOAP交互風格在服務提供者和消費者之間交互SOAP XML消息中扮演著重要的角色。有兩種SOAP消息風格－－Document和RPC。SOAP消息的風格被作為SOAP綁定定義在WSDL文檔中。一個SOAP綁定能夠擁有一個基于編碼的使用（encoded use） 或者 基于字面的使用（encoded use or a literal use）。編碼，這個詞暗示了消息將使用某種格式被編碼，而字面的表示使用純文本消息，而不做任何編碼邏輯。
正如名字顯示的那樣，Document風格將XML文檔作為有效的載荷來添加到定義良好的契約中，通常的做法是使用XML schema定義來創建。XML schema格式指定了被消費者調用的服務消息的契約。XML schema定義了服務提供者和服務消費者之間的request和response消息的格式。這些消息的格式可以被服務的提供者和消費者驗證為合法。Document literal風格對webservice交互來完成協作來說是更受歡迎的方式。
另一方面，RPC(Remote Procedure Call)風格表明了SOAP主體包含一個XML的方法展示。為了序列化方法的參數到SOAP消息，以便于它能夠被任何webservice實現反序列化。SOAP規范定義了一系列的編碼規則。由于RPC通常被用在連接SOAP的編碼規則，這個連接將被引用為RPC/encoded。你用養有一種RPC/literal交互風格模式，這種模式中你沒有任何的編碼格式，但是消息依然受限于RPC 基于方法的交互，這種方式下，消息不能被驗證為合法的，因為他們與任何XML schema定義之間都沒有關聯。你或許應該避免開發RPC風格的webservice，因為它們有許多協作性上的問題。
下面的代碼展示了@SOAPBinding注解的使用：
@WebService(name="OrderProcess")
@SOAPBinding(parameterStyle=ParameterStyle.BARE)
public interface OrderProcess {
String processOrder(Order order);
}
javax.jws.WebMethod
@WebMethod注解被定義在javax.jws.WebMethod接口中。這個注解被用來自定義webservice的操作。@WebMethod注解提供了operation的name和action屬性，這兩個屬性分別被用來自定義在WSDL文檔中的<wsdl:operation>元素的name屬性和<soap:operation>元素的soapAction屬性。@WebMethod注解被放置在服務方法聲明的上面。
@WebMethod注解支持如下的屬性：
下面的代碼片段展示了@WebMethod注解的使用：
@WebMethod (name="processOrder")
public String processOrder(Order order) {
// ...
}
JAX-WS webservice注解支持一系列的其它注解，比如：@RequestWrapper, @ResponseWrapper, @Oneway等等。它們中的一些將稍后解釋。
發布服務
發布服務意味著將服務組件注冊到服務器上，并且通過endpoint URL使其可以被消費者使用。你將把OrderProcesswebservice發布到一個特定的endpoint URL上。在本例中的endpoint URL將會是http://localhost:8080/OrderProcess。你將開發一個服務器組件來發布你的OrderProcess服務。對這個例子來說，我們將使用Java 5提供的輕量級的web服務器來發布我們的服務。CXF提供了它自己獨立的服務器組件－－JaxWsServerFactoryBean來發布webservice。
下面的代碼展示了服務器代碼：
import javax.xml.ws.Endpoint;
public class Server {
protected Server() throws Exception {
System.out.println("Starting Server ...");
OrderProcessImpl orderProcessImpl = new OrderProcessImpl();
String address = "http://localhost:8080/OrderProcess";
Endpoint.publish(address, orderProcessImpl);
}
public static void main(String[] args) {
new Server();
Thread.sleep(50000);
System.exit(0);
}
}
用于發布Endpoint類的靜態方法提供了一個簡便的方式來發布和測試JAX-WS webservice。這個方法接受endpoint URL和一個OrderProcessImpl類對象作為參數。這個publish方法在URL http://localhost:8080/OrderProcess上創建一個輕量級的web服務器，并且在那個位置部署這個服務。這個輕量級的web服務器在JVM中運行一分鐘然后自動終止。一種能夠看到服務的WSDL契約的方法是在web瀏覽器中訪問這個URL：
http://localhost:8080/OrderProcess?wsdl
開發一個消費者
webservice的消費者調用服務方法來獲得需要的結果。在這一部分，我們將開發一個Client類來查找我們的OrderProcess服務，并且調用它的processOrder方法。下面的代碼展示了服務消費者組件：
public class Client {
private static final QName SERVICE_NAME =
new QName("http://order.demo/", "OrderProcessService");
private static final QName PORT_NAME =
new QName("http://order.demo/", "OrderProcessPort");
private static final String WSDL_LOCATION =
"http://localhost:8080/OrderProcess?wsdl";
public static void main(String args[]) throws Exception {
URL wsdlURL = new URL(WSDL_LOCATION);
Service service = Service.create(wsdlURL, SERVICE_NAME);
OrderProcess port = service.getPort(PORT_NAME, OrderProcess.class);
Order order = new Order();
order.setCustomerID("C001");
order.setItemID("I001");
order.setPrice(100.00);
order.setQty(20);
String result = port.processOrder(order);
System.out.println("The order ID is " + result);
}
}
客戶端的代碼做了以下的事情：
- 它首先創建了WSDL URL。這個WSDL URL是
http://localhost:8080/OrderProcess?wsdl。這個URL表明了WSDL 文檔的位置。
在運行客戶端程序之前，你可以通過訪問以上的URL來驗證這個服務是否可用。如果你能夠看見WSDL，那么就意味著這個
OrderProcess服務被成功地發布了。
- 接下來創建了
Service對象。這個Service對象使用了靜態的create方法被創建。這個方法接受WSDL URL和服務名稱作為參數。這個服務名稱OrderProcessService是一個QName，并且在WSDL文檔中被映射到<wsdl:service>元素。<wsdl:service>元素定義了服務的endpoint。 - 使用
Service對象，你通過調用getPort方法獲得SEI句柄的代理組件。getPort方法接受port name和SEI類作為參數。接口名稱OrderProcessPort是一個QName，并且在WSDL文檔中被映射到<wsdl:port>元素。這個SEI類是OrderProcess。 - 代理組件在接下來被用來調用服務方法
processOrder。在調用方法之前，你必須安置好Orderbean，并把它傳給processOrder方法。這個方法在服務器上被調用，并返回訂單ID。
