原文地址: WebService大讲堂之Axis2(5):会话(Session)管理
上一篇: WebService大讲堂之Axis2(4):二进制文件传输
下一篇: WebService大讲堂之Axis2(6):跨服务会话(Session)管理
WebService给人最直观的感觉就是由一个个方法组成,并在客户端通过 SOAP协议调用这些方法。这些方法可能有返回值,也可能没有返回值。虽然这样可以完成一些工具,但这些被调用的方法是孤立的,当一个方法被调用后,在其他的方法中无法获得这个方法调用后的状态,也就是说无法保留状态。
读者可以想象,这对于一个完整的应用程序,无法保留状态,就意味着只依靠 WebService很难完成全部的工作。例如,一个完整的应用系统都需要进行登录,这在 Web应用中使用 Session来保存用户登录状态,而如果用 WebService的方法来进行登录处理,无法保存登录状态是非常令人尴尬的。当然,这也可以通过其他的方法来解决,如在服务端使用 static变量来保存用户状态,并发送一个 id到客户端,通过在服务端和客户端传递这个 id来取得相应的用户状态。这非常类似于 Web应用中通过 Session和 Cookie来管理用户状态。但这就需要由开发人员做很多工作,不过幸好 Axis2为我们提供了 WebService状态管理的功能。
使用 Axis2来管理 WebService的状态基本上对于开发人员是透明的。在 WebService类需要使用 org.apache.axis2.context.MessageContext和 org.apache.axis2.context.ServiceContext类来保存与获得保存在服务端的状态信息,这有些象使用 HttpSession接口的 getAttribute和 setAttribute方法获得与设置 Session域属性。
除此之外,还需要修改 services.xml文件的内容,为 <service>元素加一个 scope属性,该属性有四个可取的值: Application, SOAPSession, TransportSession, Request ,不过要注意一下,虽然 Axis2的官方文档将这四个值的单词首字母和缩写字母都写成了大写,但经笔者测试,必须全部小写才有效,也就是这四个值应为: application、 soapsession、 transportsession、 request,其中 request为 scope属性的默认值。读者可以选择使用 transportsession和 application分别实现同一个 WebService类和跨 WebService类的会话管理。
在客户端需要使用 setManageSession(true)打开 Session管理功能。
综上所述,实现同一个 WebService的 Session管理需要如下三步:
1. 使用 MessageContext和 ServiceContext 获得与设置 key-value对。
2. 为要进行 Session管理的 WebService类所对应的 <service>元素添加一个 scope属性,并将该属性值设为 transportsession 。
3. 在客户端使用 setManageSession(true)打开 Session管理功能。
下面是一个在同一个 WebService类中管理 Session的例子。
先建立一个WebService类,代码如下:
package
service;
import
org.apache.axis2.context.ServiceContext;
import
org.apache.axis2.context.MessageContext;
public
class
LoginService
{
public
boolean
login(String username, String password)
{
if
(
"
bill
"
.equals(username)
&&
"
1234
"
.equals(password))
{
//
第1步:设置key-value对
MessageContext mc
=
MessageContext.getCurrentMessageContext();
ServiceContext sc
=
mc.getServiceContext();
sc.setProperty(
"
login
"
,
"
成功登录
"
);
return
true
;
}
else
{
return
false
;
}
}
public
String getLoginMsg()
{
//
第1步:获得key-value对中的value
MessageContext mc
=
MessageContext.getCurrentMessageContext();
ServiceContext sc
=
mc.getServiceContext();
return
(String)sc.getProperty(
"
login
"
);
}
}
在 LoginService类中有两个方法: login和 getLoginMsg,如果 login方法登录成功,会将“成功登录”字符串保存在 ServiceContext对象中。如果在 login方法返回 true后调用 getLoginMsg方法,就会返回“成功登录”。
下面是 LoginService类的配置代码( services.xml):
<!--
第2步:添加scope属性
-->
<
service
name
="loginService"
scope
="transportsession"
>
<
description
>
登录服务
</
description
>
<
parameter
name
="ServiceClass"
>
service.LoginService
</
parameter
>
<
messageReceivers
>
<
messageReceiver
mep
="http://www.w3.org/2004/08/wsdl/in-out"
class
="org.apache.axis2.rpc.receivers.RPCMessageReceiver"
/>
</
messageReceivers
>
</
service
>
使用如下的命令生成客户端使用的 stub类:
%AXIS2_HOME%\bin\wsdl2java -uri http://localhost:
8080
/axis2/services/loginService?wsdl -p client -s -o stub
在 stub\src\client目录中生成了一个 LoginServiceStub.java类,在该类中找到如下的构造句方法:
public
LoginServiceStub(org.apache.axis2.context.ConfigurationContext configurationContext,
java.lang.String targetEndpoint,
boolean
useSeparateListener)
throws
org.apache.axis2.AxisFault
{
![](https://i-blog.csdnimg.cn/blog_migrate/9b8a8a44dd1c74ae49c20a7cd451974e.gif)
_serviceClient.getOptions().setSoapVersionURI(
org.apache.axiom.soap.SOAP12Constants.SOAP_ENVELOPE_NAMESPACE_URI);
}
在该方法中最后添加如下的代码:
//
第3步:打开客户端的Session管理功能
_serviceClient.getOptions().setManageSession(
true
);
下面的客户端代码使用 LoginServiceStub对象访问了刚才建立的 WebService:
LoginServiceStub stub
=
new
LoginServiceStub();
LoginServiceStub.Login login
=
new
LoginServiceStub.Login();
login.setUsername(
"
bill
"
);
login.setPassword(
"
1234
"
);
if
(stub.login(login).local_return)
{
System.out.println(stub.getLoginMsg().local_return);
}
运行上面的代码后,会输出“成功登录”信息。