?
This document uses PHP Chinese website manual Release
Spring為標(biāo)準(zhǔn)Java web服務(wù)API提供了全面的支持:
使用JAX-RPC暴露web服務(wù)
使用JAX-RPC訪問web服務(wù)
使用JAX-WS暴露web服務(wù)
使用JAX-WS訪問web服務(wù)
注意
為什么有2個標(biāo)準(zhǔn)的Java web服務(wù)APIs?
JAX-RPC 1.1 在J2EE 1.4 中是標(biāo)準(zhǔn)的web服務(wù)API。正像其名稱所示，它關(guān)注于RPC綁定而且在最近幾年越來越不流行。最終被Java EE 5中的JAX-WS 2.0所取代，JAX-WS 2.0不但在綁定方面更靈活，而且也是完全基于annotation的。JAX-WS 2.1也被包含在Java 6中(更詳細(xì)的說是在Sun JDK 1.6.0_04和更高版本中，低版本的Sun JDK 1.6.0包含JAX-WS 2.0)，它與JDK內(nèi)置的HTTP服務(wù)器集成。
Spring 同時支持兩個標(biāo)準(zhǔn)Java web服務(wù)API。選擇誰主要看運(yùn)行平臺：在JDK 1.4 / J2EE 1.4上，唯一的選擇是JAX-RPC。在Java EE 5 / Java 6上顯然應(yīng)該選JAX-WS。運(yùn)行Java 5的J2EE 1.4環(huán)境上，你可以選擇插入一個JAX-WS provider；請查看你的J2EE服務(wù)器文檔。
除了在Spring Core中支持JAX-RPC and JAX-WS，Spring portfolio也提供了一種特性Spring Web Services，一個為優(yōu)先授權(quán)和文檔驅(qū)動的web服務(wù)所提供的方案 - 非常建議用來創(chuàng)建高級并具有前瞻性的web服務(wù)。XFire是最后但不是唯一的Spring內(nèi)置支持可以讓你將Spring管理的bean暴露為web服務(wù)的方式。
Spring為JAX-RPC servlet的端點(diǎn)實(shí)現(xiàn)提供了一個方便的基類 - ServletEndpointSupport. 未來暴露我們的 AccountService我們擴(kuò)展Spring的ServletEndpointSupport類并在這里實(shí)現(xiàn)了我們的業(yè)務(wù)邏輯，通常將調(diào)用交給業(yè)務(wù)層。
/**
* JAX-RPC compliant RemoteAccountService implementation that simply delegates
* to the AccountService implementation in the root web application context.
*
* This wrapper class is necessary because JAX-RPC requires working with dedicated
* endpoint classes. If an existing service needs to be exported, a wrapper that
* extends ServletEndpointSupport for simple application context access is
* the simplest JAX-RPC compliant way.
*
* This is the class registered with the server-side JAX-RPC implementation.
* In the case of Axis, this happens in "server-config.wsdd" respectively via
* deployment calls. The web service engine manages the lifecycle of instances
* of this class: A Spring application context can just be accessed here.
*/import org.springframework.remoting.jaxrpc.ServletEndpointSupport;
public class AccountServiceEndpoint extends ServletEndpointSupport implements RemoteAccountService {
private AccountService biz;
protected void onInit() {
this.biz = (AccountService) getWebApplicationContext().getBean("accountService");
}
public void insertAccount(Account acc) throws RemoteException {
biz.insertAccount(acc);
}
public Account[] getAccounts(String name) throws RemoteException {
return biz.getAccounts(name);
}
}
AccountServletEndpoint需要在Spring中同一個上下文的web應(yīng)用里運(yùn)行，以獲得對Spring的訪問能力。如果使用Axis，把AxisServlet定義復(fù)制到你的'web.xml'中，并且在'server-config.wsdd'中設(shè)置端點(diǎn)（或使用發(fā)布工具）。參看JPetStore這個例子中OrderService是如何用Axis發(fā)布成一個Web服務(wù)的。
Spring提供了兩個工廠bean用來創(chuàng)建Web服務(wù)代理，LocalJaxRpcServiceFactoryBean 和 JaxRpcPortProxyFactoryBean。前者只返回一個JAX-RPC服務(wù)類供我們使用。后者是一個全功能的版本，可以返回一個實(shí)現(xiàn)我們業(yè)務(wù)服務(wù)接口的代理。本例中，我們使用后者來為前面段落中暴露的AccountService端點(diǎn)創(chuàng)建一個代理。你將看到Spring對Web服務(wù)提供了極好的支持，只需要很少的代碼 - 大多數(shù)都是通過類似下面的Spring配置文件：
<bean id="accountWebService" class="org.springframework.remoting.jaxrpc.JaxRpcPortProxyFactoryBean">
<property name="serviceInterface" value="example.RemoteAccountService"/>
<property name="wsdlDocumentUrl" value="http://localhost:8080/account/services/accountService?WSDL"/>
<property name="namespaceUri" value="http://localhost:8080/account/services/accountService"/>
<property name="serviceName" value="AccountService"/>
<property name="portName" value="AccountPort"/>
</bean>
serviceInterface是我們客戶端將使用的遠(yuǎn)程業(yè)務(wù)接口。
wsdlDocumentUrl是WSDL文件的URL. Spring需要用它作為啟動點(diǎn)來創(chuàng)建JAX-RPC服務(wù)。
namespaceUri對應(yīng).wsdl文件中的targetNamespace。
serviceName 對應(yīng).wsdl文件中的服務(wù)名。
portName 對應(yīng).wsdl文件中的端口號。
現(xiàn)在我們可以很方便的訪問web服務(wù)，因?yàn)槲覀冇幸粋€可以將它暴露為RemoteAccountService接口的bean工廠。我們可以在Spring中這樣使用：
<bean id="client" class="example.AccountClientImpl">
...
<property name="service" ref="accountWebService"/>
</bean>
從客戶端代碼上看，除了它拋出RemoteException，我們可以把這個web服務(wù)當(dāng)成一個普通的類進(jìn)行訪，。
public class AccountClientImpl {
private RemoteAccountService service;
public void setService(RemoteAccountService service) {
this.service = service;
}
public void foo() {
try {
service.insertAccount(...);
}
catch (RemoteException ex) {
// ouch
}
}
}
我們可以不檢查受控異常RemoteException，因?yàn)镾pring將它自動轉(zhuǎn)換成相應(yīng)的非受控異常RemoteException。這也需要我們提供一個非RMI的接口。現(xiàn)在配置文件如下：
<bean id="accountWebService" class="org.springframework.remoting.jaxrpc.JaxRpcPortProxyFactoryBean">
<property name="serviceInterface" value="example.AccountService"/>
<property name="portInterface" value="example.RemoteAccountService"/>
</bean>
我們的serviceInterface變成了非RMI接口。我們的RMI接口現(xiàn)在使用portInterface屬性來定義。我們的客戶端代碼可以避免處理異常java.rmi.RemoteException:
public class AccountClientImpl {
private AccountService service;
public void setService(AccountService service) {
this.service = service;
}
public void foo() {
service.insertAccount(...);
}
}
請注意你也可以去掉"portInterface"部分并指定一個普通業(yè)務(wù)接口作為"serviceInterface"。這樣JaxRpcPortProxyFactoryBean將自動切換到JAX-RPC "動態(tài)調(diào)用接口", 不使用固定端口存根來進(jìn)行動態(tài)調(diào)用。這樣做的好處是你甚至不需要使用一個RMI相關(guān)的Java接口（比如在非Java的目標(biāo)web服務(wù)中）；你只需要一個匹配的業(yè)務(wù)接口。查看JaxRpcPortProxyFactoryBean的javadoc來了解運(yùn)行時實(shí)行的細(xì)節(jié)。
T為了傳遞類似Account等復(fù)雜對象，我們必須在客戶端注冊bean映射。
注意
在服務(wù)器端通常在'server-config.wsdd'中使用Axis進(jìn)行bean映射注冊。
我們將使用Axis在客戶端注冊bean映射。為此，我們需要通過程序注冊這個bean映射:
public class AxisPortProxyFactoryBean extends JaxRpcPortProxyFactoryBean {
protected void postProcessJaxRpcService(Service service) {
TypeMappingRegistry registry = service.getTypeMappingRegistry();
TypeMapping mapping = registry.createTypeMapping();
registerBeanMapping(mapping, Account.class, "Account");
registry.register("http://schemas.xmlsoap.org/soap/encoding/", mapping);
}
protected void registerBeanMapping(TypeMapping mapping, Class type, String name) {
QName qName = new QName("http://localhost:8080/account/services/accountService", name);
mapping.register(type, qName,
new BeanSerializerFactory(type, qName),
new BeanDeserializerFactory(type, qName));
}
}
本節(jié)中，我們將注冊自己的javax.rpc.xml.handler.Handler 到Web服務(wù)代理，這樣我們可以在SOAP消息被發(fā)送前執(zhí)行定制的代碼。Handler是一個回調(diào)接口。jaxrpc.jar中有個方便的基類javax.rpc.xml.handler.GenericHandler供我們繼承使用：
public class AccountHandler extends GenericHandler {
public QName[] getHeaders() {
return null;
}
public boolean handleRequest(MessageContext context) {
SOAPMessageContext smc = (SOAPMessageContext) context;
SOAPMessage msg = smc.getMessage();
try {
SOAPEnvelope envelope = msg.getSOAPPart().getEnvelope();
SOAPHeader header = envelope.getHeader();
...
}
catch (SOAPException ex) {
throw new JAXRPCException(ex);
}
return true;
}
}
我們現(xiàn)在要做的就是把AccountHandler注冊到JAX-RPC服務(wù)，這樣它可以在消息被發(fā)送前調(diào)用 handleRequest(..)。Spring目前對注冊處理方法還不提供聲明式支持，所以我們必須使用編程方式。但是Spring中這很容易實(shí)現(xiàn)，我們只需覆寫專門為此設(shè)計(jì)的 postProcessJaxRpcService(..) 方法：
public class AccountHandlerJaxRpcPortProxyFactoryBean extends JaxRpcPortProxyFactoryBean {
protected void postProcessJaxRpcService(Service service) {
QName port = new QName(this.getNamespaceUri(), this.getPortName());
List list = service.getHandlerRegistry().getHandlerChain(port);
list.add(new HandlerInfo(AccountHandler.class, null, null));
logger.info("Registered JAX-RPC AccountHandler on port " + port);
}
}
最后，我們要記得更改Spring配置文件來使用我們的工廠bean:
<bean id="accountWebService" class="example.AccountHandlerJaxRpcPortProxyFactoryBean">
...
</bean>
Spring為JAX-WS servlet端點(diǎn)實(shí)現(xiàn)提供了一個方便的基類 - SpringBeanAutowiringSupport。要暴露我們的AccountService接口，我們可以擴(kuò)展Spring的SpringBeanAutowiringSupport類并實(shí)現(xiàn)我們的業(yè)務(wù)邏輯，通常把調(diào)用交給業(yè)務(wù)層。我們將簡單的使用Spring 2.5的@Autowired注解來聲明依賴于Spring管理的bean。
/**
* JAX-WS compliant AccountService implementation that simply delegates
* to the AccountService implementation in the root web application context.
*
* This wrapper class is necessary because JAX-WS requires working with dedicated
* endpoint classes. If an existing service needs to be exported, a wrapper that
* extends SpringBeanAutowiringSupport for simple Spring bean autowiring (through
* the @Autowired annotation) is the simplest JAX-WS compliant way.
*
* This is the class registered with the server-side JAX-WS implementation.
* In the case of a Java EE 5 server, this would simply be defined as a servlet
* in web.xml, with the server detecting that this is a JAX-WS endpoint and reacting
* accordingly. The servlet name usually needs to match the specified WS service name.
*
* The web service engine manages the lifecycle of instances of this class.
* Spring bean references will just be wired in here.
*/import org.springframework.web.context.support.SpringBeanAutowiringSupport;
@WebService(serviceName="AccountService")
public class AccountServiceEndpoint extends SpringBeanAutowiringSupport {
@Autowired
private AccountService biz;
@WebMethod
public void insertAccount(Account acc) {
biz.insertAccount(acc);
}
@WebMethod
public Account[] getAccounts(String name) {
return biz.getAccounts(name);
}
}
為了能夠讓Spring上下文使用Spring設(shè)施，我們的AccountServletEndpoint類需要運(yùn)行在同一個web應(yīng)用中。在Java EE 5環(huán)境中這是默認(rèn)的情況，它使用JAX-WS servlet端點(diǎn)安裝標(biāo)準(zhǔn)契約。詳情請參閱Java EE 5 web服務(wù)教程。
Sun JDK 1.6提供的內(nèi)置JAX-WS provider 使用內(nèi)置的HTTP服務(wù)器來暴露web服務(wù)。Spring的SimpleJaxWsServiceExporter類檢測所有在Spring應(yīng)用上下文中配置的l@WebService 注解bean，然后通過默認(rèn)的JAX-WS服務(wù)器（JDK 1.6 HTTP服務(wù)器）來暴露它們。
在這種場景下，端點(diǎn)實(shí)例將被作為Spring bean來定義和管理。它們將使用JAX-WS來注冊，但其生命周期將一直跟隨Spring應(yīng)用上下文。這意味著Spring的顯示依賴注入可用于端點(diǎn)實(shí)例。當(dāng)然通過@Autowired來進(jìn)行注解驅(qū)動的注入也可以正常工作。
<bean class="org.springframework.remoting.jaxws.SimpleJaxWsServiceExporter">
<property name="baseAddress" value="http://localhost:9999/"/>
</bean>
<bean id="accountServiceEndpoint" class="example.AccountServiceEndpoint">
...
</bean>
...
AccountServiceEndpoint類可能源自Spring的 SpringBeanAutowiringSupport類，也可能不是。因?yàn)檫@里的端點(diǎn)是由Spring完全管理的bean。這意味著端點(diǎn)實(shí)現(xiàn)可能像下面這樣沒有任何父類定義 - 而且Spring的@Autowired配置注解仍然能夠使用：
@WebService(serviceName="AccountService")
public class AccountServiceEndpoint {
@Autowired
private AccountService biz;
@WebMethod
public void insertAccount(Account acc) {
biz.insertAccount(acc);
}
@WebMethod
public Account[] getAccounts(String name) {
return biz.getAccounts(name);
}
}
Sun的JAX-WS RI被作為GlassFish項(xiàng)目的一部分來開發(fā),它使用了Spring支持來作為JAX-WS Commons項(xiàng)目的一部分。這允許把JAX-WS端點(diǎn)作為Spring管理的bean來定義。這與前面章節(jié)討論的單獨(dú)模式類似 - 但這次是在Servlet環(huán)境中。注意這在Java EE 5環(huán)境中是不可遷移的，建議在沒有EE的web應(yīng)用環(huán)境如Tomcat中嵌入JAX-WS RI。
與標(biāo)準(zhǔn)的暴露基于servlet的端點(diǎn)方式不同之處在于端點(diǎn)實(shí)例的生命周期將被Spring管理。這里在web.xml將只有一個JAX-WS servlet定義。在標(biāo)準(zhǔn)的Java EE 5風(fēng)格中(如上所示)，你將對每個服務(wù)端點(diǎn)定義一個servlet，每個服務(wù)端點(diǎn)都代理到Spring bean (通過使用@Autowired，如上所示)。
關(guān)于安裝和使用詳情請查閱https://jax-ws-commons.dev.java.net/spring/。
類似JAX-RPC支持，Spring提供了2個工廠bean來創(chuàng)建JAX-WS web服務(wù)代理，它們是LocalJaxWsServiceFactoryBean和JaxWsPortProxyFactoryBean。前一個只能返回一個JAX-WS服務(wù)對象來讓我們使用。后面的是可以返回我們業(yè)務(wù)服務(wù)接口的代理實(shí)現(xiàn)的完整版本。這個例子中我們使用后者來為AccountService端點(diǎn)再創(chuàng)建一個代理：
<bean id="accountWebService" class="org.springframework.remoting.jaxws.JaxWsPortProxyFactoryBean">
<property name="serviceInterface" value="example.AccountService"/>
<property name="wsdlDocumentUrl" value="http://localhost:8080/account/services/accountService?WSDL"/>
<property name="namespaceUri" value="http://localhost:8080/account/services/accountService"/>
<property name="serviceName" value="AccountService"/>
<property name="portName" value="AccountPort"/>
</bean>
serviceInterface是我們客戶端將使用的遠(yuǎn)程業(yè)務(wù)接口。
wsdlDocumentUrl是WSDL文件的URL. Spring需要用它作為啟動點(diǎn)來創(chuàng)建JAX-RPC服務(wù)。
namespaceUri對應(yīng).wsdl文件中的targetNamespace。
serviceName 對應(yīng).wsdl文件中的服務(wù)名。
portName 對應(yīng).wsdl文件中的端口號。
現(xiàn)在我們可以很方便的訪問web服務(wù)，因?yàn)槲覀冇幸粋€可以將它暴露為AccountService接口的bean工廠。我們可以在Spring中這樣使用：
<bean id="client" class="example.AccountClientImpl">
...
<property name="service" ref="accountWebService"/>
</bean>
從客戶端代碼上我們可以把這個web服務(wù)當(dāng)成一個普通的類進(jìn)行訪問：
public class AccountClientImpl {
private AccountService service;
public void setService(AccountService service) {
this.service = service;
}
public void foo() {
service.insertAccount(...);
}
}
注意: 上面被稍微簡化了，因?yàn)镴AX-WS需要端點(diǎn)接口及實(shí)現(xiàn)類來使用@WebService, @SOAPBinding等注解。 這意味著你不能簡單的使用普通的Java接口和實(shí)現(xiàn)來作為JAX-WS端點(diǎn)，你需要首先對它們進(jìn)行相應(yīng)的注解。這些需求詳情請查閱JAX-WS文檔。
XFire是一個Codehaus提供的輕量級SOAP庫。暴露XFire是通過XFire自帶的context，這個context將和RemoteExporter風(fēng)格的bean相結(jié)合，后者需要被加入到在你的WebApplicationContext中。對于所有讓你來暴露服務(wù)的方法，你需要創(chuàng)建一個DispatcherServlet類并有相應(yīng)的WebApplicationContext來封裝你將要暴露的服務(wù)：
<servlet>
<servlet-name>xfire</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
</servlet>
你還必須鏈接XFire配置。這是通過增加一個context文件到由ContextLoaderListener（或者ContextLoaderServlet）加載的 contextConfigLocations 參數(shù)中。
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:org/codehaus/xfire/spring/xfire.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
在你加入一個Servlet映射后（映射/*到上面定義的XFire Servlet），你只需要增加一個額外的bean來使用XFire暴露服務(wù)。例如，在 'xfire-servlet.xml' 中增加如下配置：
<beans>
<bean name="/Echo" class="org.codehaus.xfire.spring.remoting.XFireExporter">
<property name="serviceInterface" value="org.codehaus.xfire.spring.Echo"/>
<property name="serviceBean">
<bean class="org.codehaus.xfire.spring.EchoImpl"/>
</property>
<!-- the XFire bean is defined in the xfire.xml file -->
<property name="xfire" ref="xfire"/>
</bean>
</beans>
XFire處理了其他的事情。它檢查你的服務(wù)接口并產(chǎn)生一個WSDL文件。這里的部分文檔來自XFire網(wǎng)站，要了解更多有關(guān)XFire Spring的集成請?jiān)L問 docs.codehaus.org/display/XFIRE/Spring。