Chapter 17. 使用Spring進行遠端訪問與Web服務

17.1. 簡介

Spring為各種遠端訪問技術的整合提供了工具類。Spring遠端支援是由普通（Spring）POJO實現的，這使得開發具有遠端訪問功能的服務變得相當容易。目前，Spring支援四種遠端技術：

• 遠端方法呼叫（RMI）。通過使用 RmiProxyFactoryBean 和 RmiServiceExporter，Spring同時支援傳統的RMI（使用java.rmi.Remote介面和java.rmi.RemoteException）和通過RMI呼叫器實現的透明遠端呼叫（支援任何Java介面）。
• Spring
  的HTTP呼叫器。Spring提供了一種特殊的允許通過HTTP進行Java序列化的遠端呼叫策略，支援任意Java介面（就像RMI呼叫器）。相對應的支援類是 HttpInvokerProxyFactoryBean 和 HttpInvokerServiceExporter。
• Hessian。通過 HessianProxyFactoryBean 和 HessianServiceExporter，可以使用Caucho提供的基於HTTP的輕量級二進位制協議來透明地暴露服務。
• Burlap。 Burlap是Caucho的另外一個子專案，可以作為Hessian基於XML的替代方案。Spring
  提供了諸如 BurlapProxyFactoryBean 和 BurlapServiceExporter 的支援類。
• JAX RPC。Spring通過JAX-RPC為遠端Web服務提供支援。
• JMS（待實現）。

在討論Spring對遠端訪問的支援時，我們將使用下面的域模型和對應的服務：

// Account domain object

public class Account implements Serializable{

private String name;

public String getName();

public void setName(String name) {

this.name = name;

}

}

// Account service

public interface AccountService {

public void insertAccount(Account acc);

public List getAccounts(String name);

}

// Remote Account service

public interface RemoteAccountService extends Remote {

public void insertAccount(Account acc) throws RemoteException;

public List getAccounts(String name) throws RemoteException;

}

// ... and corresponding implement doing nothing at the moment

public class AccountServiceImpl implements AccountService {

public void insertAccount(Account acc) {

// do something

}

public List getAccounts(String name) {

// do something

}

}

我們將從使用RMI把服務暴露給遠端客戶端開始並探討使用RMI的一些缺點。然後我們將演示一個使用Hessian的例子。

17.2. 使用RMI暴露服務

使 用Spring的RMI支援，你可以通過RMI基礎設施透明的暴露你的服務。設定好Spring的RMI支援後，你會看到一個和遠端EJB介面類似的配 置，只是沒有對安全上下文傳遞和遠端事務傳遞的標準支援。當使用RMI呼叫器時，Spring對這些額外的呼叫上下文提供了鉤子，你可以在此插入安全框架 或者定製的安全證書。

17.2.1. 使用 RmiServiceExporter暴露服務

使用 RmiServiceExporter，我們可以把AccountService物件的介面暴露成RMI物件。可以使用 RmiProxyFactoryBean 或者在傳統RMI服務中使用普通RMI來訪問該介面。RmiServiceExporter 顯式地支援使用RMI呼叫器暴露任何非RMI的服務。

當然，我們首先需要在Spring BeanFactory中設定我們的服務：

<bean id="accountService" class="example.AccountServiceImpl">

<!-- any additional properties, maybe a DAO? -->

</bean>

然後，我們將使用 RmiServiceExporter 來暴露我們的服務：

<bean class="org.springframework.remoting.rmi.RmiServiceExporter">

<!-- does not necessarily have to be the same name as the bean to be exported -->

<property name="serviceName" value="AccountService"/>

<property name="service" ref="accountService"/>

<property name="serviceInterface" value="example.AccountService"/>

<!-- defaults to 1099 -->

<property name="registryPort" value="1199"/>

</bean>

正如你所見，我們覆蓋了RMI註冊的埠號。通常，你的應用服務也會維護RMI註冊，最好不要和它衝突。更進一步來說，服務名是用來繫結下面的服務的。所以本例中，服務繫結在 rmi://HOST:1199/AccountService。在客戶端我們將使用這個URL來連結到服務。

注意：我們省略了一個屬性，就是 servicePort 屬性，它的預設值為0。 這表示在服務通訊時使用匿名埠。當然如果你願意的話，也可以指定一個不同的埠。

17.2.2. 在客戶端連結服務

我們的客戶端是一個使用AccountService來管理account的簡單物件：

public class SimpleObject {

private AccountService accountService;

public void setAccountService(AccountService accountService) {

this.accountService = accountService;

}

}

為了把服務連線到客戶端上，我們將建立另一個單獨的bean工廠，它包含這個簡單物件和服務連結配置位：

<bean class="example.SimpleObject">

<property name="accountService" ref="accountService"/>

</bean>

<bean id="accountService" class="org.springframework.remoting.rmi.RmiProxyFactoryBean">

<property name="serviceUrl" value="rmi://HOST:1199/AccountService"/>

