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


PC版本的WebService客户端类库非常丰富,例如,Axis2CXF等,但这些类库对于OPhone系统过于庞大,也未必很容易移植到OPhone系统上。因此,这些开发包并不在我们考虑的范围内。适合手机的WebService客户端类库也有一些。本例使用了比较常用的KSOAP2。读者可以从如下的地址下载Android版(OPhone SDK1.5也同样适用)的KSOAP2
 
le/p/ksoap2-android/downloads/list
 
将下载后的jar文件复制到Eclipse工程的lib目录中(如果没有该目录,可以新建一个,当然,也可以放在其他的目录中)。并在Eclipse工程中引用这个jar包,引用后的Eclipse工程目录结构如图1所示。
1 引用KSOAP2开发包

使用KSOAP2调用WebService


读者可按如下6步来调用WebService的方法。
1. 指定WebService的命名空间和调用的方法名,代码如下:
 
SoapObject request = new SoapObject("service", "getName"); 

SoapObject类的第1个参数表示WebService的命名空间,可以从WSDL文档中到WebService的命名空间。第2个参数表示要调用的WebService方法名。
 
2. 设置调用方法的参数值,这一步是可选的,如果方法没有参数,可以省略这一步。设置方法的参数值的代码如下:

request.addProperty("param1", "value1"); request.addProperty("param2", "value2"); 
要注意的是,addProperty方法的第1个参数虽然表示调用方法的参数名,但该参数值并不一定与服务端的WebService类中的方法参数名一致,只要设置参数的顺序一致即可。
 
3. 生成调用WebService方法的SOAP请求信息。该信息由SoapSerializationEnvelope对象描述,代码如下:
 
SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11); envelope.bodyOut = request; 

创建SoapSerializationEnvelope对象时需要通过SoapSerializationEnvelope类的构造方法设
SOAP协议的版本号。该版本号需要根据服务端WebService的版本号设置。在创建SoapSerializationEnvelope对象后,不要忘了设置SoapSerializationEnvelope类的bodyOut属性,该属性的值就是在第1步创建的SoapObject对象。
 
4. 创建HttpTransportSE对象。通过HttpTransportSE类的构造方法可以指定WebServiceWSDL文档的URL,代码如下:

HttpTransportSE ht = new HttpTransportSE("192.168.17.156:8080/axis2/services/SearchProductService?wsdl"); 

5. 使用call方法调用WebService方法,代码如下:

ht.call(null, envelope); 

call方法的第1个参数一般为null,第2个参数就是在第3步创建的SoapSerializationEnvelope对象。
 
6. 使用getResponse方法获得WebService方法的返回结果,代码如下:
 
SoapObject soapObject = (SoapObject) Response(); 

示例:通过WebService查询产品信息


本例涉及到一个WebService服务端程序和一个OPhone客户端程序。读者可直接将服务端程序(axis2目录)复制到<Tomcat安装目录>\webapps目录中,然后启动Tomcat,并在浏览器地址栏中输入如下的URL
localhost:8080/axis2
 
如果在浏览器中显示如图2所示的页面,说明服务端程序已经安装成功。

2 WebService主页面
 
这个服务端WebService程序是SearchProductService,实际上SearchProductService是一个Java类,只是利用Axis2将其映射成WebService。在该类中有一个getProduct方法。这个方法有一个String类型的参数,表示产品名称。该方法返回一个Product对象,该对象有3个属性:namepriceproductNumber。读者可以使用如下的URL来查看SearchProductServiceWSDL文档。
localhost:8080/axis2/services/SearchProductService?wsdl
 
显示WSDL文档的页面如图3所示。

3 WSDL文档
 
在图3中的黑框中就是WebService的命名空间,也是SoapObject类的构造方法的第1个参数值。这个WebService程序可以直接使用如下的URL进行测试。
localhost:8080/axis2/services/SearchProductService/getProduct?param0=iphone
 
测试的结果如图4所示。

4 测试getProduct方法
 
从图4所示的测试结果可以看出,Axis2getProduct方法返回的Product对象直接转换成了XML文档(实际上是SOAP格式)返回。
 
