XML Web Service初体验: HTTP-GET, HTTP-POST and SOAP的比较

  <webServices>
      <protocols>
        <add name="HttpPost" />
        <add name="HttpGet" />
        <add name="Documentation" />
      </protocols>
    </webServices>


以下转贴

===============================

XML Web Service初体验: HTTP-GET, HTTP-POST and SOAP的比较
2007-07-15 08:58
XML Web Service初体验: HTTP-GET, HTTP-POST and SOAP的比较

                                                                                          作者:常建昭

在ASP.NET 中,XML Web Service支持三种协议来与用户交流数据。这三种协议分别是:

1. SOAP:Simple Object Access Protocol

2.  HTTP-GET

3.   HTTP-POST

1.首先我们先来理解一下这三者的大概定义。

在这三种协议中,SOAP是XML Web Service最常用到的连接协议。与HTTP相比,SOAP显的更为复杂,但却拥有更强的接受能力。SOAP是一种以XML为基础的协议,它提供一种将数据打包(Packaging)和 编码(Encoding)的方法,以用于网络的数据传输。任意一个用户都可以使用SOAP协议与任何一个XML Web Service进行通信,甚至于说这个XML Web Service不是建立在.NET 平台上的,比如说Java的,我们都可以利用SOAP来进行数据传输。因此可见,SOAP也是Language Independent.(语言独立性)

HTTP(Hypertext Transfer Protocol) 已经是众所周知的协议了,它是XML Web Service数据传输的标准,这包括了在使用SOAP传输数据的时候。HTTP将SOAP 消息压缩,然后以它的形式进行网络传输。然而当我们谈及在XML Web Service下使用HTTP-GET和HTTP-POST的时候,我们实事上在谈有关单独使用HTTP调用XML Web Service中的方法的能力,这里我说的单独使用,指的是不使用SOAP。

在HTTP中,GET 和 POST并不是一种协议,它们是可以用来与Web Service交互的几种方法中的其中二种。然而,这二种方法的传送参数和数据的能力使它们变成了一种简单的,非常适合用来调用XML Web Service的工具。

 


2.HTTP-GET 和 HTTP-POST 的比较

这二者最大的区别在于数据是如何与要求的消息捆绑在一起的。

HTTP-GET的处理特征如下:

。将数据添加到URL

。利用一个问号(”?”)代表URL地址的结尾与数据的开端。

。每一个数据的元素以 名称/值 (name/value) 的形式出现。

。利用一个分号(“;”)来区分多个数据元素。

HTTP-POST的处理特征如下:

。将数据包括在HTTP主体中。

。同样的,数据的元素以 名称/值 (name/value) 的形式出现。

。但是每一个数据元素分别占用主体的一行。

从这二者不同的处理特征,可以看出它们的不同之处,而大家也可以利用IE打开一个Web Service文件,在页面中,IE会显示出二种的数据的不同之处。

 

3.HTTP和SOAP的比较

HTTP-GET 和 HTTP-POST 提供了一个简单的与XML Web Service交互的工具,与SOAP相比,它有以下几点好处:

。 能够非常容易的创建正确的HTTP-GET 和 HTTP-POST消息,当面向的客户是不能使用SOAP的客户时,HTTP-GET 和 HTTP-POST是最好的选择。

。响应HTTP-GET 和 HTTP-POST的消息,并不需要复杂的XML处理。响应之中包括了XML,但它有一个简单的框架并能够轻易的利用一般的技术处理响应。这些特点使HTTP-GET 和 HTTP-POST对于不支持XML的平台来说,变的异常的有用。

。HTTP-GET 和 HTTP-POST消息比起SOAP消息来说,更为简单。这有利于提高整体的性能。

然而,有得必有失,有好必有坏,它们也存在不可忽略的缺点:

。不能够利用HTML调用XML Web Service中的以复杂数据类型为参数的方法。

。你可以调用XML Web Service中返回值为复杂数据类型的方法,但是响应将仅包括复杂数据类型中各个区域中的名字/值,并且返回的值并没有结构可言。你必须手动的将数据解压缩到WSDL文件。

。在HTTP中,你不能使用reference进行参数的传输。

。使用HTTP与XML Web Service进行交流,不是一个agreed-to工业标准技术。虽然HTTP会在ASP.NET Web Application中与XML Web Service正常工作,但不保证它在其它的环境下正常工作。

这是我对XML Web Service的初步认识,难免有些错误。如果不对,还请大家指正。

本文主要的参考资料:

<<Microsoft .NET XML Web Services Step by Step>>

作者:Adam Freeman, Allen Jones

===============================================

.Net下采用GET/POST/SOAP方式动态调用WebService的简易灵活方法(C#)

 

一直以来,我都为动态调用WebService方法而烦恼。在.Net环境下,最常用的方法就是采用代理类来调用WebService,可以通过改变代理类的Url属性来实现动态调用,但当xmlns改变时就会出错,似乎要重新绑定Webservice并重新编译后才能再次运行。我还试过网上的一种动态编译并动态调用WebService的方式,这种方法效率低,而且需要有较高的权限,否则编译失败。我曾在Sql Server 2005的CLR存储过程中用此方法调用WebService时,浪费了大半天时间,无论怎么试它就是不能成功编译。于是我便不断思考其他的方法,今天晚上终于写了一个类用于动态调用WebService,只需传入WebService地址、需调用的方法及其参数,就可以随时动态调用了。现分享给大家,代码如下:

 

 

using System;
using System.Web;
using System.Xml;
using System.Collections;
using System.Net;
using System.Text;
using System.IO;

/** <summary>
/// 利用WebRequest/WebResponse进行WebService调用的类,By 同济黄正
/// </summary>
public class WebSvcCaller
...{
    //<webServices>
    //  <protocols>
    //    <add name="HttpGet"/>
    //    <add name="HttpPost"/>
    //  </protocols>
    //</webServices>

    private static Hashtable _xmlNamespaces = new Hashtable();//缓存xmlNamespace,避免重复调用GetNamespace

    /** <summary>
    /// 需要WebService支持Post调用
    /// </summary>
    public static XmlDocument QueryPostWebService(String URL , String MethodName , Hashtable Pars)
    ...{
        HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(URL + "/" + MethodName);
        request.Method = "POST";
        request.ContentType = "application/x-www-form-urlencoded";
        SetWebRequest(request);
        byte[] data = EncodePars(Pars);
        WriteRequestData(request , data);

        return ReadXmlResponse(request.GetResponse());
    }
    /** <summary>
    /// 需要WebService支持Get调用
    /// </summary>
    public static XmlDocument QueryGetWebService(String URL , String MethodName , Hashtable Pars)
    ...{
        HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(URL + "/" + MethodName + "?" + ParsToString(Pars));
        request.Method = "GET";
        request.ContentType = "application/x-www-form-urlencoded";
        SetWebRequest(request);
        return ReadXmlResponse(request.GetResponse());
    }


    /** <summary>
    /// 通用WebService调用(Soap),参数Pars为String类型的参数名、参数值
    /// </summary>
    public static XmlDocument QuerySoapWebService(String URL , String MethodName , Hashtable Pars)
    ...{
        //By 同济黄正 http://hz932.ys168.com 2008-3-19
        if (_xmlNamespaces.ContainsKey(URL))
        ...{
            return QuerySoapWebService(URL , MethodName , Pars , _xmlNamespaces[URL].ToString());
        }
        else
        ...{
            return QuerySoapWebService(URL , MethodName , Pars ,GetNamespace(URL));
        }
    }

    private static XmlDocument QuerySoapWebService(String URL , String MethodName , Hashtable Pars , string XmlNs)
    ...{
        _xmlNamespaces[URL] = XmlNs;//加入缓存,提高效率
        HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(URL);
        request.Method = "POST";
        request.ContentType = "text/xml; charset=utf-8";
        request.Headers.Add("SOAPAction" , """ + XmlNs + (XmlNs.EndsWith("/") ? "" : "/") + MethodName + """);
        SetWebRequest(request);
        byte[] data = EncodeParsToSoap(Pars , XmlNs , MethodName);
        WriteRequestData(request , data);
        XmlDocument doc = new XmlDocument() , doc2 = new XmlDocument();
        doc = ReadXmlResponse(request.GetResponse());

        XmlNamespaceManager mgr = new XmlNamespaceManager(doc.NameTable);
        mgr.AddNamespace("soap" , "http://schemas.xmlsoap.org/soap/envelope/");
        String RetXml = doc.SelectSingleNode("//soap:Body/*" , mgr).InnerXml;
        doc2.LoadXml("<root>" + RetXml + "</root>");
        AddDelaration(doc2);
        return doc2;
    }
    private static string GetNamespace(String URL)
    ...{
        HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL + "?WSDL");
        SetWebRequest(request);
        WebResponse response = request.GetResponse();
        StreamReader sr = new StreamReader(response.GetResponseStream() , Encoding.UTF8);
        XmlDocument doc = new XmlDocument();
        doc.LoadXml(sr.ReadToEnd());
        return doc.SelectSingleNode("//@targetNamespace").Value;
    }
    private static byte[] EncodeParsToSoap(Hashtable Pars , String XmlNs , String MethodName)
    ...{
        XmlDocument doc = new XmlDocument();
        doc.LoadXml("<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"></soap:Envelope>");
        AddDelaration(doc);
        XmlElement soapBody = doc.CreateElement("soap" , "Body" , "http://schemas.xmlsoap.org/soap/envelope/");
        XmlElement soapMethod = doc.CreateElement(MethodName);
        soapMethod.SetAttribute("xmlns" , XmlNs);
        foreach (string k in Pars.Keys)
        ...{
            XmlElement soapPar = doc.CreateElement(k);
            soapPar.InnerText = Pars[k].ToString();
            soapMethod.AppendChild(soapPar);
        }
        soapBody.AppendChild(soapMethod);
        doc.DocumentElement.AppendChild(soapBody);
        return Encoding.UTF8.GetBytes(doc.OuterXml);
    }

    private static void SetWebRequest(HttpWebRequest request)
    ...{
        request.Credentials = CredentialCache.DefaultCredentials;
        request.Timeout = 10000;
    }

    private static void WriteRequestData(HttpWebRequest request , byte[] data)
    ...{
        request.ContentLength = data.Length;
        Stream writer = request.GetRequestStream();
        writer.Write(data , 0 , data.Length);
        writer.Close();
    }

    private static byte[] EncodePars(Hashtable Pars)
    ...{
        return Encoding.UTF8.GetBytes(ParsToString(Pars));
    }

    private static String ParsToString(Hashtable Pars)
    ...{
        StringBuilder sb = new StringBuilder();
        foreach (string k in Pars.Keys)
        ...{
            if (sb.Length > 0)
            ...{
                sb.Append("&");
            }
            sb.Append(HttpUtility.UrlEncode(k) + "=" + HttpUtility.UrlEncode(Pars[k].ToString()));
        }
        return sb.ToString();
    }

    private static XmlDocument ReadXmlResponse(WebResponse response)
    ...{
        StreamReader sr = new StreamReader(response.GetResponseStream() , Encoding.UTF8);
        String retXml = sr.ReadToEnd();
        sr.Close();
        XmlDocument doc = new XmlDocument();
        doc.LoadXml(retXml);
        return doc;
    }

    private static void AddDelaration(XmlDocument doc)
    ...{
        XmlDeclaration decl = doc.CreateXmlDeclaration("1.0" , "utf-8" , null);
        doc.InsertBefore(decl , doc.DocumentElement);
    }
}
 

 

这个类有三个公用的方法:QuerySoapWebService为通用的采用Soap方式调用WebService,QueryGetWebService采用GET方式调用,QueryPostWebService采用POST方式调用,后两个方法需要WebService服务器支持相应的调用方式。三个方法的参数和返回值相同:URL为Webservice的Url地址(以.asmx结尾的);MethodName为要调用的方法名称;Pars为参数表,它的Key为参数名称,Value为要传递的参数的值。注意方法名称、参数名称、参数个数必须完全匹配才能正确调用。第一次以Soap方式调用时,因为需要查询WSDL获取xmlns,因此需要时间相对长些,第二次调用不用再读WSDL,直接从缓存读取。这三个方法的返回值均为XmlDocument对象,这个返回的对象可以进行各种灵活的操作。最常用的一个SelectSingleNode方法,可以让你一步定位到Xml的任何节点,再读取它的文本或属性。也可以直接调用Save保存到磁盘。采用Soap方式调用时,根结点名称固定为root。

这个类主要是利用了WebRequest/WebResponse来完成各种网络查询操作。为了精简明了,这个类中没有添加错误处理,需要在调用的地方设置异常捕获。

下面是一个调用实例:

 

 

    protected void Page_Load(object sender , EventArgs e)
    ...{
        try
        ...{
            Hashtable pars = new Hashtable();
            String Url = "http://www.260dns.cn/Services/Weather.asmx";
            pars["city"] = "上海";
            pars["wdate"]="2008-3-19";
            XmlDocument doc = WebSvcCaller.QuerySoapWebService(Url , "GetWeather" , pars);
            Response.Write(doc.OuterXml);
        }
        catch (Exception ex)
        ...{
            Response.Write(ex.Message);
        }
    }

 

 

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值