<property name="serviceInterface" value="example.AccountService"/>

</bean>

這就是我們在客戶端為支援遠端account服務所需要做的。Spring將透明的建立一個呼叫器並且通過RmiServiceExporter使得account服務支援遠端服務。在客戶端，我們用RmiProxyFactoryBean連線它。

17.3. 使用Hessian或者Burlap通過HTTP遠端呼叫服務

Hessian提供一種基於HTTP的二進位制遠端協議。它是由Caucho建立的，可以在 找到更多有關Hessian的資訊。

17.3.1. 為Hessian配置DispatcherServlet

Hessian使用一個特定的Servlet通過HTTP進行通訊。使用Spring的DispatcherServlet，可以很容易的配置這樣一個 Servlet來暴露你的服務。首先我們要在你的應用裡建立一個新的Servlet（下面來自web.xml檔案）：

<servlet>

<servlet-name>remoting</servlet-name>

<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>remoting</servlet-name>

<url-pattern>/remoting/*</url-pattern>

</servlet-mapping>

你可能對Spring的DispatcherServlet很熟悉，這樣你就知道，需要在 WEB-INF 目錄裡建立一個名為 remoting-servlet.xml（在你的servlet名後）的應用上下文。這個應用上下文將在下一節中裡使用。

17.3.2. 使用HessianServiceExporter暴露你的bean

在新建立的 remoting-servlet.xml 應用上下文裡，我們將建立一個HessianServiceExporter來暴露你的服務：

<bean id="accountService" class="example.AccountServiceImpl">

<!-- any additional properties, maybe a DAO? -->

</bean>

<bean name="/AccountService" class="org.springframework.remoting.caucho.HessianServiceExporter">

<property name="service" ref="accountService"/>

<property name="serviceInterface" value="example.AccountService"/>

</bean>

現在，我們準備在客戶端連線服務了。不必顯示指定處理器的對映，只要使用BeanNameUrlHandlerMapping把URL請求對映到服務上：所以，這個服務將在由bean名稱指明的URL http://HOST:8080/remoting/AccountService 位置進行暴露。

17.3.3. 客戶端連線服務

使用 HessianProxyFactoryBean，我們可以在客戶端連線服務。同樣的方式對RMI示例也適用。我們將建立一個單獨的bean工廠或者應用上下文，而後簡單地指明下面的bean SimpleObject將使用AccountService來管理accounts：

<bean class="example.SimpleObject">

<property name="accountService" ref="accountService"/>

</bean>

<bean id="accountService" class="org.springframework.remoting.caucho.HessianProxyFactoryBean">

<property name="serviceUrl" value="http://remotehost:8080/AccountService"/>

<property name="serviceInterface" value="example.AccountService"/>

</bean>

這就是所有要做的。

17.3.4. 使用Burlap

我們在這裡將不去仔細討論Burlap，它是一個基於XML的Hessian替代方案。它的配置方法和上述Hessian的一樣。只要把 Hessian 換成 Burlap 就行了。

17.3.5. 對通過Hessian或Burlap暴露的服務使用HTTP基礎認證

Hessian和Burlap的一個優勢是我們可以容易的使用HTTP基礎認證，因為他們二者都是基於HTTP的。例如，普通HTTP Server安全機制可以通過使用 web.xml 安全特徵來應用。通常，你不會為每個使用者都建立不同的安全證書，而是在Hessian/BurlapProxyFactoryBean級別共享安全證書（類似一個JDBC資料來源）。

<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">

<property name="interceptors">

<list>

<ref bean="authorizationInterceptor"/>

</list>

</property>

</bean>

<bean id="authorizationInterceptor"

class="org.springframework.web.servlet.handler.UserRoleAuthorizationInterceptor">

<property name="authorizedRoles">

<list>

<value>administrator</value>

<value>operator</value>

</list>

</property>

</bean>

這個例子裡我們顯式使用了BeanNameUrlHandlerMapping，並設定了一個攔截器，後者將只允許管理員和操作員呼叫這個應用上下文中提及的bean。

注意：當然，這個例子沒有演示靈活的安全設施。考慮更多有關安全的問題時，請參閱 處的Acegi Security System for Spring。

17.4. 使用HTTP呼叫器暴露服務

和使用自身序列化機制的輕量級協議Burlap和Hessian相反，Spring HTTP呼叫器使用標準Java序列化機制來通過HTTP暴露業務。如果你的引數或返回值是複雜型別，並且不能通過Hessian和Burlap的序列化 機制進行序列化，HTTP呼叫器就很有優勢（參閱下一節，選擇遠端技術時的考慮）。

實際上，Spring可以使用J2SE提供的標準功能或Commons的HttpClient來實現HTTP呼叫。如果你需要更先進，更容易使用的功能，就使用後者。你可以參考 。

17.4.1. 暴露服務物件

為服務物件設定HTTP呼叫器和你在Hessian或Burlap中使用的方式類似。就象為Hessian支援提供的 HessianServiceExporter，Spring的HTTP呼叫器提供了 org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter。為了暴露 AccountService（上述的），使用下面的配置：

<bean name="/AccountService" class="org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter">

<property name="service" ref="accountService"/>

<property name="serviceInterface" value="example.AccountService"/>

</bean>

17.4.2. 在客戶端連線服務

同樣，從客戶端連線業務與你使用Hessian或Burlap時所做的很相似。使用代理，Spring可以將你呼叫的HTTP POST請求轉換成被暴露服務的URL。

<bean id="httpInvokerProxy" class="org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean">

<property name="serviceUrl" value="http://remotehost:8080/AccountService"/>

<property name="serviceInterface" value="example.AccountService"/>

</bean>

就象上面說的一樣，你可以選擇使用你想使用的HTTP客戶端。預設情況下，HttpInvokerPropxy使用J2SE的HTTP功能，但是你也可以通過設定httpInvokerRequestExecutor屬性選擇使用Commons HttpClient：

<property name="httpInvokerRequestExecutor">

<bean class="org.springframework.remoting.httpinvoker.CommonsHttpInvokerRequestExecutor"/>

</property>

17.5. Web服務

Spring支援：

• 使用JAX-RPC暴露服務
• 訪問Web服務

除了上面所說的支援方法，你還可以用來暴露你的服務。XFire是一個輕量級的SOAP庫，目前在Codehaus開發。

17.5.1. 使用JAXI-RPC暴露服務

Spring對JAX-RPC Servlet的端點實現有個方便的基類 - ServletEndpointSupport。為暴露我們的Account服務，我們繼承了Spring的ServletEndpointSupport類來實現業務邏輯，這裡通常把呼叫委託給業務層。

/**

* 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

* RMI interfaces. 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 tool manages the life-cycle of instances

* of this class: A Spring application context can just be accessed here.

*/

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應用裡執行，以獲得對Spring的訪問能力。如果使用 Axis，把Axis的定義複製到你的web.xml中，並且在"server-config.wsdd"中設定端點（或使用釋出工具）。參看 JPetStore這個例子中OrderService是如何用Axis釋出成一個Web服務的。

