文/程序员男神
前言
最近接手新的任务,开发公司的移动新产品,想到自己一个人开发,蛋感觉瞬间很疼啊!接手到项目才发现东西都是很简单,后端接口使用的技术有点年代了,这不马不停蹄去学习学习,跟上年代的步伐,不然一脸懵逼,那就尴尬了。
概述
WebService是什么?
WebService 是一种基于SOAP协议的远程调用标准。通过WebService可以将不同操作系统平台,不同语言、不同技术整合到一起。在Android SDK中并没有提供调用WebService的库,因此,需要使用第三方类库(KSOAP2)来调用WebService。
第三方类库jar资源下载:
http://download.csdn.net/detail/grandriversmountains/9680246?web=web
下载好之后,导入Android Studio---》libs---》add...
实现步骤
使用KSOAP2如何调用WebService?
6步实现调用WebService:
1. 指定WebService的命名空间和调用的方法名,代码如下:
SoapObject request = new SoapObject("http://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类的构造方法可以指定WebService的WSDL文档的URL,代码如下:
HttpTransportSE ht = new HttpTransportSE("http://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) envelope.getResponse();
完整示例代码
/**
* desc: webService的示例
* author: dj
* date: 2017/2/24 13:30
*/
public class WebServiceActivity extends AppCompatActivity {
@BindView(R.id.et_text)
EditText etText;
@BindView(R.id.btn_search)
Button btnSearch;
@BindView(R.id.tv_show1)
TextView tvShow1;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_web_service);
ButterKnife.bind(this);
}
@OnClick(R.id.btn_search)
public void onClick() {
// 异步执行调用WebService的任务
new WSAsyncTask().execute();
}
class WSAsyncTask extends AsyncTask {
String result = "";
@Override
protected Object doInBackground(Object[] params) {
// 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.指定WebService的命名空间和调用的方法名
SoapObject request = new SoapObject("http://service", methodName);
//2.设置调用方法的参数值
request.addProperty("param", etText.getText().toString());
// 3.生成调用WebService方法的SOAP请求信息
SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);
envelope.bodyOut = request;
//4.创建HttpTransportSE对象。通过HttpTransportSE类的构造方法可以指定WebService的WSDL文档的URL
HttpTransportSE dt = new HttpTransportSE(serviceUrl);
try {
//5.使用call方法调用WebService方法/call方法的第1个参数一般为null,第2个参数就是在第3步创建的SoapSerializationEnvelope对象。
dt.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") + "\n";
} else {
tvShow1.setText("无此类产品!");
}
} catch (Exception e) {
result = "调用WebService错误.";
}
// 必须使用post方法更新UI组件
tvShow1.post(new Runnable() {
@Override
public void run() {
tvShow1.setText(result);
}
});
return null;
}
}
}
xml文件很简单:
访问WebService的工具类
经过最近一段时间的研究与学习,参考大牛的文章,自己整理封装了WebService的工具类。
代码如下:
package winning.health.rims.util;
import android.os.Handler;
import android.os.Message;
import org.ksoap2.SoapEnvelope;
import org.ksoap2.serialization.SoapObject;
import org.ksoap2.serialization.SoapPrimitive;
import org.ksoap2.serialization.SoapSerializationEnvelope;
import org.ksoap2.transport.HttpResponseException;
import org.ksoap2.transport.HttpTransportSE;
import org.xmlpull.v1.XmlPullParserException;
import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
/**
* desc: 访问WebService的工具类,
* author: dj
* date: 2017/3/9 10:00
* 参考:http://blog.csdn.net/zl570932980/article/details/51842574
*/
public class WebServiceUtils {
public static final String WEB_SERVER_URL = "";
// 含有3个线程的线程池
private static final ExecutorService executorService = Executors
.newFixedThreadPool(3);
// 命名空间
private static final String NAME_SPACE = "";
/**
* @param url WebService服务器地址
* @param methodName WebService的调用方法名
* @param values WebService的参数
* @param webServiceCallBack 回调接口
*/
public static void callWebService(String url, final String methodName,
String[] values,
final WebServiceCallBack webServiceCallBack) {//HashMap properties
// 创建HttpTransportSE对象,传递WebService服务器地址
final HttpTransportSE httpTransportSE = new HttpTransportSE(url);
// 创建SoapObject对象
SoapObject soapObject = new SoapObject(NAME_SPACE, methodName);
// SoapObject添加参数
if (values != null) {
for (int i = 0; i < values.length; i++) {
soapObject.addProperty("XmlData" + i, values[i]);
}
}
// if (properties != null) {
// for (Iterator> it = properties.entrySet()
// .iterator(); it.hasNext(); ) {
// Map.Entry entry = it.next();
// soapObject.addProperty(entry.getKey(), entry.getValue());
// }
// }
// 实例化SoapSerializationEnvelope,传入WebService的SOAP协议的版本号
final SoapSerializationEnvelope soapEnvelope = new SoapSerializationEnvelope(
SoapEnvelope.VER11);
// 设置是否调用的是.Net开发的WebService
soapEnvelope.setOutputSoapObject(soapObject);
soapEnvelope.dotNet = true;
httpTransportSE.debug = true;
// 用于子线程与主线程通信的Handler
final Handler mHandler = new Handler() {
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
// 将返回值回调到callBack的参数中
webServiceCallBack.callBack((SoapObject) msg.obj);
}
};
// 开启线程去访问WebService
executorService.submit(new Runnable() {
@Override
public void run() {
SoapObject resultSoapObject = null;
try {
httpTransportSE.call(NAME_SPACE + methodName, soapEnvelope);
if (soapEnvelope.getResponse() != null) {
// 获取服务器响应返回的SoapObject
resultSoapObject = (SoapObject) soapEnvelope.bodyIn;
}
} catch (HttpResponseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (XmlPullParserException e) {
e.printStackTrace();
} finally {
// 将获取的消息利用Handler发送到主线程
mHandler.sendMessage(mHandler.obtainMessage(0,
resultSoapObject));
}
}
});
}
public interface WebServiceCallBack {
void callBack(SoapObject result);
}
}
总结
在Android 中使用KSOAP2调用WebService的全过程就是这样,很简单,希望大家都能看懂。
参考文献:http://www.open-open.com/solution/view/1320111271749?sort=newest