C# webservice开发

　　

一、Webservice简介
Web Service也叫XML Web Service。 Web Service是一种可以接收从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格式来封装各种不同类型的数据，并且发送到注册中心或者由注册中心来返回需要的数据。

　　Web Service的主要目标是跨平台的可互操作性。为了实现这一目标，Web Service 完全基于XML（可扩展标记语言）、XSD（XML Schema）等独立于平台、独立于软件供应商的标准，是创建可互操作的、分布式应用程序的新平台。因此使用Web Service有许多优点:

　　1、跨防火墙的通信

　　如果应用程序有成千上万的用户，而且分布在世界各地，那么客户端和服务器之间的通信将是一个棘手的问题。因为客户端和服务器之间通常会有防火墙或者代理服务器。传统的做法是，选择用浏览器作为客户端，写下一大堆ASP页面，把应用程序的中间层暴露给最终用户。这样做的结果是开发难度大，程序很难维护。 要是客户端代码不再如此依赖于HTML表单，客户端的编程就简单多了。如果中间层组件换成Web Service的话，就可以从用户界面直接调用中间层组件，从而省掉建立ASP页面的那一步。要调用Web Service，可以直接使用Microsoft SOAP Toolkit或.net这样的SOAP客户端，也可以使用自己开发的SOAP客户端，然后把它和应用程序连接起来。不仅缩短了开发周期，还减少了代码复杂度，并能够增强应用程序的可维护性。同时，应用程序也不再需要在每次调用中间层组件时，都跳转到相应的"结果页"。

　　2、应用程序集成

　　企业级的应用程序开发者都知道，企业里经常都要把用不同语言写成的、在不同平台上运行的各种程序集成起来，而这种集成将花费很大的开发力量。应用程序经常需要从运行的一台主机上的程序中获取数据；或者把数据发送到主机或其它平台应用程序中去。即使在同一个平台上，不同软件厂商生产的各种软件也常常需要集成起来。通过Web Service，应用程序可以用标准的方法把功能和数据"暴露"出来，供其它应用程序使用。

　　XML Web services 提供了在松耦合环境中使用标准协议（HTTP、XML、SOAP 和 WSDL）交换消息的能力。消息可以是结构化的、带类型的，也可以是松散定义的。

　　3、B2B的集成

　　B2B 指的是Business to Business，as in businesses doing business with other businesses,商家(泛指企业)对商家的电子商务，即企业与企业之间通过互联网进行产品、服务及信息的交换。通俗的说法是指进行电子商务交易的供需双方都是商家(或企业、公司)，她们使用了Internet的技术或各种商务网络平台，完成商务交易的过程。

　　Web Service是B2B集成成功的关键。通过Web Service，公司可以只需把关键的商务应用"暴露"给指定的供应商和客户，就可以了，Web Service运行在Internet上，在世界任何地方都可轻易实现，其运行成本就相对较低。Web Service只是B2B集成的一个关键部分，还需要许多其它的部分才能实现集成。 用Web Service来实现B2B集成的最大好处在于可以轻易实现互操作性。只要把商务逻辑"暴露"出来，成为Web Service，就可以让任何指定的合作伙伴调用这些商务逻辑，而不管他们的系统在什么平台上运行，使用什么开发语言。这样就大大减少了花在B2B集成上的时间和成本。

　　4、软件和数据重用

　　Web Service在允许重用代码的同时，可以重用代码背后的数据。使用Web Service，再也不必像以前那样，要先从第三方购买、安装软件组件，再从应用程序中调用这些组件；只需要直接调用远端的Web Service就可以了。另一种软件重用的情况是，把好几个应用程序的功能集成起来，通过Web Service "暴露"出来，就可以非常容易地把所有这些功能都集成到你的门户站点中，为用户提供一个统一的、友好的界面。 可以在应用程序中使用第三方的Web Service 提供的功能，也可以把自己的应用程序功能通过Web Service 提供给别人。两种情况下，都可以重用代码和代码背后的数据。