17.5.2. 訪問Web服務

Spring有兩個工廠bean用來建立Web服務代理，LocalJaxRpcServiceFactoryBean 和 JaxRpcPortProxyFactoryBean。 前者只返回一個JAX-RPT服務類供我們使用。後者是一個全功能的版本，可以返回一個實現我們業務服務介面的代理。本例中，我們使用後者來為前面段落中 暴露的AccountService端點建立一個代理。你將看到Spring對Web服務提供了極好的支援，只需要很少的程式碼 - 大多數都是通過類似下面的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 是客戶端將要使用的遠端業務介面。wsdlDocumentUrl 是WSDL檔案的URL。Spring需要這些在啟動時建立JAX-RPC服務。namespaceUri 對應到.wsdl檔案中的targetNamespace。serviceName 對應到.wsdl檔案中的service name。portName 對應到.wsdl檔案中的埠號。

現在bean工廠將把Web服務暴露為 RemoteAccountService 介面，訪問服務變得很容易。我們可以在Spring中這樣組裝起來：

<bean id="client" class="example.AccountClientImpl">

...

<property name="service" ref="accountWebService"/>

</bean>

在客戶端我們可以使用類似於普通類的方式來訪問Web服務，區別是它丟擲RemoteException異常。

public class AccountClientImpl {

private RemoteAccountService service;

public void setService(RemoteAccountService service) {

this.service = service;

}

public void foo() {

try {

service.insertAccount(...);

} catch (RemoteException ex) {

// ouch

...

}

}

}

由於Spring提供了自動轉換成非受控異常的能力，我們可以不用考慮受控的RemoteException異常。這要求我們也提供一個非RMI介面，配置檔案現在如下：

<bean id="accountWebService" class="org.springframework.remoting.jaxrpc.JaxRpcPortProxyFactoryBean">

<property name="serviceInterface">

<value>example.AccountService</value>

</property>

<property name="portInterface">

<value>example.RemoteAccountService</value>

</property>

...

</bean>

這裡 serviceInterface 已經改成我們目前的非RMI介面。我們的RMI介面現在使用屬性 portInterface 進行定義。現在客戶端程式碼可以不用處理 java.rmi.RemoteException 異常：

public class AccountClientImpl {

private AccountService service;

public void setService(AccountService service) {

this.service = service;

}

public void foo() {

service.insertAccount(...);

}

}

17.5.3. 註冊bean對映

為了傳遞類似Account等複雜物件，我們必須在客戶端註冊bean對映。

Note

在伺服器端通常在server-config.wsdd中使用Axis進行bean對映註冊。

我們將使用Axis在客戶端註冊bean對映。為此，我們需要繼承一個Spring 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) {

相關推薦