用于Android开的简易WebService访问框架

因为公司业务需要用Android端能访问WebService开发的服务器接口，在网上找了一些资料拼凑了一简易的网络框架，原理就是每条请求都在子线程上实现，得到响应后再把结果通过Handler消息机制发给主线程，所有的子线程都由线程池来管理，大致意思这就样了。

package com.example.webservice.webservicedemo;

import android.os.Handler;
import android.os.Message;
import android.support.v4.util.SimpleArrayMap;

import org.ksoap2.SoapEnvelope;
import org.ksoap2.serialization.SoapObject;
import org.ksoap2.serialization.SoapSerializationEnvelope;
import org.ksoap2.transport.HttpTransportSE;
import org.xmlpull.v1.XmlPullParserException;

import java.io.IOException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

/**
 * WebService访问方式的工具类
 */
public class WebServiceUtils {
    // 访问的服务器是否由dotNet开发
    public static boolean isDotNet = false;
    // 线程池的大小
    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接口，此方法只访问过用Java写的服务器
     *
     * @param endPoint        WebService服务器地址
     * @param nameSpace       命名空间
     * @param methodName      WebService的调用方法名
     * @param mapParams       WebService的参数集合，可以为null
     * @param reponseCallBack 服务器响应接口
     */
    public static void call(final String endPoint,
                            final String nameSpace,
                            final String methodName,
                            SimpleArrayMap<String, String> mapParams,
                            final Response reponseCallBack) {
        // 1.创建HttpTransportSE对象，传递WebService服务器地址
        final HttpTransportSE transport = new HttpTransportSE(endPoint);
        transport.debug = true;
        // 2.创建SoapObject对象用于传递请求参数
        final SoapObject request = new SoapObject(nameSpace, methodName);
        // 2.1.添加参数也可以不传
        if (mapParams != null) {
            for (int index = 0; index < mapParams.size(); index++) {
                String key = mapParams.keyAt(index);
                String value = mapParams.get(key);
                request.addProperty(key, value);
            }
        }

        // 3.实例化SoapSerializationEnvelope，传入WebService的SOAP协议的版本号
        final SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);
        envelope.dotNet = isDotNet; // 设置是否调用的是.Net开发的WebService
        envelope.setOutputSoapObject(request);

        // 4.用于子线程与主线程通信的Handler，网络请求成功时会在子线程发送一个消息，然后在主线程上接收
        final Handler responseHandler = new Handler() {

            @Override
            public void handleMessage(Message msg) {
                super.handleMessage(msg);
                // 根据消息的arg1值判断调用哪个接口
                if (msg.arg1 == SUCCESS_FLAG)
                    reponseCallBack.onSuccess((SoapObject) msg.obj);
                else
                    reponseCallBack.onError((Exception) msg.obj);
            }

        };

        // 5.提交一个子线程到线程池并在此线种内调用WebService
        if (threadPool == null || threadPool.isShutdown())
            threadPool = Executors.newFixedThreadPool(threadSize);
        threadPool.submit(new Runnable() {

            @Override
            public void run() {
                SoapObject result = null;
                try {
                    // 解决EOFException
                    System.setProperty("http.keepAlive", "false");
                    // 连接服务器
                    transport.call(null, envelope);
                    if (envelope.getResponse() != null) {
                        // 获取服务器响应返回的SoapObject
                        result = (SoapObject) envelope.bodyIn;
                    }
                } catch (IOException e) {
                    // 当call方法的第一个参数为null时会有一定的概念抛IO异常
                    // 因此需要需要捕捉此异常后用命名空间加方法名作为参数重新连接
                    e.printStackTrace();
                    try {
                        transport.call(nameSpace + methodName, envelope);
                        if (envelope.getResponse() != null) {
                            // 获取服务器响应返回的SoapObject
                            result = (SoapObject) envelope.bodyIn;
                        }
                    } 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) {
        WebServiceUtils.threadSize = threadSize;
        threadPool.shutdownNow();
        threadPool = Executors.newFixedThreadPool(WebServiceUtils.threadSize);
    }

    /**
     * 服务器响应接口，在响应后需要回调此接口
     */
    public interface Response {
        public void onSuccess(SoapObject result);

        public void onError(Exception e);
    }

}

然后在程序中只需要按如下方式调用即可。

private void requestLogin(final String userName, final String password) {
        // 参数集合
        SimpleArrayMap mapParams = new SimpleArrayMap();
        mapParams.put("userName", userName + "");
        mapParams.put("password", MD5Test.encrypt(password + ""));
        mapParams.put("autoKey", "");

        final Dialog dlg = DialogUtils.showProgressDialog(this, "正在登录...");
        WebServiceUtils.call(ServiceConstants.EP_CHJ_USER_SERVICE,
                ServiceConstants.NP_CHJ, ServiceConstants.M_CHJ_USER_LOGIN, mapParams,
                new WebServiceUtils.Response() {
                    @Override
                    public void onSuccess(SoapObject result) {
                        LogUtil.i(result + "");
                        processLogin(result, userName, password);
                        dlg.dismiss();
                    }

                    @Override
                    public void onError(Exception e) {
                        e.printStackTrace();
                        dlg.dismiss();
                    }
                });
    }