×

在Android 中使用KSOAP2调用WebService(1)

Kalet Kalet 发表于2013-12-25 22:43:41 浏览337 评论0

抢沙发发表评论

WebService 是一种基于SOAP协议的远程调用标准。通过WebService可以将不同操作系统平台,不同语言、不同技术整合到一起。在Android SDK中并没有提供调用WebService的库,因此,需要使用第三方类库(KSOAP2)来调用WebService。在本文将介绍在Android 中调用WebService的具体细节,并在最后给出一个完整的例子来演示如何使用KSOAP2来调用WebService。

安装第三方类库:KSOAP2
        PC版本的WebService客户端类库非常丰富,例如,Axis2、CXF等,但这些类库对于Android系统过于庞大,也未必很容易移植到 Android系统上。因此,这些开发包并不在我们考虑的范围内。适合手机的WebService客户端类库也有一些。本例使用了比较常用的 KSOAP2。读者可以从如下的地址下载Android版的KSOAP2。
 http://code.google.com/p/ksoap2-android/downloads/list?can=1&q=&colspec=Filename+Summary+Uploaded+Size+DownloadCount

 

 
       将下载后的jar文件复制到Eclipse工程的lib目录中(如果没有该目录,可以新建一个,当然,也可以放在其他的目录中)。并在Eclipse工程中引用这个jar包,引用后的Eclipse工程目录结构如图1所示。
图1 引用KSOAP2开发包
 
使用KSOAP2调用WebService
       读者可按如下6步来调用WebService的方法。
1. 指定WebService的命名空间和调用的方法名,代码如下:
1SoapObject request = new SoapObject("http://service", "getName");
    SoapObject类的第1个参数表示WebService的命名空间,可以从WSDL文档中找到WebService的命名空间。第2个参数表示要调用的WebService方法名。
 
2. 设置调用方法的参数值,这一步是可选的,如果方法没有参数,可以省略这一步。设置方法的参数值的代码如下:
1request.addProperty("param1", "value1"); 
2request.addProperty("param2", "value2");
   要注意的是,addProperty方法的第1个参数虽然表示调用方法的参数名,但该参数值并不一定与服务端的WebService类中的方法参数名一致,只要设置参数的顺序一致即可。
 
3. 生成调用WebService方法的SOAP请求信息。该信息由SoapSerializationEnvelope对象描述,代码如下:
1SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11); 
2envelope.bodyOut = request;
 
      创建SoapSerializationEnvelope对象时需要通过SoapSerializationEnvelope类的构造方法设置SOAP协 议的版本号。该版本号需要根据服务端WebService的版本号设置。在创建SoapSerializationEnvelope对象后,不要忘了设置 SoapSerializationEnvelope类的bodyOut属性,该属性的值就是在第1步创建的SoapObject对象。
 
4. 创建HttpTransportSE对象。通过HttpTransportSE类的构造方法可以指定WebService的WSDL文档的URL,代码如下:
1HttpTransportSE ht =  
2    new HttpTransportSE("http://192.168.17.156:8080/axis2/services/SearchProductService?wsdl");
5. 使用call方法调用WebService方法,代码如下:
 
1ht.call(null, envelope);
call方法的第1个参数一般为null,第2个参数就是在第3步创建的SoapSerializationEnvelope对象。
 
6. 使用getResponse方法获得WebService方法的返回结果,代码如下:
1SoapObject soapObject = (SoapObject) envelope.getResponse();
示例:通过WebService查询产品信息
        本例涉及到一个WebService服务端程序和一个OPhone客户端程序。读者可直接将服务端程序(axis2目录)复制到<Tomcat安装目录>\webapps目录中,然后启动Tomcat,并在浏览器地址栏中输入如下的URL:
http://localhost:8080/axis2
 
        如果在浏览器中显示如图2所示的页面,说明服务端程序已经安装成功。
