基于Web Service的客户端框架搭建一：C#使用Http Post方式传递Json数据字符串调用Web Service

时间：2022-09-24 12:56:32

引言

　　前段时间一直在做一个ERP系统，随着系统功能的完善，客户端（CS模式）变得越来越臃肿。现在想将业务逻辑层以下部分和界面层分离，使用Web Service来做。由于C#中通过直接添加引用的方来调用Web Service的方式不够灵活，故采取手动发送Http请求的方式来调用Web Service。最后选择使用Post方式来调用Web Service，至于安全性和效率暂不考虑。在学习使用的过程，遇到了很多问题，也花了很长时间来解决，网上相关的帖子很少，如果各位在使用的过程中有一些问题难以解决，可以找我哦。

前提

　　使用Post方式调用Web Service，需要在服务项目配置文件Web.config中添加使用Http协议的配置，在<system.web>标签中添加<webServices> <protocols> <add name= "HttpPost"/></protocols></webServices>配置，同时我们还可以添加<customErrors mode="Off" />配置，这样可以在服务方法的返回值带出服务方法调用的异常信息，异常信息同样以xml的形式返回，这样便于客户端进行调试。

Web Service接口方法

　　　[WebMethod]
        public string Project(string paramaters)
        {
            return paramaters;
        }

实现代码

        public string Post(string methodName, string jsonParas)

         {

             string strURL = Url + "/" + methodName;

             //创建一个HTTP请求

             HttpWebRequest request = (HttpWebRequest)WebRequest.Create(strURL);

             //Post请求方式

             request.Method = "POST";

             //内容类型

             request.ContentType = "application/x-www-form-urlencoded";

             //设置参数，并进行URL编码

             //虽然我们需要传递给服务器端的实际参数是JsonParas(格式：[{\"UserID\":\"0206001\",\"UserName\":\"ceshi\"}])，

             //但是需要将该字符串参数构造成键值对的形式（注："paramaters=[{\"UserID\":\"0206001\",\"UserName\":\"ceshi\"}]"），

             //其中键paramaters为WebService接口函数的参数名，值为经过序列化的Json数据字符串

             //最后将字符串参数进行Url编码

             string paraUrlCoded = System.Web.HttpUtility.UrlEncode("paramaters");

             paraUrlCoded += "=" + System.Web.HttpUtility.UrlEncode(jsonParas);

             byte[] payload;

             //将Json字符串转化为字节

             payload = System.Text.Encoding.UTF8.GetBytes(paraUrlCoded);

             //设置请求的ContentLength

             request.ContentLength = payload.Length;

             //发送请求，获得请求流  

             Stream writer;

             try

             {

                 writer = request.GetRequestStream();//获取用于写入请求数据的Stream对象

             }

             catch (Exception)

             {

                 writer = null;

                 Console.Write("连接服务器失败!");

             }

             //将请求参数写入流

             writer.Write(payload, , payload.Length);

             writer.Close();//关闭请求流

             String strValue = "";//strValue为http响应所返回的字符流

             HttpWebResponse response;

             try

             {

                 //获得响应流

                 response = (HttpWebResponse)request.GetResponse();

             }

             catch (WebException ex)

             {

                 response = ex.Response as HttpWebResponse;

             }

             Stream s = response.GetResponseStream();

             //服务器端返回的是一个XML格式的字符串，XML的Content才是我们所需要的Json数据

             XmlTextReader Reader = new XmlTextReader(s);

             Reader.MoveToContent();

             strValue = Reader.ReadInnerXml();//取出Content中的Json数据

             Reader.Close();

             s.Close();

             return strValue;//返回Json数据

         }

　　Url的格式样例："http://59.68.29.106:8087/IFT_Project.asmx"

　　methodName参数就是"Project"

　　JsonParas就是使用C# JavaScriptSerializer将List<Object>类型的对象序列化之后得到的值，数据格式：[{\"UserID\":\"0206001\",\"UserName\":\"ceshi\"}]，Json数据中的中括号代表由着多个对象集合序列化，花括号代表一个对象序列化得到的结果，花括号里面的内容使用键值对的方式展示，多个属性之间用逗号隔开，每个对象也用逗号隔开。

　　request.ContentType必须设置值，建议使用"application/x-www-form-urlencoded"，设置其他值就很容易报服务器内部异常，使用这种方式服务接口方法返回的是xml格式的字符串

　　payload将请求参数转换成二进制来保存，此处一定要将“paramaters”加入其中，不然会报异常缺少参数，paramaters就是服务接口函数的参数名。函数中使用了URL编码，注意在编码的时候只需要将键和值进行编码，不要将中间的=进行编码，不然getResponse的时候会报异常。

　　request.ContentLength也是必须设置的值

　　在得到响应流之后Stream s = response.GetResponseStream();需要使用Reader来解析响应流，这个地方我使用的是XmlTextReader，因为我服务方法返回的是xml格式的字符串，其中Json数据在xml的Content中。在取出Json数据之后，再进行相应的反序列化即可得到对象。

小结

　　在学习使用Post调用方式的过程中，查看了一些帖子，但是网上的帖子很少，不少帖子中也给出了一下Post方法的样例，给出的很多post方法没有明确给出传入字符串的格式，导致我的传入参数jsonParas缺少了键paramaters，测试调试了很久才发现这个错误，最终差点放弃了。还有ContentType的设置也很重要，使用其他的值对传入参数的要求很高，初学者不建议使用其他方式。初期使用Post方式的时候，在getResponse()处容易报异常，可以设置customerErrors mode将异常信息返回给客户端，这样容易调试。

相关文章