客户端和服务端通讯的N种方式（一）

自从2009年发放3G牌照以来，标志着中国开始进入移动互联网的3G时代。随着移动互联网速度的不断提高，资费不断降低。使得具有联网功能的手机应用程序逐渐成为主流。虽然大多数开发人员都希望在自己的应用中加入网络功能，以便使自己的应用程序赶上移动互联网的浪潮，为应用增加更绚、更酷的亮点。但很多开发人员并不了解如何在自己的应用程序中加入网络功能，或哪种网络技术更适合自己的应用程序。因此，在本系列文章中以OPhone 2.0为例全方位地解析手机客户端和服务端通讯的各种方法。除此之外，我们还可以看到如何使用这些通讯技术传递更复杂的数据，例如，传递图像、序列化的对象。在本文会着重介绍我们的第一种通讯方式：WebService。

WebService简介

WebService是一种基于SOAP协议的远程调用标准。通过WebService可以将不同操作系统平台，不同语言、不同技术整合到一起。在OPhone SDK中并没有提供调用WebService的库，因此，需要使用第三方SDK来调用WebService。

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



图1 引用ksoap2的jar包

如何调用WebService

在引用完Ksoap2的jar包后，我们可以按如下6个步骤来调用WebService方法。

1. 指定WebService的命名空间和调用的方法名，例子代码如下：

view
plaincopy
to clipboardprint?

SoapObject request = new SoapObject("http://service", "getName");

SoapObject类的第1个参数表示WebService的命名空间，可以从WSDL文档中找到WebService的命名空间。第2个参数表示要调用的WebService方法名。

2. 设置调用方法的参数值，这一步是可选的，如果方法没有参数，可以省略这一步。设置方法的参数值的代码如下：

view
plaincopy
to clipboardprint?

request.addProperty("param1", "value1");

request.addProperty("param2", "value2");

要注意的是，addProperty方法的第1个参数虽然表示调用方法的参数名，但该参数值并不一定与服务端的WebService类中的方法参数名一致，只要设置参数的顺序一致即可。

3. 生成调用WebService方法的SOAP请求信息。该信息由SoapSerializationEnvelope对象描述，代码如下：

view
plaincopy
to clipboardprint?

SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);

envelope.bodyOut = request;

创建SoapSerializationEnvelope对象时需要通过SoapSerializationEnvelope类的构造方法设置SOAP协议的版本号。该版本号需要根据服务端WebService的版本号设置。在创建SoapSerializationEnvelope对象后，不要忘了设置SoapSerializationEnvelope类的bodyOut属性，该属性的值就是在第1步创建的SoapObject对象。

4. 创建HttpTransportSE对象。通过HttpTransportSE类的构造方法可以指定WebService的WSDL文档的URL，代码如下：

view
plaincopy
to clipboardprint?

HttpTransportSE ht =

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

5. 使用call方法调用WebService方法，代码如下：

view
plaincopy
to clipboardprint?

ht.call(null, envelope);

call方法的第1个参数一般为null，第2个参数就是在第3步创建的SoapSerializationEnvelope对象。

6. 使用getResponse方法获得WebService方法的返回结果，代码如下：

view
plaincopy
to clipboardprint?

SoapObject soapObject = (SoapObject) envelope.getResponse();

使用WebService传输简单的数据

为了演示WebService的使用，首先需要编写一个WebService。读者可直接将服务端程序（axis2目录）复制到<Tomcat安装目录>/webapps目录中，然后启动Tomcat，并在浏览器地址栏中输入如下的URL：
http://localhost:8080/axis2
如果在浏览器中显示如图2所示的页面，说明服务端程序已经安装成功。



图2 测试WebService是否安装成功

这个服务端WebService程序是SearchProductService，实际上SearchProductService是一个Java类，只是利用Axis2将其映射成WebService。在该类中有一个getProduct方法。这个方法有一个String类型的参数，表示产品名称。该方法返回一个Product对象，该对象有3个属性：name、price和productNumber。SearchProduct类的代码如下：

view
plaincopy
to clipboardprint?

package service;

import java.util.HashMap;

import java.util.Map;

public class SearchProductService

{

private static Map<String, Product> products = new HashMap<String, Product>();

static

{

Product product = new Product();

product.setName("ACA烤箱 ");

product.setProductNumber(200);

product.setPrice(299);

products.put("ACA烤箱", product);

product = new Product();

product.setName("HTC Hero手机");

product.setProductNumber(12);

product.setPrice(3210);

products.put("htc hero", product);

product = new Product();

product.setName("iphone手机");

product.setProductNumber(20);

product.setPrice(5100);

products.put("iphone", product);

}

public Product getProduct(String productName)

{

return products.get(productName);

}

}

其中Product表示产品类，代码如下：

package service;

import java.io.Serializable;

public class Product

{

private String name;

private int productNumber;

private float price;

public String getName()

{

return name;

}

public void setName(String name)

{

this.name = name;

}

public int getProductNumber()

{

return productNumber;

}

public void setProductNumber(int productNumber)

{

this.productNumber = productNumber;

}

public float getPrice()

{

return price;

}

public void setPrice(float price)

{

this.price = price;

}

}

我们可以使用如下的URL来查看SearchProductService的WSDL文档。
http://localhost:8080/axis2/services/SearchProductService?wsdl
显示WSDL文档的页面如图3所示。



图3 WSDL文档的内容

在图3中顶层节点的targetNamespace属性值就是WebService的命名空间，也是SoapObject类的构造方法的第1个参数值。这个WebService程序可以直接使用如下的URL进行测试。
http://localhost:8080/axis2/services/SearchProductService/getProduct?args0=iphone
测试的结果如图4所示。



图4 WebService测试结果

从图4所示的测试结果可以看出，Axis2将getProduct方法返回的Product对象直接转换成了XML文档（实际上是SOAP格式）返回。

下面我们来根据前面介绍的使用KSOAP2的步骤来编写调用WebService的Android客户端程序，代码如下：

view
plaincopy
to clipboardprint?

package ws.client ;

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.176为PC的ID地址

String serviceUrl =

"http://192.168.17.86: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);

}

}

在编写上面代码时应注意如下两点：

在第2步中addProperty方法的第1个参数值是productName，该值虽然是getProduct方法的参数名，但addProperty方法的第1个参数值并不限于productName，读者可以将这个参数设为其他的任何字符串（但该值必须在XML中是合法的，例如，不是设为“<”、“>”等XML预留的字符串）。
通过SoapObject类的getProperty方法可以获得Product对象的属性值，这些属性名就是图4所示的测试结果中的属性名。

运行程序，在文本框中输入“htc hero”，单击【查询】按钮，会在按钮下方显示如图5所示的查询结果。



图5 调用WebService

总结

在本文为读者介绍了如何在OPhone中通过KSOAP2调用WebService，并传递简单的数据。然而，通过KSOAP不仅可以传递简单的数据，也可以传递更复杂的数据，在下一篇文章中将会为读者揭示这一切。