　　从以上论述可以看出，Web Service 在通过Web进行互操作或远程调用的时候是最有用的。不过，也有一些情况，Web Service根本不能带来任何好处，Web Service有以下缺点：

　　1、 单机应用程序

　　目前，企业和个人还使用着很多桌面应用程序。其中一些只需要与本机上的其它程序通信。在这种情况下，最好就不要用Web Service，只要用本地的API就可以了。COM非常适合于在这种情况下工作，因为它既小又快。运行在同一台服务器上的服务器软件也是这样。当然Web Service 也能用在这些场合，但那样不仅消耗太大，而且不会带来任何好处。

　　2、 局域网的一些应用程序

　　在许多应用中，所有的程序都是在Windows平台下使用COM，都运行在同一个局域网上。在这些程序里，使用DCOM会比SOAP/HTTP有效得多。与此相类似，如果一个.net程序要连接到局域网上的另一个.net程序，应该使用.net Remoting。其实在.net Remoting中，也可以指定使用SOAP/HTTP来进行Web Service 调用。不过最好还是直接通过TCP进行RPC调用，那样会有效得多。

小结：从体系结构上来说Web Service大概分为5个层次：

1. Http传输信道  2. XML的数据格式  3. SOAP封装格式  4. WSDL的描述方式  5. UDDI

　　总体上来讲，.NET 下的 Web Service结构比较简单，也比较容易理解和应用。在.NET结构下的WebService应用都是基于.net framework以及IIS的架构之下，所以部署(Dispose)起来相对比较容易点。

　　从实现的角度来讲， 首先WebService必须把暴露给客户端的方法所在的类继承于：System.Web.Services.WebService这个基类 ，其次所暴露的方法前面必须有[WebMethod]或者[WebMethodAttribute] 。

　　WebService的运行机理  　　首先客户端从服务器的到WebService的WSDL，同时在客户端声称一个代理类(Proxy Class)，这个代理类负责与WebService服务器进行Request 和Response ，当一个数据（XML格式的）被封装成SOAP格式的数据流发送到服务器端的时候，就会生成一个进程对象并且把接收到这个Request的SOAP包进行解析，然后对事物进行处理，处理结束以后再对这个计算结果进行SOAP包装，然后把这个包作为一个Response发送给客户端的代理类(Proxy Class)，同样地，这个代理类也对这个SOAP包进行解析处理，继而进行后续操作。这就是WebService的一个运行过程。

常用的webservice接口

快递查询接口 http://webservice.36wu.com/ExpressService.asmx
ip查询接口 http://webservice.36wu.com/ipService.asmx
天气预报接口 http://webservice.36wu.com/weatherService.asmx

http://www.webxml.com.cn/WebServices/WeatherWebService.asmx
身份证查询接口 http://webservice.36wu.com/IdCardService.asmx
手机归属地接口 http://webservice.36wu.com/MobilePhoneService.asmx
翻译接口 http://webservice.36wu.com/TranslationService.asmx
火车时刻接口：http://webservice.36wu.com/TrainService.asmx
股票查询接口：http://webservice.36wu.com/StockService.asmx
邮编接口：http://webservice.36wu.com/ZipcodeService.asmx
二维码Web服务 http://webservice.36wu.com/DimensionalCodeService.asmx
公交查询Web服务 http://webservice.36wu.com/mapService.asmx 
ISBN查询Web服务 http://webservice.36wu.com/ISBNService.asmx
ICP备案查询Web服务  http://webservice.36wu.com/ICPServic.asmx

 

 三、返回数据的四种形式

（1）直接返回DataSet对象
  （2）返回DataSet对象用Binary序列化后的字节数组
  （3）返回DataSetSurrogate对象用Binary序列化后的 字节数组
  （4）返回DataSetSurrogate对象用Binary序列化并Zip 压缩后的字节数组

下面展示这四种返回数据的代码，其中（1）是其三种方法的根本，都要得到一个DataSet作为根本，然后来做各种转换压缩的操作：