surface view2.png
图2 WebService主页面
 
        这个服务端WebService程序是SearchProductService,实际上SearchProductService是一个Java类,只 是利用Axis2将其映射成WebService。在该类中有一个getProduct方法。这个方法有一个String类型的参数,表示产品名称。该方 法返回一个Product对象,该对象有3个属性:name、price和productNumber。读者可以使用如下的URL来查看 SearchProductService的WSDL文档。
http://localhost:8080/axis2/services/SearchProductService?wsdl
 
       显示WSDL文档的页面如图3所示。
surface view3.png
图3 WSDL文档
 
         在图3中的黑框中就是WebService的命名空间,也是SoapObject类的构造方法的第1个参数值。这个WebService程序可以直接使用如下的URL进行测试。
http://localhost:8080/axis2/services/SearchProductService/getProduct?param0=iphone
 
        测试的结果如图4所示。
surface view4.png
图4 测试getProduct方法
 
        从图4所示的测试结果可以看出,Axis2将getProduct方法返回的Product对象直接转换成了XML文档(实际上是SOAP格式)返回。
 
       下面我们来根据前面介绍的使用KSOAP2的步骤来编写调用WebService的OPhone客户端程序,代码如下:
01package net.blogjava.mobile.wsclient; 
02    
03import org.ksoap2.SoapEnvelope; 
04import org.ksoap2.serialization.SoapObject; 
05import org.ksoap2.serialization.SoapSerializationEnvelope; 
06import org.ksoap2.transport.HttpTransportSE; 
07import android.app.Activity; 
08import android.os.Bundle; 
09import android.view.View; 
10import android.view.View.OnClickListener; 
11import android.widget.Button; 
12import android.widget.EditText; 
13import android.widget.TextView; 
14    
15public class Main extends Activity implements OnClickListener 
16
17    @Override 
18    public void onClick(View view) 
19    
20        EditText etProductName = (EditText)findViewById(R.id.etProductName); 
21        TextView tvResult = (TextView)findViewById(R.id.tvResult); 
22        // WSDL文档的URL,192.168.17.156为PC的ID地址 
23        String serviceUrl = "http://192.168.17.156:8080/axis2/services/SearchProductService?wsdl"
24        // 定义调用的WebService方法名 
25        String methodName = "getProduct"
26        // 第1步:创建SoapObject对象,并指定WebService的命名空间和调用的方法名 
27        SoapObject request = new SoapObject("http://service", methodName); 
28        // 第2步:设置WebService方法的参数 
29        request.addProperty("productName", etProductName.getText().toString()); 
30        // 第3步:创建SoapSerializationEnvelope对象,并指定WebService的版本 
31        SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11); 
32        // 设置bodyOut属性 
33        envelope.bodyOut = request; 
34        // 第4步:创建HttpTransportSE对象,并指定WSDL文档的URL 
35        HttpTransportSE ht = new HttpTransportSE(serviceUrl);         
36        try 
37        {  
38            // 第5步:调用WebService 
39            ht.call(null, envelope); 
40            if (envelope.getResponse() != null
41            
42                // 第6步:使用getResponse方法获得WebService方法的返回结果 
43                SoapObject soapObject = (SoapObject) envelope.getResponse(); 
44                // 通过getProperty方法获得Product对象的属性值 
45                String result = "产品名称:" + soapObject.getProperty("name") + "\n"
46                result += "产品数量:" + soapObject.getProperty("productNumber") + "\n"
47                result += "产品价格:" + soapObject.getProperty("price"); 
48                tvResult.setText(result); 
49    
50            
51            else 
52                tvResult.setText("无此产品."); 
53            
54        
55        catch (Exception e) 
56        
57        
58    
59    @Override 
60    public void onCreate(Bundle savedInstanceState) 
61    
62        super.onCreate(savedInstanceState); 
63        setContentView(R.layout.main); 
64        Button btnSearch = (Button) findViewById(R.id.btnSearch); 
65        btnSearch.setOnClickListener(this); 
66    
67}
   在编写上面代码时应注意如下两点:
 

群贤毕至

访客