Android 基于ksoap2的webservice请求的学习

 【学习阶段】

• WebService网络请求？

　　　　其实我也是第一次遇到，之所以有这个需要是因为一些与 ERP 相关的业务，需要用到这样的一个请求方式。

• 开始学习WebService 

　　①当然是百度搜索，这里找了一个学习的博客  https://blog.csdn.net/swjtugiser/article/details/76840353

　　　使用 ksoap2 框架请求 ，jar 包下载地址   http://simpligility.github.io/ksoap2-android/getting-started.html  ，放在Project 模式的  libs 目录下。

           根据以上地址进行学习。

 

　　②在开发的过程中我们频繁的用到 网络请求，所以我们最好能封装成像okhttp一样的类。　

package com.example.aust_app;  2 

/*Created by wqy on 2019/11/8.*/

import android.content.Context;  7 import android.os.AsyncTask;  8 
import org.ksoap2.SoapEnvelope;  10 import org.ksoap2.serialization.SoapObject;  11 import org.ksoap2.serialization.SoapSerializationEnvelope;  12 import org.ksoap2.transport.HttpTransportSE;  13 
public class WebRequest {  15 
    private  String SOAP_ACTION="http://WebXml.com.cn/getRegionProvince"; //可以设置一些默认值  17     private  String NAMESPACE="http://WebXml.com.cn/";  18     private  String METHOD_NAME="getRegionProvince";  19     private  String URL="http://ws.webxml.com.cn/WebServices/WeatherWS.asmx?WSDL";  20 
    WebRequest request = null;  22     Context context = null;  23 

    public WebRequest(Context context) {  26         this.context = context;  27  }  28 
    public static WebRequest init(Context context){  30         return new WebRequest(context);  31  }  32 
    public String getSOAP_ACTION() {  34         return SOAP_ACTION;  35  }  36 
    public WebRequest setSOAP_ACTION(String SOAP_ACTION) {  38         this.SOAP_ACTION = SOAP_ACTION;  39         return this;  40  }  41 
    public String getNAMESPACE() {  43         return NAMESPACE;  44  }  45 
    public WebRequest setNAMESPACE(String NAMESPACE) {  47         this.NAMESPACE = NAMESPACE;  48         return this;  49  }  50 
    public String getMETHOD_NAME() {  52         return METHOD_NAME;  53  }  54 
    public WebRequest setMETHOD_NAME(String METHOD_NAME) {  56         this.METHOD_NAME = METHOD_NAME;  57         return this;  58  }  59 
    public String getURL() {  61         return URL;  62  }  63 
    public WebRequest setURL(String URL) {  65         this.URL = URL;  66         return this;  67  }  68 
    private SoapObject getInformation(){  70         SoapObject request=new SoapObject(NAMESPACE,METHOD_NAME);  71 
        SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);  73  envelope.setOutputSoapObject(request);  74         try{  75             HttpTransportSE transportSE=new HttpTransportSE(URL);  76  transportSE.call(SOAP_ACTION,envelope);  77             SoapObject result=(SoapObject)envelope.bodyIn; //获取到返回的结果，并强制转换成SoapObject对象
            SoapObject test = (SoapObject)result.getProperty(0); //该对象中还嵌套了一个SoapObject对象，需要使用getProperty(0)把这个对象提取出来
            return test;  80         }catch (Exception e){  81  e.printStackTrace();  82  }  83         return null;  84  }  85 
    SoapObject result; //在子线程中请求webservice
    class DownloadTask extends AsyncTask<Void,Integer,Boolean> {  88 
 @Override  90         protected Boolean doInBackground(Void... voids) {  91             result = getInformation();  92             return null;  93  }  94 
 @Override  96         protected void onPostExecute(Boolean aBoolean) {  97             StringBuilder builder = new StringBuilder();  98             //解析返回的数据
            for(int i=0;i<result.getPropertyCount();i++){ 100  builder.append(result.getProperty(i)); 101  } 102             if (postExecute!=null){ 103  postExecute.getResult(builder.toString()); 104  } 105  } 106  } 107 
    public void execute(){ 109         new DownloadTask().execute(); 110  } 111 
 PostExecuteListener postExecute; 113     interface PostExecuteListener{ 114         void getResult(String result); 115  } 116 
    public PostExecuteListener getPostExecute() { 118         return postExecute; 119  } 120 
    public WebRequest setPostExecuteListener(PostExecuteListener postExecute) { 122         this.postExecute = postExecute; 123         return this; 124  } 125 }

 

