©
本文檔使用 php中文網手册 發布
Hessian提供一种基于HTTP的二进制远程协议。它是由Caucho开发的,可以在 http://www.caucho.com 找到更多有关Hessian的信息。
Hessian使用一个特定的Servlet通过HTTP进行通讯。使用Spring在Web MVC中就常用的 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>/remotingimport 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应用里运行,以获得对Spring的访问能力。如果使用Axis,把AxisServlet
定义复制到你的'web.xml'
中,并且在'server-config.wsdd'
中设置端点(或使用发布工具)。参看JPetStore这个例子中OrderService
是如何用Axis发布成一个Web服务的。
Spring提供了两个工厂bean用来创建Web服务代理,LocalJaxRpcServiceFactoryBean
和 JaxRpcPortProxyFactoryBean
。前者只返回一个JAX-RPC服务类供我们使用。后者是一个全功能的版本,可以返回一个实现我们业务服务接口的代理。本例中,我们使用后者来为前面段落中暴露的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文件中的服务名。
portName
对应.wsdl文件中的端口号。
现在我们可以很方便的访问web服务,因为我们有一个可以将它暴露为RemoteAccountService
接口的bean工厂。我们可以在Spring中这样使用:
<bean id="client" class="example.AccountClientImpl"> ... <property name="service" ref="accountWebService"/> </bean>
从客户端代码上看,除了它抛出RemoteException
,我们可以把这个web服务当成一个普通的类进行访,。
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
,因为Spring将它自动转换成相应的非受控异常RemoteException
。这也需要我们提供一个非RMI的接口。现在配置文件如下:
<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接口现在使用portInterface
属性来定义。我们的客户端代码可以避免处理异常java.rmi.RemoteException
:
public class AccountClientImpl { private AccountService service; public void setService(AccountService service) { this.service = service; } public void foo() { service.insertAccount(...); } }
请注意你也可以去掉"portInterface"部分并指定一个普通业务接口作为"serviceInterface"。这样JaxRpcPortProxyFactoryBean
将自动切换到JAX-RPC "动态调用接口", 不使用固定端口存根来进行动态调用。这样做的好处是你甚至不需要使用一个RMI相关的Java接口(比如在非Java的目标web服务中);你只需要一个匹配的业务接口。查看JaxRpcPortProxyFactoryBean
的javadoc来了解运行时实行的细节。
T为了传递类似Account
等复杂对象,我们必须在客户端注册bean映射。
在服务器端通常在'server-config.wsdd'
中使用Axis进行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)); } }
本节中,我们将注册自己的javax.rpc.xml.handler.Handler
到Web服务代理,这样我们可以在SOAP消息被发送前执行定制的代码。Handler
是一个回调接口。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; } }
我们现在要做的就是把AccountHandler注册到JAX-RPC服务,这样它可以在消息被发送前调用 handleRequest(..)
。Spring目前对注册处理方法还不提供声明式支持,所以我们必须使用编程方式。但是Spring中这很容易实现,我们只需覆写专门为此设计的 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端点实现提供了一个方便的基类 - SpringBeanAutowiringSupport
。要暴露我们的AccountService
接口,我们可以扩展Spring的SpringBeanAutowiringSupport
类并实现我们的业务逻辑,通常把调用交给业务层。我们将简单的使用Spring 2.5的@Autowired
注解来声明依赖于Spring管理的bean。
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设施,我们的AccountServletEndpoint
类需要运行在同一个web应用中。在Java EE 5环境中这是默认的情况,它使用JAX-WS servlet端点安装标准契约。详情请参阅Java EE 5 web服务教程。
Sun JDK 1.6提供的内置JAX-WS provider 使用内置的HTTP服务器来暴露web服务。Spring的SimpleJaxWsServiceExporter
类检测所有在Spring应用上下文中配置的l@WebService
注解bean,然后通过默认的JAX-WS服务器(JDK 1.6 HTTP服务器)来暴露它们。
在这种场景下,端点实例将被作为Spring bean来定义和管理。它们将使用JAX-WS来注册,但其生命周期将一直跟随Spring应用上下文。这意味着Spring的显示依赖注入可用于端点实例。当然通过@Autowired
来进行注解驱动的注入也可以正常工作。
<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
类,也可能不是。因为这里的端点是由Spring完全管理的bean。这意味着端点实现可能像下面这样没有任何父类定义 - 而且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项目的一部分来开发,它使用了Spring支持来作为JAX-WS Commons项目的一部分。这允许把JAX-WS端点作为Spring管理的bean来定义。这与前面章节讨论的单独模式类似 - 但这次是在Servlet环境中。注意这在Java EE 5环境中是不可迁移的,建议在没有EE的web应用环境如Tomcat中嵌入JAX-WS RI。
与标准的暴露基于servlet的端点方式不同之处在于端点实例的生命周期将被Spring管理。这里在web.xml
将只有一个JAX-WS servlet定义。在标准的Java EE 5风格中(如上所示),你将对每个服务端点定义一个servlet,每个服务端点都代理到Spring bean (通过使用@Autowired
,如上所示)。
关于安装和使用详情请查阅https://jax-ws-commons.dev.java.net/spring/。
类似JAX-RPC支持,Spring提供了2个工厂bean来创建JAX-WS web服务代理,它们是LocalJaxWsServiceFactoryBean
和JaxWsPortProxyFactoryBean
。前一个只能返回一个JAX-WS服务对象来让我们使用。后面的是可以返回我们业务服务接口的代理实现的完整版本。这个例子中我们使用后者来为AccountService
端点再创建一个代理:
<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
是我们客户端将使用的远程业务接口。
wsdlDocumentUrl
是WSDL文件的URL. Spring需要用它作为启动点来创建JAX-RPC服务。
namespaceUri
对应.wsdl文件中的targetNamespace。
serviceName
对应.wsdl文件中的服务名。
portName
对应.wsdl文件中的端口号。
现在我们可以很方便的访问web服务,因为我们有一个可以将它暴露为AccountService
接口的bean工厂。我们可以在Spring中这样使用:
<bean id="client" class="example.AccountClientImpl"> ... <property name="service" ref="accountWebService"/> </bean>
从客户端代码上我们可以把这个web服务当成一个普通的类进行访问:
public class AccountClientImpl { private AccountService service; public void setService(AccountService service) { this.service = service; } public void foo() { service.insertAccount(...); } }
注意: 上面被稍微简化了,因为JAX-WS需要端点接口及实现类来使用@WebService
, @SOAPBinding
等注解。 这意味着你不能简单的使用普通的Java接口和实现来作为JAX-WS端点,你需要首先对它们进行相应的注解。这些需求详情请查阅JAX-WS文档。
XFire是一个Codehaus提供的轻量级SOAP库。暴露XFire是通过XFire自带的context,这个context将和RemoteExporter风格的bean相结合,后者需要被加入到在你的WebApplicationContext
中。对于所有让你来暴露服务的方法,你需要创建一个DispatcherServlet
类并有相应的WebApplicationContext
来封装你将要暴露的服务:
<servlet> <servlet-name>xfire</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> </servlet>
你还必须链接XFire配置。这是通过增加一个context文件到由ContextLoaderListener
(或者ContextLoaderServlet
)加载的 contextConfigLocations
参数中。
<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映射后(映射 缺省情况下,Spring EJB支持类的基类在其生命周期中将创建并加载一个Spring IoC容器供EJB使用(比如像前面获得POJO服务对象的代码)。加载的工作是通过一个策略对象完成的,它是 如JavaDoc中所述,有状态Session Bean在其生命周期中将会被钝化并重新激活,由于(一般情况下)使用了一个不可串行化的容器实例,不可以被EJB容器保存,
所以还需要手动在 有些情况下,要载入ApplicationContext以使用EJB组件, 然后需要创建一个名为 上例中,常量
protected void onEjbCreate() throws CreateException {
myComp = (MyComponent) getBeanFactory().getBean(
ServicesConstants.CONTEXT_MYCOMP_ID);
}
// for business method, delegate to POJO service impl.
public String myFacadeMethod(...) {
return myComp.myMethod(...);
}
...
}
BeanFactoryLocator
的子类。
默认情况下,实际使用的BeanFactoryLocator
的实现类是ContextJndiBeanFactoryLocator
,它根据一个被指定为JNDI环境变量的资源位置来创建一个ApplicationContext对象(对于EJB类,路径是
java:comp/env/ejb/BeanFactoryPath
)。如果需要改变BeanFactory或ApplicationContext的载入策略,我们可以在
setSessionContext()
方法调用或在具体EJB子类的构造函数中调用setBeanFactoryLocator()
方法来覆盖默认使用的
BeanFactoryLocator
实现类。具体细节请参考JavaDoc。
ejbPassivate
和ejbActivate
这两个方法中分别调用unloadBeanFactory()
和loadBeanFactory
,
才能在钝化或激活的时候卸载或载入。ContextJndiBeanFactoryLocator
的默认实现基本上足够了,
不过,当ApplicationContext
需要载入多个bean,或这些bean初始化所需的时间或内存
很多的时候(例如Hibernate的SessionFactory
的初始化),就有可能出问题,因为
每个EJB组件都有自己的副本。这种情况下,用户会想重载ContextJndiBeanFactoryLocator
的默认实现,并使用其它
BeanFactoryLocator
的变体,例如ContextSingletonBeanFactoryLocator
,他们可以载入并在多个EJB或者其客户端间共享一个容器。这样做相当简单,只需要给EJB添加类似于如下的代码:
public void setSessionContext(SessionContext sessionContext) {
super.setSessionContext(sessionContext);
setBeanFactoryLocator(ContextSingletonBeanFactoryLocator.getInstance());
setBeanFactoryLocatorKey(ServicesConstants.PRIMARY_CONTEXT_ID);
}
beanRefContext.xml
的bean定义文件。这个文件定义了EJB中所有可能用到的bean工厂(通常以应用上下文的形式)。许多情况下,这个文件只包括一个bean的定义,如下所示(文件businessApplicationContext.xml
包括了所有业务服务POJO的bean定义):<beans>
<bean id="businessBeanFactory" class="org.springframework.context.support.ClassPathXmlApplicationContext">
<constructor-arg value="businessApplicationContext.xml" />
</bean>
</beans>
ServicesConstants.PRIMARY_CONTEXT_ID
定义如下: public static final String ServicesConstants.PRIMARY_CONTEXT_ID = "businessBeanFactory";
BeanFactoryLocator
和类ContextSingletonBeanFactoryLocator
的更多使用信息请分别查看他们各自的Javadoc文档。
对EJB3 Session bean和Message-Driven Bean来说, Spring在EJB组件类
org.springframework.ejb.interceptor.SpringBeanAutowiringInterceptor
中提供了实用的拦截器来解析Spring2.5的注解@Autowired
。
这个拦截器的使用有两种方式,可以在EJB组件类里使用@Interceptors
注解,也可以在EJB部署描述文件中使用XML元素interceptor-binding
。
@Stateless @Interceptors(SpringBeanAutowiringInterceptor.class) public class MyFacadeEJB implements MyFacadeLocal { // automatically injected with a matching Spring bean @Autowired private MyComponent myComp; // for business method, delegate to POJO service impl. public String myFacadeMethod(...) { return myComp.myMethod(...); } ... }
SpringBeanAutowiringInterceptor
默认情况下是从ContextSingletonBeanFactoryLocator
获得目标bean的,后者定义在beanRefContext.xml
文件中。通常情况下,最好使用单独的上下文定义,并且根据类型而不是名称来获得。然而,如果你需要在多个上下文定义中切换,那么就需要一个特定的定位键。这个定位键(例如定义在beanRefContext.xml
中的上下文名称)可以通过以下两种方式来明确的指定。一种方式是在定制的SpringBeanAutowiringInterceptor
子类中重写getBeanFactoryLocatorKey
方法。
另一种方式是重写SpringBeanAutowiringInterceptor
的
getBeanFactory
方法,例如从定制支持类中获得一个共享的ApplicationContext
。