当前位置：文档库 > Ksoap的使用详解

Ksoap的使用详解

[j2me]kSOAP的运用

1．概述

对于J2ME访问远端的Web Service，除了官方标准JSR 172，我们还有两种选择：

●

kSOAP

Wingfoot

●

Wingfoot是由Wingfoot Software(http://www.wendangku.net/doc/8957820b7cd184254b353543.html)出品的一款J2ME(C LDC/CDC) SOAP1.1的轻量级实现方案。

kSOAP是http://www.wendangku.net/doc/8957820b7cd184254b353543.html的一个开源作品，是EnhydraME项目的一部分。基于http://www.wendangku.net/doc/8957820b7cd184254b353543.html出品的开源通用XML解析器kXML，kSOAP完成了J2ME/ MIDP平台上的SOAP解析和调用工作。

Stefan Haustein领导的kSOAP开发小组于2001年5月17日推出了A lhpa版本。之后又经过了一年的开发，2002年6月6日推出的kSOAP 1.2支持了SOAP1.2规范。2003年8月25日推出的kSOAP2，对SOAP序列化规范支持得更好了。

大多数人选择kSOAP的原因是，kSOAP虽然在2003年8月之后就不再维护了，但它是Open Source的，很容易加入增强特性，比如说默认情况下kSO AP2仅仅支持cmnet接入点，可以修改kSOAP2的HttpTransport.java代码增加对cmwap接入点的支持。

下载提示：

kSOAP当前有两个版本：1.2和2.0。

官方网站：http://www.wendangku.net/doc/8957820b7cd184254b353543.html/

kSOAP2.0还有一个优点是，改进了对Microsoft dotNET的兼容。以前有很多人抱怨kSOAP调用dotNET编写的Web Service时遇到了不少的困扰。

本章节我们将使用kSOAP 2.0的例子来讲解。

为了使用kSOAP 2.0，必须还要下载工具包kXML2。

下载提示：

kXML当前有两个版本：1.21和2.0。

官方网站：http://www.wendangku.net/doc/8957820b7cd184254b353543.html/

Ksoap的使用详解

SoapSerializationEnvelope是kSOAP2新增加的类，是对SoapEnvelope 的扩展，对SOAP序列化(Serialization)格式规范提供了支持，能够对简单对象自动进行序列化(simple object serialization)。而kSOAP1.x则是通过org.ksoap.ClassMap来做序列化的，不太好操作，也不利于扩展。

SoapObject让你自如地构造SOAP调用；

HttpTransport为你屏蔽了Internet访问/请求和获取服务器SOAP的细节。

下面我们通过一个最简单的webservice调用，来看看kSOAP是如何做到SO AP解析的：

2．1．kSOAP和Web Service之间传递String

Ksoap的使用详解

kSOAP是如何调用这个webservice的呢？

首先要使用SoapObject，这是一个高度抽象化的类，完成SOAP调用。可以调用它的addProperty（）方法填写要调用的webservice方法的参数。

如下面代码所示：

SoapObject request = new SoapObject(serviceNamespace, meth odName);

SoapObject构造函数的两个参数含义为：

serviceNamespace –你的webservice的命名空间，既可以是

http://localhost:8088/flickrBuddy/services/Buddycast这样的，也可以是

urn:PI/DevCentral/SoapService这样的；

methodName –你要调用方法的名字。

然后，按照webservice方法参数的顺序，依次调用

request.addProperty( "username", "user" );

request.addProperty( "password", "pass" );

来填充webservice参数。

注意：

建议webservice的方法传递的参数尽量用string类型。即使是int类型，kSOAP2与Java编写的webservice也有可能交互发生异常。

对于webservice方法返回String类型的情况，还用不着开发者做序列化(S erialization)定制工作。

要点：

kSOAP 1.X/2.0可以自动把四种SOAP类型映射为Java类型

SOAP type Java type

xsd:int http://www.wendangku.net/doc/8957820b7cd184254b353543.htmlng.Integer

xsd:long http://www.wendangku.net/doc/8957820b7cd184254b353543.htmlng.Long

xsd:string http://www.wendangku.net/doc/8957820b7cd184254b353543.htmlng.String

xsd:boolean http://www.wendangku.net/doc/8957820b7cd184254b353543.htmlng.Boolean

除此之外，都需要开发者自己做类型映射。

然后要告诉SoapSerializationEnvelope把构造好的SoapObject封装进去：SoapSerializationEnvelope envelope =

new SoapSerializationEnvelope(SoapEnvelope.VER11); envelope.bodyOut = request;

要点：

你可以通过SoapSerializationEnvelope或者SoapEnvelope的构造函数来指明你要用SOAP的哪一个规范，可以是以下几种之一：

常量SoapEnvelope.VER10：对应于SOAP 1.0规范

常量SoapEnvelope.VER11：对应于SOAP 1.1规范

常量SoapEnvelope.VER12：对应于SOAP 1.2规范

这样，无论要调用的webservice采用了哪一个SOAP规范，你都可以轻松应

对。

接下来就要声明

HttpTransport tx = new HttpTransport(serviceURL);

ht.debug = true;

HttpTransport构造函数的参数含义为：

serviceURL –要投递SOAP数据的目标地址，譬如说

http://www.wendangku.net/doc/8957820b7cd184254b353543.html/onca/soap3。

HttpTransport是一个强大的辅助类，来完成Http-call transport process，它封装了网络请求的一切，你完全不用考虑序列化消息。我们通过设置它的debug属性为true来打开调试信息。

方法HttpTransport.call()自己就能够发送请求给服务器、接收服务器响应并序列化SOAP消息，如下所示：

ht.call(null, envelope);

HttpTransport的call方法的两个参数含义为：

soapAction –SOAP 规范定义了一个名为SOAPAction 的新HTTP 标头，所有SOAP HTTP 请求（即使是空的）都必须包含该标头。SOAPAction 标头旨在表明该消息的意图。通常可以置此参数为null，这样HttpTransport就会设置HTTP标头SOAPAction为空字符串。

Envelope –就是前面我们构造好的SoapSerializationEnvelope或SoapEnvelope对象。

注意：

对于HttpTransport的处理上，kSOAP2和kSOAP1.2的写法不一样。

对于kSOAP 1.2，HttpTransport的构造函数是HttpTransport (String url, String soapAction)，第二个参数soapAction可以是要调用的webservice方法名。

而kSOAP 2，构造函数是HttpTransport(String url)。kSOAP2相当于把

webservice方法名分离出去，完全交给SoapObject去封装，而HttpTransport仅仅负责把SoapEnvelope发送出去并接收响应，这样更合理一些。

调用call方法是一个同步过程，需要等待它返回。

返回之后，就可以调用SoapSerializationEnvelope的getResult方法来获取结果了：

Object Response = envelope.getResult();

如果HttpTransport的debug属性为true，那么此时就可以通过

System.out.println("Response dump>>" + tx.responseDump);

打印出HttpTransport的调试信息。尤其当前面call方法和getResult方法发生异常时，这个调试信息是非常有用的。

前面我们的webservice方法由于是返回string，所以得到这个string值就非常简单了：

String sResponse = Response.ToString();

注意：

由于HttpTransport类实际上是调用了HttpConnection作网络连接，所以必须另起一个线程来专门做kSOAP工作，否则会堵塞操作。

Ksoap的使用详解

{

destroyApp(false);

notifyDestroyed();

}

if (c == connectCommand)

{

// 匿名内部Thread，调用kSOAP2访问远程服务。

Thread webserviceThread = new Thread() {

public void run(){

try {

String serviceNamespace = "http://localhost:8080/SimpleWS/services/SimpleKSoapWS";

String methodName = "foo";

String serviceURL = "http://localhost:8080/SimpleWS/services/SimpleKSoapWS";

SoapObject request = new SoapObject(serviceNamespace, methodName);

request.addProperty( "username", "user" );

request.addProperty( "password", "pass" );

SoapSerializationEnvelope envelope =new SoapSerializationEnvelope(SoapEnvelope.VER envelope.bodyOut = request;

HttpTransport ht = new HttpTransport(serviceURL);

ht.debug = true;

ht.call(null, envelope);

Object Response = envelope.getResult();/*

* 必要时打印出tx.responseDump来观察soap是否正确工作*/

System.out.println("dump>>" + tx.responseDump);

String sResponse =Response.ToString();

}

catch (Exception e) { e.printStackTrace ();}

}

};

Ksoap的使用详解

2．2．webservice返回复杂描述的情况

kSOAP2处理webservice简单的string类型返回值是很容易的。那么如何处理像亚马逊网上书店这种webservice返回的复杂描述呢？

kSOAP2自带了一个例子来说明，下面我们就讲解一下。

关于亚马逊的查询书目的webservice，你可以通过

http://www.wendangku.net/doc/8957820b7cd184254b353543.html/schemas3/AmazonWebServices.wsdl

来获知定义。

我们要关注的是它的关键词查询请求的方法，它的定义是：

encodingStyle=http://www.wendangku.net/doc/8957820b7cd184254b353543.html/soap/encoding/namespac

e="http://www.wendangku.net/doc/8957820b7cd184254b353543.html" />

input>

encodingStyle=http://www.wendangku.net/doc/8957820b7cd184254b353543.html/soap/encoding/namespace

="http://www.wendangku.net/doc/8957820b7cd184254b353543.html" />

output>

operation>

我们提交对包含指定关键词的书目查询，如果查询成功，将会返回一系列书名节点，每一本书都提供了作者、出版社、出版日期、价格等等信息。

这些书名节点都在一个“Details”节点下。查询结果的总数放在TotalRes

ults节点。每页10个结果，可以通过查看TotalPages节点来确定需要多少页。

那么，kSOAP2可以很简单地通过SoapObject的getProperty方法来得到书详细信息的节点，存储入一个Vector对象中，如下所示：HttpTransport ht = new HttpTransport("http://www.wendangku.net/doc/8957820b7cd184254b353543.html/o nca/soap3");

ht.call(null, envelope);

SoapObject result = (SoapObject) envelope.getResult();

Vector resultVector = (Vector) result.getProperty("Details"); Vector对象中实际上还是存储了一组SoapObject对象，这里的每一个So apObject对象对应于一本书的DOM对象。

那么如何得到每一本书的书名、价格呢？

for(int i = 0; i < resultVector.size(); i++){

SoapObject detail = (SoapObject) resultVector.elementAt(i);

System.out.println("书名>>"+(String) detail.getProperty("Product Name"));

System.out.println("日期>>"+(String) detail.getProperty("Releas eDate"));

System.out.println("价格>>"+(String) detail.getProperty("ListPri ce"));

}

这样就可以了。

需要注意的是，要测试这个工程，必须到亚马逊的http://www.amazon.co m/webservice注册获取Access Key ID，也就是webservice方法中的“d evtag”参数所需要的Developer-Tag。