webservice使用基本技巧

Posted 2020-08-16

一,webService基本概念

webService也叫XMLWeb SerVice WebService是一种可以接收从Internet或者Intranet上的其它系统中传递过来的请求，轻量级的独立通讯技术。是:通过SOAP在Web上提供的软件（服务），使用WSDL文件进行（说明），并通过（UDDI）进行注册。

XML：(Extensible Markup Language)扩展型可标记语言。面向短期的临时数据处理、面向万维网络，是Soap的基础。

Soap：(Simple Object Access Protocol)简单对象存取协议。是XML Web Service 的通信协议。当用户通过UDDI找到你的WSDL描述文档后，他通过可以SOAP调用你建立的Web服务中的一个或多个操作。SOAP是XML文档形式的调用方法的规范，它可以支持不同的底层接口，像HTTP(S)或者SMTP。

WSDL：(Web Services Description Language) WSDL 文件是一个 XML 文档，用于说明一组 SOAP 消息以及如何交换这些消息。大多数情况下由软件自动生成和使用。

UDDI (Universal Description, Discovery, and Integration) 是一个主要针对Web服务供应商和使用者的新项目。在用户能够调用Web服务之前，必须确定这个服务内包含哪些商务方法，找到被调用的接口定义，还要在服务端来编制软件，UDDI是一种根据描述文档来引导系统查找相应服务的机制。UDDI利用SOAP消息机制（标准的XML/HTTP）来发布，编辑，浏览以及查找注册信息。它采用XML格式来封装各种不同类型的数据，并且发送到注册中心或者由注册中心来返回需要的数据。

 http soap之间的关系

http:是一个客户端和服务器端请求和应答的标准（TCP）。http协议其目的是为了提供一种发布和接收http页面的方法。

http协议的客户端与服务器的交互：由HTTP客户端发起一个请求，建立一个到服务器指定端口（默认是80端口）的TCP连接。HTTP服务器则在那个端口监听客户端发送过来的请求。一旦收到请求，服务器（向客户端）发回一个状态行，比如"HTTP/1.1 200 OK"，和（响应的）消息，消息的消息体可能是请求的文件、错误消息、或者其它一些信息。

soap 协议：它描述了一种在分散或分布式的环境中如何交换信息的轻量级协议。soap在http协议的基础上，一个基于XML的协议。

不同：都是底层的通信协议，请求包的格式不同而已，soap包是XML格式,http纯文本格式。

关系：SOAP是个通信协议， SOAP在HTTP协议的基础上，把编写成XML的REQUEST参数, 放在HTTP BODY上提交个WEB SERVICE服务器(SERVLET，ASP什么的) 处理完成后，结果也写成XML作为RESPONSE送回用户端， 为了使用户端和WEB SERVICE可以相互对应，可以使用WSDL作为这种通信方式的描述文件，利用WSDL工具可以自动生成WS和用户端的框架文件，SOAP具备把复杂对象序列化捆绑到XML里去的能力。

二,C#实现webservice通讯的基本方法

1.引用using system.net 使用自带的 HttpWebRequest与HttpWebresponse实现。这种方法少先复杂。

HttpWebRequest类主要利用Http协议和服务器交互，通常是通过Get和Post两种方式来对数据进行获取与提交；

Get方式：

post方式Get 方式通过在网络地址附加参数来完成数据的提交，比如在地址http://www.jb51.net/?hl=zh-CN 中，前面部分 http://www.jb51.net表示数据提交的网址，后面部分 hl=zh-CN 表示附加的参数，其中 hl 表示一个键(key)， zh-CN 表示这个键对应的值(value)。

c#代码如下：

HttpWebRequest wrequest = (HttpWebRequest)WebRequest.Create( "http://www.jb51.net?hl=zh-CN" );
wrequest.Method = "GET";
HttpWebResponse webResponse = (HttpWebResponse)wrequest.GetResponse();
StreamReader sr = new StreamReader(webResponse.GetResponseStream(), Encoding.UTF8);
string data= sr.ReadToEnd();
return data;

另：发送带参数

 

protected ResultInfo AddInstrumetStatus(string instrument_id, string status, string message)
{

try
{
string postDataStr = instrument_id + "&" + status + "&" + message;
string URL =Url + (postDataStr == "" ? "" : "?") + postDataStr;
HttpWebRequest myRequest = (HttpWebRequest)WebRequest.Create(URL);
myRequest.Method = "POST";
myRequest.ContentType = "application/json;charset=UTF-8";
myRequest.MediaType = "application/json";
myRequest.Accept = "application/json";
if (!string.IsNullOrEmpty(this._userName) && !string.IsNullOrEmpty(this._password))
{
myRequest.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.ASCII.GetBytes(this._userName + ":" + this._password)));
}
//接收数据
HttpWebResponse myResponse = (HttpWebResponse)myRequest.GetResponse();
if (myResponse.StatusCode == HttpStatusCode.Created)
{
result.IsSuccess = true;
using (Stream s = myResponse.GetResponseStream())
{
StreamReader myStreamReader = new StreamReader(s, Encoding.UTF8);
result.ResultData = myStreamReader.ReadToEnd();
myStreamReader.Close();
myResponse.Close();
s.Close();
myRequest.Abort();
}
}

else if (myResponse.StatusCode == HttpStatusCode.OK)
{
//result.ValidateMessages = new Dictionary<string, string>();
//fill valid messages from response content

}
else
{
result.ResultMessage = String.Format("GetTaskConfig failed {0}", myResponse.StatusCode);
}
}
catch (Exception ex)
{
throw new Exception("the zlims api connected exception, " + ex.ToString());
}
return result;

post方式：

 

String Strjson；//发送的数据
byte[] payload = System.Text.Encoding.UTF8.GetBytes(Strjson);
ResultInfo result = new ResultInfo();
try
{
HttpWebRequest myRequest = (HttpWebRequest)WebRequest.Create(Url);
myRequest.Method = "POST";
myRequest.ContentType = "application/json;charset=UTF-8";
myRequest.MediaType = "application/json";
myRequest.Accept = "application/json";
if (!string.IsNullOrEmpty(this._userName) && !string.IsNullOrEmpty(this._password))
{
myRequest.Headers.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.ASCII.GetBytes(this._userName + ":" + this._password)));
}
myRequest.ContentLength = payload.Length;
//发送数据
using (Stream Writer = myRequest.GetRequestStream())
{
Writer.Write(payload, 0, payload.Length);
Writer.Close();
}
//接收数据
HttpWebResponse myResponse;
myResponse = (HttpWebResponse)myRequest.GetResponse();
if (myResponse != null)
{
result.IsSuccess = true;
using (Stream s = myResponse.GetResponseStream())
{
StreamReader myStreamReader = new StreamReader(s, Encoding.UTF8);
result.ResultData = myStreamReader.ReadToEnd();
myStreamReader.Close();
myResponse.Close();
s.Close();
myRequest.Abort();
}
}

else if (myResponse.StatusCode == HttpStatusCode.OK)
{

}
else
{
result.ResultMessage = String.Format("GetTaskConfig failed {0}", myResponse.StatusCode);
}
}
catch (Exception ex)
{
throw new Exception("the zlims api connected exception, " + ex.ToString());
}
return result;

}