　　③在Activity中使用这样的类

 WebRequest.init(this).setURL("url").setNAMESPACE("namespace").setMETHOD_NAME("methodName") .setSOAP_ACTION("soapAction").setPostExecuteListener(new WebRequest.PostExecuteListener() { @Override public void getResult(String result) { Toast.makeText(Main2Activity.this, ""+result, Toast.LENGTH_SHORT).show(); } }).execute();

 

 【开发阶段】

　　以上是学习阶段，利用别人给的测试接口进行测试，并且进行一定的封装使用，一系列没有任何问题。然后再去进入自己开发阶段。【解决问题⬇🔽⬇】

• 以上遇到的四个参数  URL（请求地址），METHOD_NAME（请求方法名），NAMESPACE（命名空间），SOAP_ACTION（这个我就不知道是什么）

 　　　　但我发现 SOAP_ACTION 好像是 NAMESPACE + METHOD_NAME 。不知道我请求的地址刚好是这样还是如何，但是也有看到是 空值的，但是我空值不通过，我采用的是这样方式。

• 这次学习中并没有讲到 请求头 和 请求参数，那这些怎么传呢？

 　　　　百度搜索 Android ksoap2 可以参考一下这个链接 

　　　　【1】https://blog.csdn.net/fjnu_se/article/details/90647663 可以得到参数传递的方式

　　　　 

 

 　　　　【2】https://www.cnblogs.com/bdsdkrb/p/9258099.html

　　　　　

 

• 修改请求类　

package com.example.aust_app;  2 

/*Created by wqy on 2019/11/8.*/

import android.content.Context;  7 import android.os.AsyncTask;  8 
import com.example.aust_app.utils.LogUtil;  10 import com.example.aust_app.utils.ShareUtils;  11 import com.example.aust_app.utils.ToastTool;  12 
import org.ksoap2.HeaderProperty;  14 import org.ksoap2.SoapEnvelope;  15 import org.ksoap2.serialization.SoapObject;  16 import org.ksoap2.serialization.SoapSerializationEnvelope;  17 import org.ksoap2.transport.HttpTransportSE;  18 
import java.util.ArrayList;  20 import java.util.Map;  21 import java.util.Set;  22 
public class WebRequest {  24 
    private String SOAP_ACTION = "";  26     private String NAMESPACE = "";  27     private String METHOD_NAME = "";  28     private String URL = "http://ip/name.asmx";  29 
    WebRequest request = null;  31     Context context = null;  32 
    public WebRequest(Context context) {  34         this.context = context;  35         URL = ShareUtils.getURL(context);  36         if (URL.equals(""))  37             ToastTool.showShortToast("请配置正确请求地址");  38 
 }  40 
    public static WebRequest init(Context context) {  42         return new WebRequest(context);  43  }  44 
    public String getSOAP_ACTION() {  46         return SOAP_ACTION;  47  }  48 
    public WebRequest setSOAP_ACTION(String SOAP_ACTION) {  50         this.SOAP_ACTION = SOAP_ACTION;  51         return this;  52  }  53 
    public String getNAMESPACE() {  55         return NAMESPACE;  56  }  57 
    public WebRequest setNAMESPACE(String NAMESPACE) {  59         this.NAMESPACE = NAMESPACE;  60         return this;  61  }  62 
    public String getMETHOD_NAME() {  64         return METHOD_NAME;  65  }  66 
    public WebRequest setMETHOD_NAME(String METHOD_NAME) {  68         this.METHOD_NAME = METHOD_NAME;  69         SOAP_ACTION += METHOD_NAME;  70         return this;  71  }  72 
    public String getURL() {  74         return URL;  75  }  76 
    public WebRequest setURL(String URL) {  78         this.URL = URL;  79         return this;  80  }  81 