[WebMethod(Description = "直接返回DataSet对象")] 
    public DataSet GetDataSet() 
    { 
        string connStr = System.Configuration.ConfigurationManager.ConnectionStrings["conn"].ToString(); 
        SqlConnection conn = new SqlConnection(connStr); 
        string sql = "select * from china_city"; 
        conn.Open(); 
        SqlDataAdapter sda = new SqlDataAdapter(sql, conn); 
        DataSet ds = new DataSet("China"); 
        sda.Fill(ds); 
        conn.Close(); 
        return ds; 
    } 
 
    [WebMethod(Description = "直接返回DataSet对象，并用Binary序列化后的字节数组")] 
    public byte[] GetDataSetBytes() 
    { 
        DataSet ds = GetDataSet(); 
        BinaryFormatter ser = new BinaryFormatter();  //序列化对象 
        MemoryStream ms = new MemoryStream();  //内存流 
        ser.Serialize(ms, ds); 
        byte[] buffer = ms.ToArray();    //字节流 
        return buffer; 
    } 
 
    [WebMethod(Description = "直接返回DataSetSurrogate对象，并用Binary序列化后的字节数组")] 
    public byte[] GetDataSetSurrogateBytes() 
    { 
        DataSet ds = GetDataSet(); 
        DataSetSurrogate dss = new DataSetSurrogate(ds); 
        BinaryFormatter ser = new BinaryFormatter();  //序列化对象 
        MemoryStream ms = new MemoryStream();  //内存流 
        ser.Serialize(ms, dss); 
        byte[] buffer = ms.ToArray();    //字节流 
        return buffer; 
 
    } 
 
    [WebMethod(Description = "直接返回DataSetSurrogate对象，并用Binary序列化后并且ZIP压缩的字节数组")] 
    public byte[] GetDataSetSurrogateZipBytes() 
    { 
        DataSet ds = GetDataSet(); 
        DataSetSurrogate dss = new DataSetSurrogate(ds); 
        BinaryFormatter ser = new BinaryFormatter();  //序列化对象 
        MemoryStream ms = new MemoryStream();  //内存流 
        ser.Serialize(ms, dss); 
        byte[] buffer = ms.ToArray();    //字节流 
        byte[] bufferZip = ComPress(buffer); 
        return buffer; 
    } 
    //压缩方法 
    public byte[] ComPress(byte[] data) 
    { 
        try 
        { 
            MemoryStream ms = new MemoryStream(); 
            Stream zipStream = null; 
            zipStream = new GZipStream(ms, CompressionMode.Compress, true); 
            zipStream.Write(data, 0, data.Length); 
            zipStream.Close(); 
            ms.Position = 0; 
            byte[] compressed_data = new byte[ms.Length]; 
            ms.Read(compressed_data, 0, int.Parse(ms.Length.ToString())); 
            return compressed_data; 
        } 
        catch 
        { 
            return null; 
        } 
    }

四、调用数据

客户端WebService程序

