Android 中利用 ksoap2 调用 WebService的示例代码

去年刚刚工作的时候，第一个项目是要访问 webservice。由于没有接触过，查了很多资料，在别人代码的基础上稍微修改了一下，总算满足了自己的需求。最近整理电脑的时候，发现了这个 webservice 的访问类，怕哪一天需要的时候找不到了，干脆写在博客上吧，也给需要的人提供一个参考。

1.下载 ksoap2 的 jar 文件

下载地址：

下载完成后依赖到自己的项目中即可。

2.封装网络访问工具类

直接贴代码了，注释写的很详细，根据自己的需要加以修改。

/**
 * 访问 webservice 的工具类
 */
public class webserviceutil {

 // 命名空间
 private static final string namespace = "your namespace";
 // webservice 服务器地址
 private static final string endpoint = "your address";

 // 一般自己公司开发都是需要身份验证的
 // 身份验证方法名
 private static final string id_headername = "verify method";
 // 身份验证 key
 private static final string id_name_param = "verify key1";
 // 身份验证 value
 private static final string id_name_value = "verify value1";
 // 身份验证 key
 private static final string id_password_param = "verify key2";
 // 身份验证 value
 private static final string id_password_value = "verify value2";

 // 访问的服务器是否由 dotnet 开发
 public static boolean isdotnet = true;

 // 线程池的大小
 private static int threadsize = 5;
 // 创建一个可重用固定线程数的线程池，以共享的*队列方式来运行这些线程
 private static executorservice threadpool = executors.newfixedthreadpool(threadsize);

 // 连接响应标示
 public static final int success_flag = 0;
 public static final int error_flag = 1;

 /**
  * 调用 webservice 接口
  *
  * @param methodname  webservice 的调用方法名
  * @param mapparams  webservice 的参数集合，可以为 null
  * @param reponsecallback 服务器响应接口
  */
 public static void call(final string methodname, simplearraymap<string, object> mapparams, final responsecallback reponsecallback) {

  // 创建 httptransportse 对象，传递 webservice 服务器地址
  final httptransportse transport = new httptransportse(endpoint);
  transport.debug = true;

  // 身份验证（如果需要的话）
  element[] header = new element[1];
  // 传入命名空间与验证的方法名
  header[0] = new element().createelement(namespace, id_headername);
  // 创建参数 1
  element username = new element().createelement(namespace, id_name_param);
  username.addchild(node.text, id_name_value);
  header[0].addchild(node.element, username);
  // 创建参数 2
  element password = new element().createelement(namespace, id_password_param);
  password.addchild(node.text, id_password_value);
  header[0].addchild(node.element, password);

  // 创建 soapobject 对象用于传递请求参数
  final soapobject soapobject = new soapobject(namespace, methodname);
  // 添加参数
  if (mapparams != null) {
   for (int index = 0; index < mapparams.size(); index++) {
    string key = mapparams.keyat(index);
    // 多数情况下，传递的参数都为 string 类型，不过少数情况下会有 boolean 类型，所以用 object 代替
    object value = mapparams.get(key);
    soapobject.addproperty(key, value);
   }
  }

  // 实例化 soapserializationenvelope，传入 webservice 的 soap 协议的版本号
  // 这里有 ver10 ver11 ver12 三种版本，根据自己需要填写
  final soapserializationenvelope envelope = new soapserializationenvelope(soapenvelope.ver11);
  envelope.headerout = header; // 身份验证（如果需要的话）
  envelope.dotnet = isdotnet; // 设置是否调用的是 .net 开发的 webservice
  envelope.bodyout = soapobject; // 传递参数
  //envelope.setoutputsoapobject(soapobject);// 与上一句等价

  // 用于与主线程通信的 handler
  final handler responsehandler = new handler() {

   @override
   public void handlemessage(message msg) {
    super.handlemessage(msg);
    // 根据消息的 arg1 值判断调用哪个接口
    if (msg.arg1 == success_flag) {
     reponsecallback.onsuccess((string) msg.obj);
    } else {
     reponsecallback.onerror((exception) msg.obj);
    }
   }

  };

  // 提交一个子线程到线程池并在此线种内调用 webservice
  if (threadpool == null || threadpool.isshutdown()) {
   threadpool = executors.newfixedthreadpool(threadsize);
  }
  threadpool.submit(new runnable() {

   @override
   public void run() {
    string result = null;
    try {
     // 解决 eofexception
     system.setproperty("http.keepalive", "false");
     // 连接服务器，有的服务可能不需要传递 namespace + methodname，第一个参数传递 null
     transport.call(null, envelope);
     if (envelope.getresponse() != null) {
      // 获取服务器响应返回的 soapobject
      soapobject object = (soapobject) envelope.bodyin;
      result = object.getproperty(0).tostring();
     }
    } catch (ioexception e) {
     // 当 call 方法的第一个参数为 null 时会有一定的概念抛 io 异常
     // 因此需要需要捕捉此异常后用命名空间加方法名作为参数重新连接
     // e.printstacktrace();
     try {
      transport.call(namespace + methodname, envelope);
      if (envelope.getresponse() != null) {
       // 获取服务器响应返回的 soapobject
       soapobject object = (soapobject) envelope.bodyin;
       result = object.getproperty(0).tostring();
      }
     } catch (exception e1) {
      // e1.printstacktrace();
      responsehandler.sendmessage(responsehandler.obtainmessage(0, error_flag, 0, e1));
     }
    } catch (xmlpullparserexception e) {
     // e.printstacktrace();
     responsehandler.sendmessage(responsehandler.obtainmessage(0, error_flag, 0, e));
    } finally {
     // 将获取的消息利用 handler 发送到主线程
     responsehandler.sendmessage(responsehandler.obtainmessage(0, success_flag, 0, result));
    }
   }
  });
 }

 /**
  * 设置线程池的大小
  *
  * @param threadsize
  */
 public static void setthreadsize(int threadsize) {
  webserviceutil.threadsize = threadsize;
  threadpool.shutdownnow();
  threadpool = executors.newfixedthreadpool(webserviceutil.threadsize);
 }

 /**
  * 服务器响应接口，在响应后需要回调此接口
  */
 public interface responsecallback {

  void onsuccess(string result);

  void onerror(exception e);
 }

}

3.在 activity 中使用

private void request() {
  simplearraymap<string, object> map = new simplearraymap<>();
  map.put("key1", "value1");
  map.put("key2", "value2");
  webserviceutil.call("method name", map, new webserviceutil.responsecallback() {
   @override
   public void onsuccess(string result) {
    // 请求成功
   }

   @override
   public void onerror(exception e) {
    // 请求失败
   }
  });
 }

至此调用结束，有需要访问 webservice 的同学可以参考一下。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。