本文主要介绍android客户端如何使用webservice。第一篇介绍ksoap2，第二篇介绍rest。
android基础知识10：webservice 01:KSOAP2
android基础知识10：webservice 02:REST
1、webservice概述
本部分内容来源于《http://www.w3school.com.cn/webservices/index.asp》
1.1 什么是Web Services？
- Web Services 是应用程序组件
- Web Services 使用开放协议进行通信
- Web Services 是独立的（self-contained）并可自我描述
- Web Services 可通过使用UDDI来发现
- Web Services 可被其他应用程序使用
- XML 是 Web Services 的基础
1.2 它如何工作？
- 基础的 Web Services 平台是 XML + HTTP。
- HTTP 协议是最常用的因特网协议。
- XML 提供了一种可用于不同的平台和编程语言之间的语言。
- Web services 平台的元素：
- SOAP (简易对象访问协议)
- UDDI (通用描述、发现及整合)
- WSDL (Web services 描述语言)
- 可重复使用的应用程序组件
Web services 可以把应用程序组件作为服务来提供，比如汇率转换、天气预报或者甚至是语言翻译等等。
比较理想的情况是，每种应用程序组件只有一个最优秀的版本，这样任何人都可以在其应用程序中使用它。
- 连接现有的软件
通过使用 Web services，您可以在不同的应用程序与平台之间来交换数据。
1.4 实现手段
WebService一般分为.Net版和Java版，今天我们主要来实现Java版的WebService，.Net版本的还是比较简单的。 什么是WebServices？
它是一种构建应用程序的普遍模型,可以在任何支持网络通信的操作系统中实施运行;它是一种新的web应用程序分支，是自包含、自描述、模块化的应用，可以发布、定位、通过web调用。Web Service是一个应用组件,它逻辑性的为其他应用程序提供数据与服务.各应用程序通过网络协议和规定的一些标准数据格式（Http，XML，Soap)来访问Web Service,通过Web Service内部执行得到所需结果.Web Service可以执行从简单的请求到复杂商务处理的任何功能。一旦部署以后，其他Web Service应用程序可以发现并调用它部署的服务。
关键的技术和规则
在构建和使用Web Service时,主要用到以下几个关键的技术和规则:
1.XML:描述数据的标准方法.
2.SOAP:表示信息交换的协议.
3.WSDL:Web服务描述语言.
4.UDDI:通用描述、发现与集成，它是一种独立于平台的，基于XML语言的用于在互联网上描述商务的协议。
- XML
- SOAP
- WSDL
- UDDI
2、android端webservice的使用
本文仅介绍如何从android手机端使用webservice。
目前比较通用的webservice为ksoap2和rest。下面来分别介绍。
3、使用KSOAP2调用WebService
3.1 获取并使用KSOAP包
我们在PC机器java客户端中，需要一些库，比如XFire,Axis2,CXF等等来支持访问WebService，但是这些库并不适合我们资源有限的android手机客户端，做过JAVA ME的人都知道有KSOAP这个第三方的类库，可以帮助我们获取服务器端webService调用，当然KSOAP已经提供了基于android版本的jar包了，那么我们就开始吧：
首先下载KSOAP包：ksoap2-android-assembly-2.5.2-jar-with-dependencies.jar包
然后新建android项目：并把下载的KSOAP包放在android项目的lib目录下：右键->build path->configure build path--选择Libraries，如图：
以下分为七个步骤来调用WebService方法：
第一：实例化SoapObject 对象，指定webService的命名空间（从相关WSDL文档中可以查看命名空间），以及调用方法名称。如：
//命名空间
private static final String serviceNameSpace="http://WebXml.com.cn/";
//调用方法(获得支持的城市)
private static final String getSupportCity="getSupportCity";
//实例化SoapObject对象
SoapObject request=new SoapObject(serviceNameSpace, getSupportCity);request.addProperty("参数名称","参数值");
要注意的是，addProperty方法的第1个参数虽然表示调用方法的参数名，但该参数值并不一定与服务端的WebService类中的方法参数名一致，只要设置参数的顺序一致即可。
第三步：设置SOAP请求信息(参数部分为SOAP协议版本号，与你要调用的webService中版本号一致):
//获得序列化的Envelope
SoapSerializationEnvelope envelope=new SoapSerializationEnvelope(SoapEnvelope.VER11);
envelope.bodyOut=request; 创建SoapSerializationEnvelope对象时需要通过SoapSerializationEnvelope类的构造方法设置SOAP协议的版本号。该版本号需要根据服务端WebService的版本号设置。在创建SoapSerializationEnvelope对象后，不要忘了设置SoapSerializationEnvelope类的bodyOut属性，该属性的值就是在第1步创建的SoapObject对象。
(new MarshalBase64()).register(envelope);
第五步：构建传输对象，并指明WSDL文档URL：
//请求URL
private static final String serviceURL="http://www.webxml.com.cn/webservices/weatherwebservice.asmx";
//Android传输对象
AndroidHttpTransport transport=new AndroidHttpTransport(serviceURL);
transport.debug=true;transport.call(serviceNameSpace+getWeatherbyCityName, envelope);call方法的第1个参数一般为null，第2个参数就是在第3步创建的SoapSerializationEnvelope对象。
第七步：解析返回数据：if(envelope.getResponse()!=null){
return parse(envelope.bodyIn.toString());
}
/**************
* 解析XML
* @param str
* @return
*/
private static List<String> parse(String str){
String temp;
List<String> list=new ArrayList<String>();
if(str!=null && str.length()>0){
int start=str.indexOf("string");
int end=str.lastIndexOf(";");
temp=str.substring(start, end-3);
String []test=temp.split(";");
for(int i=0;i<test.length;i++){
if(i==0){
temp=test[i].substring(7);
}else{
temp=test[i].substring(8);
}
int index=temp.indexOf(",");
list.add(temp.substring(0, index));
}
}
return list;
}3.2 示例：通过WebService查询产品信息
本例涉及到一个WebService服务端程序和一个OPhone客户端程序。读者可直接将服务端程序（axis2目录）复制到<Tomcat安装目录>\webapps目录中，然后启动Tomcat，并在浏览器地址栏中输入如下的URL：
http://localhost:8080/axis2
如果在浏览器中显示如图2所示的页面，说明服务端程序已经安装成功。
这个服务端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所示。
在图3中的黑框中就是WebService的命名空间，也是SoapObject类的构造方法的第1个参数值。这个WebService程序可以直接使用如下的URL进行测试。
http://localhost:8080/axis2/services/SearchProductService/getProduct?param0=iphone
测试的结果如图4所示。
从上图所示的测试结果可以看出，Axis2将getProduct方法返回的Product对象直接转换成了XML文档（实际上是SOAP格式）返回。
下面我们来根据前面介绍的使用KSOAP2的步骤来编写调用WebService的OPhone客户端程序，代码如下：
package net.blogjava.mobile.wsclient;
import org.ksoap2.SoapEnvelope;
import org.ksoap2.serialization.SoapObject;
import org.ksoap2.serialization.SoapSerializationEnvelope;
import org.ksoap2.transport.HttpTransportSE;
import android.app.Activity;
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
{
@Override
public void onClick(View view)
{
EditText etProductName = (EditText)findViewById(R.id.etProductName);
TextView tvResult = (TextView)findViewById(R.id.tvResult);
// WSDL文档的URL，192.168.17.156为PC的ID地址
String serviceUrl = "http://192.168.17.156:8080/axis2/services/SearchProductService?wsdl";
// 定义调用的WebService方法名
String methodName = "getProduct";
// 第1步：创建SoapObject对象，并指定WebService的命名空间和调用的方法名
SoapObject request = new SoapObject("http://service", methodName);
// 第2步：设置WebService方法的参数
request.addProperty("productName", etProductName.getText().toString());
// 第3步：创建SoapSerializationEnvelope对象，并指定WebService的版本
SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);
// 设置bodyOut属性
envelope.bodyOut = request;
// 第4步：创建HttpTransportSE对象，并指定WSDL文档的URL
HttpTransportSE ht = new HttpTransportSE(serviceUrl);
try
{
// 第5步：调用WebService
ht.call(null, envelope);
if (envelope.getResponse() != null)
{
// 第6步：使用getResponse方法获得WebService方法的返回结果
SoapObject soapObject = (SoapObject) envelope.getResponse();
// 通过getProperty方法获得Product对象的属性值
String result = "产品名称：" + soapObject.getProperty("name") + "\n";
result += "产品数量：" + soapObject.getProperty("productNumber") + "\n";
result += "产品价格：" + soapObject.getProperty("price");
tvResult.setText(result);
}
else {
tvResult.setText("无此产品.");
}
}
catch (Exception e)
{
}
}
@Override
public void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
Button btnSearch = (Button) findViewById(R.id.btnSearch);
btnSearch.setOnClickListener(this);
}
}1）在第2步中addProperty方法的第1个参数值是productName，该值虽然是getProduct方法的参数名，但addProperty方法的第1个参数值并不限于productName，读者可以将这个参数设为其他的任何字符串（但该值必须在XML中是合法的，例如，不是设为“<”、“>”等XML预留的字符串）。
2）通过SoapObject类的getProperty方法可以获得Product对象的属性值，这些属性名就是图4所示的测试结果中的属性名。
运行本例，在文本框中输入“htc hero”，单击【查询】按钮，会在按钮下方显示如图5所示的查询结果。
防止UI组件阻塞
从功能上看，本文示例中给出的代码并没有任何问题。但可能有的读者会有这样的担心：如果调用WebService的用户很多，至使服务端响应迟缓；或服务端的IP根本就不对，那么在这些情况下，用户界面的按钮和文本框组件岂不是象“死”了一样无法响应用户的其他动作。当然，发生这种情况的可能性是有的，尤其是在复杂的网络环境中发生的可能性是很大的，一但发生这种事情，就会使整个软件系统在用户体验上变得非常糟糕。
用户和开发人员都希望改善这种糟糕的情况。最理想的状态是单击按钮调用WebService方法时，即使由于某种原因，WebService方法并未立即返回，界面上的组件仍然会处于活动状态，也就是说，用户仍然可以使用当前界面中的其他组件。
在OPhone中可以采用异步的方式来达到这个目的。异步实际上就是通过多线程的方式来实现。一般使用new Thread(this).start()来创建和开始一个线程。但本节并不使用Thread来实现异步，而是通过AsyncTask类使要执行的任务（调用WebService）在后台执行。
下面先看看改进后的代码。
package net.blogjava.mobile.wsclient;
import org.ksoap2.SoapEnvelope;
import org.ksoap2.serialization.SoapObject;
import org.ksoap2.serialization.SoapSerializationEnvelope;
import org.ksoap2.transport.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
protected Object doInBackground(Object... params)
{
try
{
String serviceUrl = "http://192.168.17.156:8080/axis2/services/SearchProductService?wsdl";
String methodName = "getProduct";
SoapObject request = new SoapObject("http://service",
methodName);
request.addProperty("productName", etProductName.getText().toString());
SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(
SoapEnvelope.VER11);
envelope.bodyOut = request;
HttpTransportSE ht = new HttpTransportSE(serviceUrl);
ht.call(null, envelope);
if (envelope.getResponse() != null)
{
SoapObject soapObject = (SoapObject) envelope.getResponse();
result = "产品名称：" + soapObject.getProperty("name") + "\n";
result += "产品数量：" + soapObject.getProperty("productNumber")
+ "\n";
result += "产品价格：" + soapObject.getProperty("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)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
Button btnSearch = (Button) findViewById(R.id.btnSearch);
btnSearch.setOnClickListener(this);
etProductName = (EditText) findViewById(R.id.etProductName);
tvResult = (TextView) findViewById(R.id.tvResult);
}
}
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方法的返回值可以通过AsyncTask.execute(...).get()方法获得。
读者可以将本例中的IP改成其他的值，看看单击按钮后，是否还可在文本框中输入其他的内容。如果这个IP是正确的，并且WebService可访问，那么会在TextView组件中输出相应的返回值。
参考文献：
扫一扫
1321
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