private void button1_Click(object sender, EventArgs e) 
    { 
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1();  //new出WebService对象 
        DateTime dtBegin = DateTime.Now; 
        DataSet dataSet = ds.GetNorthwindDataSet(); 
        this.label1.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin); 
        binddata(dataSet); 
    } 
    private void button2_Click(object sender, EventArgs e) 
    { 
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1(); 
        DateTime dtBegin = DateTime.Now; 
        byte[] buffer = ds.GetDataSetBytes(); 
        BinaryFormatter ser = new BinaryFormatter(); 
        DataSet dataSet = ser.Deserialize(new MemoryStream(buffer)) as DataSet; 
        this.label2.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin) + "  " + buffer.Length; 
        binddata(dataSet); 
    } 
    private void button3_Click(object sender, EventArgs e) 
    { 
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1(); 
        DateTime dtBegin = DateTime.Now; 
        byte[] buffer = ds.GetDataSetSurrogateBytes(); 
        BinaryFormatter ser = new BinaryFormatter(); 
        DataSetSurrogate dss = ser.Deserialize(new MemoryStream(buffer)) as DataSetSurrogate; 
        DataSet dataSet = dss.ConvertToDataSet(); 
        this.label3.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin) + "  " + buffer.Length; 
        binddata(dataSet); 
    } 
    private void button4_Click(object sender, EventArgs e) 
    { 
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1(); 
        DateTime dtBegin = DateTime.Now; 
        byte[] zipBuffer = ds.GetDataSetSurrogateZipBytes(); 
        byte[] buffer = UnZipClass.Decompress(zipBuffer); 
        BinaryFormatter ser = new BinaryFormatter(); 
        DataSetSurrogate dss = ser.Deserialize(new MemoryStream(buffer)) as DataSetSurrogate; 
        DataSet dataSet = dss.ConvertToDataSet(); 
        this.label4.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin) + "  " + zipBuffer.Length; 
        binddata(dataSet); 
    } 
    private void binddata(DataSet dataSet) 
    { 
        this.dataGridView1.DataSource = dataSet.Tables[0]; 
        this.label5.Text = "共计：" + dataSet.Tables[0].Rows.Count + "条记录"; 
    }

在数据返回的方法中，我们使用了数据的压缩，所以，在调用方这边，需要进行解压，代码：

客户端UnZipClass程序 
    public static class UnZipClass 
    { 
        public static byte[] Decompress(byte[] data) 
        { 
            try 
            { 
                MemoryStream ms = new MemoryStream(data); 
                Stream zipStream = null; 
                zipStream = new GZipStream(ms, CompressionMode.Decompress); 
                byte[] dc_data = null; 
                dc_data = ExtractBytesFromStream(zipStream, data.Length); 
                return dc_data; 
            } 
            catch 
            { 
                return null; 
            } 
        } 
        public static byte[] ExtractBytesFromStream(Stream zipStream, int dataBlock) 
        { 
            byte[] data = null; 
            int totalBytesRead = 0; 
            try 
            { 
                while (true) 
                { 
                    Array.Resize(ref data, totalBytesRead + dataBlock + 1); 
                    int bytesRead = zipStream.Read(data, totalBytesRead, dataBlock); 
                    if (bytesRead == 0) 
                    { 
                        break; 
                    } 
                    totalBytesRead += bytesRead; 
                } 
                Array.Resize(ref data, totalBytesRead); 
                return data; 
            } 
            catch 
            { 
                return null; 
            } 
        } 
    }

 

通过反射动态调用webservices

该方法可以使程序不通过web引用的方式去调用webservices方法，直接在代码里调用该方法就能达到动态调用webservices的目的。使用前先引用System.Web.Services动态链接库，是.net自带的dll。

解决方案：添加动态调用WebService类WebServiceHelper；代码如下：

WebServiceHelper

Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/-->using System;

using System.Collections.Generic;

using System.Web;

using System.Net;

using System.Web.Services.Description;

using System.Text;

using System.IO;

using System.CodeDom;

using Microsoft.CSharp;

using System.CodeDom.Compiler;

/// <summary>

///WebServiceHelper 的摘要说明

/// </summary>

public class WebServiceHelper