下面我们来根据前面介绍的使用KSOAP2的步骤来编写调用WebServiceOPhone客户端程序,代码如下:

package bile.wsclient; import org.ksoap2.SoapEnvelope; import org.ksoap2.serialization.SoapObject; import org.ksoap2.serialization.SoapSerializationEnvelope; import ansport.HttpTransportSE; import android.app.Activity; import android.os.Bundl
e; import android.view.View; import android.view.View.OnClickListener; import android.widget.Button; import android.widget.EditText; import android.widget.TextView; public class Main extends Activity implements OnClickListener { @Override public void onClick(View view) { EditText etProductName = (EditText)findViewById(ProductName); TextView tvResult = (TextView)findViewById(R.id.tvResult);   
                                                                                                                                                                               
                                                                                                                                                                           
 
 
        在编写上面代码时应注意如下两点:
 
在第2步中addProperty方法的第1个参数值是productName,该值虽然是getProduct方法的参
数名,但addProperty方法的第1个参数值并不限于productName,读者可以将这个参数设为其他的任何字符串(但该值必须在XML中是合法的,例如,不是设为“<”“>”XML预留的字符串)。
通过SoapObject类的getProperty方法可以获得Product对象的属性值,这些属性名就是图4所示的测试结果中的属性名。
        运行本例,在文本框中输入“htc hero”,单击【查询】按钮,会在按钮下方显示如图5所示的查询结果。


显示查询结果

防止UI组件阻塞


从功能上看,本文示例中给出的代码并没有任何问题。但可能有的读者会有这样的担心:如果调用WebService的用户很多,至使服务端响应迟缓;或服务端的IP根本就不对,那么在这
些情况下,用户界面的按钮和文本框组件岂不是象了一样无法响应用户的其他动作。当然,发生这种情况的可能性是有的,尤其是在复杂的网络环境中发生的可能性是很大的,一但发生这种事情,就会使整个软件系统在用户体验上变得非常糟糕。
用户和开发人员都希望改善这种糟糕的情况。最理想的状态是单击按钮调用WebService方法时,即使由于某种原因,WebService方法并未立即返回,界面上的组件仍然会处于活动状态,也就是说,用户仍然可以使用当前界面中的其他组件。
 
OPhone中可以采用异步的方式来达到这个目的。异步实际上就是通过多线程的方式来实现。一般使用new Thread(this).start()来创建和开始一个线程。但本节并不使用Thread来实现异步,而是通过AsyncTask类使要执行的任务(调用WebService)在后台执行。
 
下面先看看改进后的代码。
 
package bile.wsclient; import org.ksoap2.SoapEnvelope; import org.ksoap2.serialization.SoapObject; import org.ksoap2.serialization.SoapSerializationEnv
elope; import ansport.HttpTransportSE; import android.app.Activity; import android.os.AsyncTask; import android.os.Bundle; import android.view.View; import android.view.View.OnClickListener; import android.widget.Button; import android.widget.EditText; import android.widget.TextView; public class Main extends Activity implements OnClickListener { private EditText etProductName; private TextView tvResult; class WSAsyncTask extends AsyncTask { String result = ""; @Override protectedObject params) 
        { 
            try 
            { 
                String serviceUrl = "192.168.17.156:8080/axis2/services/SearchProductService?wsdl"; 
                String methodName = "getProduct"; 
                SoapObject request = new SoapObject("service", 
                        methodName); 
                request.addProperty("productName", Text().toString()); 
                SoapSerializationEnvelope envelope = new SoapSerializationEnvelope( 
                        SoapEnvelope.VER11); 
                envelope.bodyOut = request; 
                HttpTransportSE ht = new HttpTransportSE(serviceUrl); 
   
                ht.call(null, envelope); 
                if (Response() != null) 
                { 
                    SoapObject soapObject = (SoapObject) Response(); 
                    result = "产品名称:" + Property("name") + "\n"; 
                    result += "产品数量:" + Property("productNumber") 
                            + "\n"; 
                    result += "产品价格:" + Property("price"); 
   
                } 
                else 
                { 
                    result = "无此产品."; 
                } 
            } 
            catch (Exception e) 
            { 
                result = "调用WebService错误."; 
            } 
            // 必须使用post方法更新UI组件 
            tvResult.post(new Runnable() 
            { 
                @Override 
                public void run() 
                { 
                    tvResult.setText(result); 
   
                } 
            }); 
            return null; 
        } 
   
    } 
    @Override 
    public void onClick(View view) 

    // 异步执行调用WebService的任务   
        new WSAsyncTask().execute(); 
    } 
    @Override 
    public void onCreate(Bundle savedInstanceState) 
eclipse安装教程tomcat    { 
        Create(savedInstanceState); 
        setContentView(R.layout.main); 
        Button btnSearch = (Button) findViewById(R.id.btnSearch); 
        btnSearch.setOnClickListener(this); 
        etProductName = (EditText) findViewById(ProductName); 
        tvResult = (TextView) findViewById(R.id.tvResult); 
   
    } 

调用WebService的核心代码与示例中的代码完全一样,在这里就不再做具体的介绍了。但在编写上面的代码时还需要注意如下几点。
 
1. 一般需要编写一个AsyncTask的子类来完成后台执行任务的工作。
2.  AsyncTask的核心方法是doInBackground,当调用AsyncTask类的execute方法时,doInBackground方法会异步执行。因此,可以将执行任务的代码写在doInBackground方法中。
3. 由于本例中的TextView组件是在主线程(UI线程)中创建的,因此,在其他的线程(doInBackground方法所在的线程)中不能直接更新TextVew组件。为了更新TextView组件,需要使用TextView类的post方法。该方法的参数是一个Runnable对象,需要将更新TextView组件的代码写在Runnable接口的run方法中。
4. 虽然不能在其他线程中更新UI组件,但可以从其他线程直接读取UI组件的值。例如,在doInBackground方法中直接读取了EditText组件的值。
5. 调用AsyncTask类的execute方法后会立即返回。execute方法的参数就是doInBackground方法的参数。doInBackground方法的返回值可以通过ute(...).get()方法获得。
读者可以将本例中的IP改成其他的值,看看单击按钮后,是否还可在文本框中输入其他的内容。如果这个IP是正确的,并且WebService可访问,那么会在TextView组件中输出相应的返
回值。

总结


本文主要介绍了如何使用KSOAP2来调用WebServiceKSOAP2是第三方开发的专门用于在移动设备调用WebService的类库。使用KSOAP2调用WebService可分为6步来完成,其中主要使用了SoapObject对象来指定了要调用的方法,然后通过HttpTransportSE对象的call方法来调用WebService的方法,最后通过getResponse方法返回结果。读者可以通过本文提供的完整示例来体会使用KSOAP2调用WebService的完整过程。在最后还介绍了如何通过异步调用WebService的方式来防止因服务端故障或其他原因导致的UI组件阻塞。

作者介绍


李宁:东北大学软件学院工程硕士。拥有超过10年的软件开发经验。曾任国内某知名企业项目经理。曾领导并参与开发了多个大中型项目。从2005年进入写作领域以来,为程序员、电脑编程技巧与维护、电脑报、IT168、天极网等平面媒体和网络媒体撰写了一百多篇原创技术和评论文章。并在个人 blognokiaguy.blogjava)上发表了大量的原创技术文章。2008年曾获得《电脑编程技巧与维护》优秀作者奖。曾独立编写了《Java Web开发技术大全》和《Java Web开发速学宝典》两本书。本人擅长AndroidOPhoneJava MEJava EE等技术。
***************************************************************************************
End
android 利用ksoap2方式连接webservice(2010-04-16 16:36:25)转载标签:androidksoap2webserviceit 分类:Android
    利用J2SE的ksoap2标准,我也来做一个山寨版本的android连接webservice。因为soap封装的关系,android application在接收到数据后不能够正确的按照J2SE的标准来获取。

    在运用之前,我们先要引导两个jar进入工程的buildpath
   
    这两个jar包都可以在网上查到下载,引导完后再做一项准备工作。弄清楚已发布的webservice的地址,以及封装的方式。比如:

webservice接口:192.168.0.2:8080/axis2/services/Manager?wsdl  (顺便说明一下,在android当中,不能写localhost,必须写清楚PC机当前的网络IP)
webservice封装:/axis2

都了解了过后,说明已经做好准备了。
    下面就介绍一下android如何获取webservice封装数据。。

引入ksoap2中以封装好的类
import org.ksoap2.SoapEnvelope;
import org.ksoap2.serialization.SoapObject;
import org.ksoap2.serialization.SoapSerializationEnvelope;
import ansport.AndroidHttpTransport;

在类中定义webservice的接口地址以及解析方式并且定义要调用的webservice中的函数
private static final String URL = "192.168.0.2:8080/axis2/services/Manager?wsdl";
private static final String NAMESPACE = "/axis2";
private static final String METHOD_NAME = "GetMyFriends";

这个信息我们可以在webservice中查到
<xs:element name="GetMyFriends">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="userId" type="xs:int"/>
<xs:element minOccurs="0" name="password" nillable="true" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>

接下来开始做对webservice请求数据的工作,请求webservice函数以及封装要用的两个参数(userId和password)
    SoapObject request = new SoapObject(NAMESPACE, METHOD_NAME);
    request.addProperty("userId", "123456");
    request.addProperty("password", "test");