    private SoapObject getInformation() {  84         SoapObject request = new SoapObject(NAMESPACE, METHOD_NAME);  85 
        if (queryParamsMap != null && queryParamsMap.size() > 0) {  87             Set<String> keys = queryParamsMap.keySet();  88             for (String queryKey : keys) {  89  request.addProperty(queryKey, queryParamsMap.get(queryKey));  90  }  91             LogUtil.logi("param", "" + queryParamsMap);  92  }  93 
        SoapSerializationEnvelope envelope = new SoapSerializationEnvelope(SoapEnvelope.VER11);  95  envelope.setOutputSoapObject(request);  96         envelope.dotNet = true;//很重要  97         try {  98             HttpTransportSE transportSE = new HttpTransportSE(URL);  99             if (headParamsMap != null) 100  transportSE.call(SOAP_ACTION, envelope, addHeadProperty(headParamsMap)); 101             else
 transportSE.call(SOAP_ACTION, envelope); 103             SoapObject result = (SoapObject) envelope.bodyIn; //获取到返回的结果，并强制转换成SoapObject对象
            return result; 105         } catch (Exception e) { 106  e.printStackTrace(); 107             if (postExecute != null) { 108  postExecute.onError(e.toString()); 109  } 110 
 } 112         return null; 113  } 114 
    SoapObject result; //在子线程中请求webservice

    class DownloadTask extends AsyncTask<Void, Integer, Boolean> { 118 
 @Override 120         protected Boolean doInBackground(Void... voids) { 121             result = getInformation(); 122             return null; 123  } 124 
 @Override 126         protected void onPostExecute(Boolean aBoolean) { 127             StringBuilder builder = new StringBuilder(); 128             //解析返回的数据
            if (result != null) 130                 for (int i = 0; i < result.getPropertyCount(); i++) { 131  builder.append(result.getProperty(i)); 132  } 133             LogUtil.logi("result", "" + builder.toString()); 134             if (postExecute != null) { 135  postExecute.getResult(builder.toString()); 136  } 137  } 138  } 139 
    public void execute() { 141         new DownloadTask().execute(); 142  } 143 
 PostExecuteListener postExecute; 145 
    interface PostExecuteListener { 147         void getResult(String result); 148 
        void onError(String result); 150  } 151 
    public PostExecuteListener getPostExecute() { 153         return postExecute; 154  } 155 
    public WebRequest setPostExecuteListener(PostExecuteListener postExecute) { 157         this.postExecute = postExecute; 158         return this; 159  } 160 
    Map<String, Object> queryParamsMap; 162     Map<String, Object> headParamsMap; 163 
    public Map<String, Object> getQueryParamsMap() { 165         return queryParamsMap; 166  } 167 
    public WebRequest setQueryParamsMap(Map<String, Object> queryParamsMap) { 169         this.queryParamsMap = queryParamsMap; 170         return this; 171  } 172 
    public Map<String, Object> getHeadParamsMap() { 174         return headParamsMap; 175  } 176 
    public WebRequest setHeadParamsMap(Map<String, Object> headParamsMap) { 178         this.headParamsMap = headParamsMap; 179         return this; 180  } 181 
    public ArrayList<HeaderProperty> addHeadProperty(Map<String, Object> headerParamsMap) { 183         ArrayList<HeaderProperty> headerProperty = new ArrayList<>(); 184         //添加head参数
        if (headerParamsMap != null && headerParamsMap.size() > 0) { 186             Set<String> keys = headerParamsMap.keySet(); 187             for (String headerKey : keys) { 188                 headerProperty.add(new HeaderProperty(headerKey, (String) headerParamsMap.get(headerKey))); 189  } 190  } 191         return headerProperty; 192  } 193 
}

 

• 在Activity中使用

        Map<String, Object> param = new HashMap<>(); param.put("param", {{参数}}); WebRequest.init(this) .setMETHOD_NAME("QueryItem") .setQueryParamsMap(param) .setPostExecuteListener(new WebRequest.PostExecuteListener() { @Override public void getResult(String result) { LogUtil.logi("TAG", result);//拿到返回结果
 } @Override public void onError(String result) { //请求错误的接口
                        ToastTool.showShortToast("请求发生错误！"); } }) .execute(); 

 

【最后问题】

　　在传参方式，四个参数都准备完毕的时候，遇到了一个问题就是：可以请求无参数的方法是成功的，但是有参数的后台方法请求得到的参数都是为空的。

这里一个很重要的就是（我是通过如下方式解决的，Java和PHP都要设置这样的一个属性）

　　envelope.dotNet = true;

　　但在百度的时候解决方法也有很多，比如，命名空间后面要加 “/” ，如果以上方式并未成功，建议参考如下方式：

　　

 

 【最后最后】

　　温馨提示：webservice 也是网络请求，Android 清单文件不要忘记加 网络访问 的权限 。