{

public WebServiceHelper()

{

//

//TODO: 在此处添加构造函数逻辑

//

}

#region InvokeWebService

//动态调用web服务

public static object InvokeWebService(string url, string methodname, object[] args)

{

return WebServiceHelper.InvokeWebService(url, null, methodname, args);

}

public static object InvokeWebService(string url, string classname, string methodname, object[] args)

{

string @namespace = "EnterpriseServerBase.WebService.DynamicWebCalling";

if ((classname == null) || (classname == ""))

{

classname = WebServiceHelper.GetWsClassName(url);

}

try

{

//获取WSDL

WebClient wc = new WebClient();

Stream stream = wc.OpenRead(url + "?WSDL");

ServiceDescription sd = ServiceDescription.Read(stream);

ServiceDescriptionImporter sdi = new ServiceDescriptionImporter();

sdi.AddServiceDescription(sd, "", "");

CodeNamespace cn = new CodeNamespace(@namespace);

//生成客户端代理类代码

CodeCompileUnit ccu = new CodeCompileUnit();

ccu.Namespaces.Add(cn);

sdi.Import(cn, ccu);

CSharpCodeProvider csc = new CSharpCodeProvider();

ICodeCompiler icc = csc.CreateCompiler();

//设定编译参数

CompilerParameters cplist = new CompilerParameters();

cplist.GenerateExecutable = false;

cplist.GenerateInMemory = true;

cplist.ReferencedAssemblies.Add("System.dll");

cplist.ReferencedAssemblies.Add("System.XML.dll");

cplist.ReferencedAssemblies.Add("System.Web.Services.dll");

cplist.ReferencedAssemblies.Add("System.Data.dll");

//编译代理类

CompilerResults cr = icc.CompileAssemblyFromDom(cplist, ccu);

if (true == cr.Errors.HasErrors)

{

System.Text.StringBuilder sb = new System.Text.StringBuilder();

foreach (System.CodeDom.Compiler.CompilerError ce in cr.Errors)

{

sb.Append(ce.ToString());

sb.Append(System.Environment.NewLine);

}

throw new Exception(sb.ToString());

}

//生成代理实例，并调用方法

System.Reflection.Assembly assembly = cr.CompiledAssembly;

Type t = assembly.GetType(@namespace + "." + classname, true, true);

object obj = Activator.CreateInstance(t);

System.Reflection.MethodInfo mi = t.GetMethod(methodname);

return mi.Invoke(obj, args);

}

catch (Exception ex)

{

throw new Exception(ex.InnerException.Message, new Exception(ex.InnerException.StackTrace));

}

}

private static string GetWsClassName(string wsUrl)

{

string[] parts = wsUrl.Split('/');

string[] pps = parts[parts.Length - 1].Split('.');

return pps[0];

}

#endregion

}

2.调用WebService时，传入参数为Entity[]（即实体集合等复杂对象），如何传入以及接收参数？

解决方案：第一步序列化对象

序列化对象

Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/-->#region 序列化在内存中

XmlSerializer xs = new XmlSerializer(typeof(Entity[]));

MemoryStream mstream = new MemoryStream();

XmlTextWriter writer = new XmlTextWriter(mstream, Encoding.Default);

xs.Serialize(mstream, en);

writer.Close();

string str = Encoding.UTF8.GetString(mstream.ToArray());

#endregion

#region 写入文件再读取出字符串

//FileStream fs = new FileStream("c:\\aaa.txt", FileMode.OpenOrCreate);

//xs = new XmlSerializer(typeof(Entity[]));

//xs.Serialize(fs, en);

//fs.Close();

//fs = new FileStream("c:\\aaa.txt", FileMode.Open, FileAccess.Read);

//StreamReader reader = new StreamReader(fs, Encoding.Default);

//str = reader.ReadToEnd();

//reader.Close();

//reader.Dispose();

//fs.Close();

//fs.Dispose();

#endregion

第二步：动态调用WebService

代码

Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/-->string url = "http://localhost:4494/SMWebService/WebService_S.asmx";

object[] args = new object[2];

args[0] = mapname;

args[1] = str;

object result = WebServiceHelper.InvokeWebService(url, "AddEntity", args);

第三步：WebService中的处理过程（反序列化）

代码

Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/-->[WebMethod]

public bool AddEntity(string mapname,string strentites)

{

Stream stream = new MemoryStream(ASCIIEncoding.Default.GetBytes(strentites));

XmlSerializer xml = new XmlSerializer(typeof(Entity[]));

Entity[] entities = (Entity[])xml.Deserialize(stream);

}

代码

 
[WebMethod]
    public bool AddEntity(string mapname,string strentites)
    {
Stream stream = new MemoryStream(ASCIIEncoding.Default.GetBytes(strentites));
         XmlSerializer xml = new XmlSerializer(typeof(Entity[]));
            Entity[] entities = (Entity[])xml.Deserialize(stream);
}