之后我们给定义发送数据的信封的封装格式
SoapSerializationEnvelope envelope = new SoapSerializationEnvelope( SoapEnvelope.VE
R11 );
发出请求
envelope.setOutputSoapObject(request);
AndroidHttpTransport aht = new AndroidHttpTransport(URL);
aht.call(null, envelope);

接着就可以定义一个SoapObject类型的实例去获取我们返回来的数据
SoapObject so = (SoapObject) envelope.bodyIn;
这里如果是返回来的数据只有一行并且只有一个值,比如验证函数,返回boolean类型的话,操作比较简单,String getReturn= so.getProperty("return");  这个getReturn就是你要获取的值。
但是如果返回来是多行的值的话,这个方法就不行了,我们必须对返回来的信息做一些解析。我曾试过用J2SE的标准方式来获取,但是会报错,最主要的可能是他的方式在android当中不能使用。所以在这里我用了正则表达式这种方式来进行数据的解析,我们先来看一下他返回的数据的结构是什么情况。
GetMyFriendsResponse{return=FriendsMessage{
permitList=anyType{nickName=我爱罗; singnature=null; userId=2; }; permitList=anyType{nickName=jack; singnature=null; userId=1004; }; permitList=anyType{nickName=admin; singnature=leo_admin; userId=1001; };};}
简单看他很想Json结构,但是确不是。。。
就目前的解决方式,我只是通过规律来进行了正则表达式的解析:如解析上面的内容。

            //首先取得permitList(好友)的个数
            String testPattern = "permitList";
            int resultlength = result.length();
            cresult = place(testPattern, "");
            int lastlength = (resultlength - cresult.length()) / testPattern.length();
         
            //取得每个permitList中的值。
            String LoginReturn="", pattern="nickName=.*?;\\s*singnature=.*?;\\s*userId=.*?;";
            //动态生成String 数组,存储每个好友的信息
            String[] GetFinalReturn = new String[lastlength];
            for (int i=0;i<lastlength;i++){
                LoginReturn = placeFirst("^.*("+pattern+").*$", "$1");
                GetFinalReturn[i] = LoginReturn;
                result = place(LoginReturn,"");
            }
这个数组里面存储的格式就是nickName=admin; singnature=leo_admin; userId=1001;
这样以来,我们可以根据"="和";"两个符号之间做split操作就可以得到数据。

好了,到此连接webservice和解析返回来的数据的工作就做完了,虽然这个方式看起来很复杂,但是目前来说,用ksoap2方式来连接webservice暂时还没有到更有效的解决方式。。

转载此文,请说明出处,谢谢。
blog.sina/s/blog_48b61dc70100i7a7.html