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

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

[java]  view plain  copy

 

1. package com.example.webservice.webservicedemo;  
2.   
3. import android.os.Handler;  
4. import android.os.Message;  
5. import android.support.v4.util.SimpleArrayMap;  
6.   
7. import org.ksoap2.SoapEnvelope;  
8. import org.ksoap2.serialization.SoapObject;  
9. import org.ksoap2.serialization.SoapSerializationEnvelope;  
10. import org.ksoap2.transport.HttpTransportSE;  
11. import org.xmlpull.v1.XmlPullParserException;  
12.   
13. import java.io.IOException;  
14. import java.util.concurrent.ExecutorService;  
15. import java.util.concurrent.Executors;  
16.   
17. /** 
18.  * WebService访问方式的工具类 
19.  */  
20. public class WebServiceUtils {  
21.     // 访问的服务器是否由dotNet开发  
22.     public static boolean isDotNet = false;  
23.     // 线程池的大小  
24.     private static int threadSize = 5;  
25.     // 创建一个可重用固定线程数的线程池，以共享的无界队列方式来运行这些线程  
26.     private static ExecutorService threadPool = Executors.newFixedThreadPool(threadSize);  
27.     // 连接响应标示  
28.     public static final int SUCCESS_FLAG = 0;  
29.     public static final int ERROR_FLAG = 1;  
30.   
31.     /** 
32.      * 调用WebService接口，此方法只访问过用Java写的服务器 
33.      * 
34.      * @param endPoint        WebService服务器地址 
35.      * @param nameSpace       命名空间 
36.      * @param methodName      WebService的调用方法名 
37.      * @param mapParams       WebService的参数集合，可以为null 
38.      * @param reponseCallBack 服务器响应接口 
39.      */  
40.     public static void call(final String endPoint,  
41.                             final String nameSpace,  
42.                             final String methodName,  
43.                             SimpleArrayMap<String, String> mapParams,  
44.                             final Response reponseCallBack) {  
45.         // 1.创建HttpTransportSE对象，传递WebService服务器地址  
46.         final HttpTransportSE transport = new HttpTransportSE(endPoint);  
47.         transport.debug = true;  
48.         // 2.创建SoapObject对象用于传递请求参数  
49.         final SoapObject request = new SoapObject(nameSpace, methodName);  
50.         // 2.1.添加参数也可以不传  
51.         if (mapParams != null) {  
52.             for (int index = 0; index < mapParams.size(); index++) {  
53.                 String key = mapParams.keyAt(index);  
54.                 String value = mapParams.get(key);  
55.                 request.addProperty(key, value);  
56.             }  
57.         }  
58.   
59.         // 3.实例化SoapSerializationEnvelope，传入WebService的SOAP协议的版本号  
60.         final SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);  
61.         envelope.dotNet = isDotNet; // 设置是否调用的是.Net开发的WebService  
62.         envelope.setOutputSoapObject(request);  
63.   
64.         // 4.用于子线程与主线程通信的Handler，网络请求成功时会在子线程发送一个消息，然后在主线程上接收  
65.         final Handler responseHandler = new Handler() {  
66.   
67.             @Override  
68.             public void handleMessage(Message msg) {  
69.                 super.handleMessage(msg);  
70.                 // 根据消息的arg1值判断调用哪个接口  
71.                 if (msg.arg1 == SUCCESS_FLAG)  
72.                     reponseCallBack.onSuccess((SoapObject) msg.obj);  
73.                 else  
74.                     reponseCallBack.onError((Exception) msg.obj);  
75.             }  
76.   
77.         };  
78.   
79.         // 5.提交一个子线程到线程池并在此线种内调用WebService  
80.         if (threadPool == null || threadPool.isShutdown())  
81.             threadPool = Executors.newFixedThreadPool(threadSize);  
82.         threadPool.submit(new Runnable() {  
83.   
84.             @Override  
85.             public void run() {  
86.                 SoapObject result = null;  
87.                 try {  
88.                     // 解决EOFException  
89.                     System.setProperty("http.keepAlive", "false");  
90.                     // 连接服务器  
91.                     transport.call(null, envelope);  
92.                     if (envelope.getResponse() != null) {  
93.                         // 获取服务器响应返回的SoapObject  
94.                         result = (SoapObject) envelope.bodyIn;  
95.                     }  
96.                 } catch (IOException e) {  
97.                     // 当call方法的第一个参数为null时会有一定的概念抛IO异常  
98.                     // 因此需要需要捕捉此异常后用命名空间加方法名作为参数重新连接  
99.                     e.printStackTrace();  
100.                     try {  
101.                         transport.call(nameSpace + methodName, envelope);  
102.                         if (envelope.getResponse() != null) {  
103.                             // 获取服务器响应返回的SoapObject  
104.                             result = (SoapObject) envelope.bodyIn;  
105.                         }  
106.                     } catch (Exception e1) {  
107.                         // e1.printStackTrace();  
108.                         responseHandler.sendMessage(responseHandler.obtainMessage(0, ERROR_FLAG, 0, e1));  
109.                     }  
110.                 } catch (XmlPullParserException e) {  
111.                     // e.printStackTrace();  
112.                     responseHandler.sendMessage(responseHandler.obtainMessage(0, ERROR_FLAG, 0, e));  
113.                 } finally {  
114.                     // 将获取的消息利用Handler发送到主线程  
115.                     responseHandler.sendMessage(responseHandler.obtainMessage(0, SUCCESS_FLAG, 0, result));  
116.                 }  
117.             }  
118.         });  
119.     }  
120.   
121.     /** 
122.      * 设置线程池的大小 
123.      * 
124.      * @param threadSize 
125.      */  
126.     public static void setThreadSize(int threadSize) {  
127.         WebServiceUtils.threadSize = threadSize;  
128.         threadPool.shutdownNow();  
129.         threadPool = Executors.newFixedThreadPool(WebServiceUtils.threadSize);  
130.     }  
131.   
132.     /** 
133.      * 服务器响应接口，在响应后需要回调此接口 
134.      */  
135.     public interface Response {  
136.         public void onSuccess(SoapObject result);  
137.   
138.         public void onError(Exception e);  
139.     }  
140.   
141. }  

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

[java]  view plain  copy

 

1. private void requestLogin(final String userName, final String password) {  
2.         // 参数集合  
3.         SimpleArrayMap mapParams = new SimpleArrayMap();  
4.         mapParams.put("userName", userName + "");  
5.         mapParams.put("password", MD5Test.encrypt(password + ""));  
6.         mapParams.put("autoKey", "");  
7.   
8.         final Dialog dlg = DialogUtils.showProgressDialog(this, "正在登录...");  
9.         WebServiceUtils.call(ServiceConstants.EP_CHJ_USER_SERVICE,  
10.                 ServiceConstants.NP_CHJ, ServiceConstants.M_CHJ_USER_LOGIN, mapParams,  
11.                 new WebServiceUtils.Response() {  
12.                     @Override  
13.                     public void onSuccess(SoapObject result) {  
14.                         LogUtil.i(result + "");  
15.                         processLogin(result, userName, password);  
16.                         dlg.dismiss();  
17.                     }  
18.   
19.                     @Override  
20.                     public void onError(Exception e) {  
21.                         e.printStackTrace();  
22.                         dlg.dismiss();  
23.                     }  
24.                 });  
25.     }