浅谈WebService开发（一）

一、什么是WebService：

简单通俗来说，就是企业之间、网站之间通过Internet来访问并使用在线服务，一些数据，由于安全性问题，不能提供数据库给其他单位使用，这时候可以使   用WebService服务提供。

二、创建WebService

 

创建WebService之后，我们就可以在文件里写返回数据的方法了。

三、返回数据的四种形式

笔者水平有限，只列出这四种数据的返回形式：

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

理论上来说，网络传输字节与传输时间，应该是递减的，其中，（3）（4）种方法需要引用微软提供的开源组件  下载地址：http://support.microsoft.com/kb/829740/zh-cn

下面展示这四种返回数据的代码，其中（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的效果，如图，在这个页面中，有提供四个方法，这四个方法就是上述我们写的四个返回数据的方法了，点击方法即可返回相应的数据，这样，我们数据提供方的代码就可以写好了，接下来，我们写调用数据的方法！

 

四、调用数据

客户端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;
            }
        }
    }

　　在上例中，调用四个方法的效果是一样的，唯一不同的是，传输过程中，数据量大小和传输时间的差异。

如果创建一个webservice和简单的调用，本文将注重webservice的效率调用问题，所以，我回说说如何实现同步与异步调用 webservice，如果说得哪里不对或者不好的地方，欢迎大家评论指导。
首先，什么是同步，什么是异步呢？打个比方来说，小明和小 华，互相打架，小明打了小华3下之后，小华才能打回小明，这叫同步，如果，小华勇敢点，在小明打了第一下开始做出反击，也打回小明，这叫异步。 也就是说，只能等待另外一个作业进行完才能进行下一个操作的叫同步，在另外一个作业进行的同时也进行其他操作，叫异步。

先创建一个webservice

using System;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
//若要允许使用 <a href="http://www.it165.net/pro/webasp/" target="_blank" class="keylink">ASP</a>.NET AJAX 从脚本中调用此 Web 服务，请取消对下行的注释。
// [System.Web.Script.Services.ScriptService]
public class GetWebService : System.Web.Services.WebService
{

    [WebMethod]
    public string HelloWorld()
    {
        int res = 0;
        for (long i = 0; i < 1000000000; i++)    //循环10亿次，目的是模仿大批量操作，这里至少需要数秒的操作以便看出异步的效果
        {
            res++;
        }
        return " Hello World";
    }

}

webservice创建好了，新建一个winform项目，引入webservice，我在引入webservice的时候，差点被坑爹了，原来。VS里是提供

Add Service References 和 Add Web References
这两种，其实就是年代遗留下来的问题。web引用是2.0版本的，而服务引用是3.5版本的，微软为了保持向前兼容的特性，也保留了这两种方法，分别可以看这里

添加web引用和添加服务引用有什么区别?Add Service References 和 Add Web References 有啥区别?

 

项目右键 添加服务引用，如果你用的是VS2008，菜单可能是添加web引用。

 

如果是本地做学习测试之用的，浏览器浏览你创建的webservice，得到URL，如果是使用网络上的webservice，这里则输入给予的URL地址，点击前往即可，

再看看左下角的高级按钮吗？点击高级吧！！

 

把生成异步操作（必须勾上，不然没有异步方法）勾上，生成消息合同也需勾上，看到左下角的添加WEB引用了吗？这就是基于.NET Framework2.0 的。点击确定即可完成引入webservice。

两种不同版本的引入webservice也将造成代码的不同，所以，为了说明这个问题，我们也把2.0的引入方法也说明一下。

 

2.0的引入方法更加简洁，如果你在看浪曦的webservice视频教程，肯定很熟悉这个界面。我个人也是比较喜欢这种方法的。

编写代码

localhost.GetWebService webservice = new localhost.GetWebService(); //通过2.0的添加WEB引用需要这种方式new出webservice对象      

    ServiceReference1.GetWebServiceSoapClient getWebService = new ServiceReference1.GetWebServiceSoapClient(); //通过添加服务引用需要这种方式new出webservice对象

    //同步调用webservice
     private void btnSyn_Click(object sender, EventArgs e)
     {
         string res = webservice.HelloWorld();
         this.textBox1.Text += "完成了";
         this.textBox1.Text += res + System.Environment.NewLine;
     }

     //异步调用webservice
     private void btnAsyn_Click(object sender, EventArgs e)
     {
         //给HelloWorld方法注册调用完成时执行的方法AsyncHelloWorldComplete
         webservice.HelloWorldCompleted += new localhost.HelloWorldCompletedEventHandler(AsyncHelloWorldComplete);
         //开始异步调用
         webservice.HelloWorldAsync();
         this.textBox1.Text += "完成了" + System.Environment.NewLine;
     }

     //完成webservice操作时会执行的方法
     void AsyncHelloWorldComplete(object sender, localhost.HelloWorldCompletedEventArgs e)
     {
         string res = e.Result;
         this.textBox1.Text += res + System.Environment.NewLine;
     }

　　

代码说明：

 

1、HelloWorld方法：同步直接调用webservice的方法，返回结果时输出“成功了”加上返回的结果；
2、webservice.HelloWorldAsync() ：开始异步调用webservice
3、HelloWorldCompleted是webservice为我们提供委托调用，意思是将操作完成时执行的操作给参数中的方法执行，本例给了AsyncHelloWorldComplete方法执行；

执行效果：运行本例程序，你会发现，同步调用方法中，“完成了”这句话会与执行结果“Hello World”一起输出，在webservice还没执行完成的时候，小华不会打小明；
而异步调用方法中，“完成了”这句话先是输出到文本框中，等了数秒之后，再显示“Hello World”。这就是同步与异步调用webservice的区别了

如果需要在WebForm中异步调用，需要在页面属性中设置可以异步：Async=”true”