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作为根本，然后来做各种转换压缩的操作：

1

1
[WebMethod(Description = "直接返回DataSet对象")] 

2
     public DataSet GetDataSet() 

3
     { 

4
         string connStr = System.Configuration.ConfigurationManager.ConnectionStrings["conn"].ToString(); 

5
         SqlConnection conn = new SqlConnection(connStr); 

6
         string sql = "select * from china_city"; 

7
         conn.Open(); 

8
         SqlDataAdapter sda = new SqlDataAdapter(sql, conn); 

9
         DataSet ds = new DataSet("China"); 

10
         sda.Fill(ds); 

11
         conn.Close(); 

12
         return ds; 

13
     }   

14
  
15
     [WebMethod(Description = "直接返回DataSet对象，并用Binary序列化后的字节数组")] 

16
     public byte[] GetDataSetBytes() 

17
     { 

18
         DataSet ds = GetDataSet(); 

19
         BinaryFormatter ser = new BinaryFormatter();  //序列化对象 

20
         MemoryStream ms = new MemoryStream();  //内存流 

21
         ser.Serialize(ms, ds); 

22
         byte[] buffer = ms.ToArray();    //字节流 

23
         return buffer; 

24
     }   

25
  
26
     [WebMethod(Description = "直接返回DataSetSurrogate对象，并用Binary序列化后的字节数组")] 

27
     public byte[] GetDataSetSurrogateBytes() 

28
     { 

29
         DataSet ds = GetDataSet(); 

30
         DataSetSurrogate dss = new DataSetSurrogate(ds); 

31
         BinaryFormatter ser = new BinaryFormatter();  //序列化对象 

32
         MemoryStream ms = new MemoryStream();  //内存流 

33
         ser.Serialize(ms, dss); 

34
         byte[] buffer = ms.ToArray();    //字节流 

35
         return buffer;   

36
  
37
     }   

38
  
39
     [WebMethod(Description = "直接返回DataSetSurrogate对象，并用Binary序列化后并且ZIP压缩的字节数组")] 

40
     public byte[] GetDataSetSurrogateZipBytes() 

41
     { 

42
         DataSet ds = GetDataSet(); 

43
         DataSetSurrogate dss = new DataSetSurrogate(ds); 

44
         BinaryFormatter ser = new BinaryFormatter();  //序列化对象 

45
         MemoryStream ms = new MemoryStream();  //内存流 

46
         ser.Serialize(ms, dss); 

47
         byte[] buffer = ms.ToArray();    //字节流 

48
         byte[] bufferZip = ComPress(buffer); 

49
         return buffer; 

50
     } 

51
     //压缩方法 

52
     public byte[] ComPress(byte[] data) 

53
     { 

54
         try

55
         { 

56
             MemoryStream ms = new MemoryStream(); 

57
             Stream zipStream = null; 

58
             zipStream = new GZipStream(ms, CompressionMode.Compress, true); 

59
             zipStream.Write(data, 0, data.Length); 

60
             zipStream.Close(); 

61
             ms.Position = 0; 

62
             byte[] compressed_data = new byte[ms.Length]; 

63
             ms.Read(compressed_data, 0, int.Parse(ms.Length.ToString())); 

64
             return compressed_data; 

65
         } 

66
         catch

67
         { 

68
             return null; 

69
         } 

70
     }

我们可以在浏览器中查看下WebService的效果，如图，在这个页面中，有提供四个方法，这四个方法就是上述我们写的四个返回数据的方法了，点击方法即可返回相应的数据，这样，我们数据提供方的代码就可以写好了，接下来，我们写调用数据的方法！

四、调用数据

客户端WebService程序

1
private void button1_Click(object sender, EventArgs e) 

2
    { 

3
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1();  //new出WebService对象 

4
        DateTime dtBegin = DateTime.Now; 

5
        DataSet dataSet = ds.GetNorthwindDataSet(); 

6
        this.label1.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin); 

7
        binddata(dataSet); 

8
    } 

9
    private void button2_Click(object sender, EventArgs e) 

10
    { 

11
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1(); 

12
        DateTime dtBegin = DateTime.Now; 

13
        byte[] buffer = ds.GetDataSetBytes(); 

14
        BinaryFormatter ser = new BinaryFormatter(); 

15
        DataSet dataSet = ser.Deserialize(new MemoryStream(buffer)) as DataSet; 

16
        this.label2.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin) + "  " + buffer.Length; 

17
        binddata(dataSet); 

18
    } 

19
    private void button3_Click(object sender, EventArgs e) 

20
    { 

21
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1(); 

22
        DateTime dtBegin = DateTime.Now; 

23
        byte[] buffer = ds.GetDataSetSurrogateBytes(); 

24
        BinaryFormatter ser = new BinaryFormatter(); 

25
        DataSetSurrogate dss = ser.Deserialize(new MemoryStream(buffer)) as DataSetSurrogate; 

26
        DataSet dataSet = dss.ConvertToDataSet(); 

27
        this.label3.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin) + "  " + buffer.Length; 

28
        binddata(dataSet); 

29
    } 

30
    private void button4_Click(object sender, EventArgs e) 

31
    { 

32
        com.dzbsoft.www.Service1 ds = new com.dzbsoft.www.Service1(); 

33
        DateTime dtBegin = DateTime.Now; 

34
        byte[] zipBuffer = ds.GetDataSetSurrogateZipBytes(); 

35
        byte[] buffer = UnZipClass.Decompress(zipBuffer); 

36
        BinaryFormatter ser = new BinaryFormatter(); 

37
        DataSetSurrogate dss = ser.Deserialize(new MemoryStream(buffer)) as DataSetSurrogate; 

38
        DataSet dataSet = dss.ConvertToDataSet(); 

39
        this.label4.Text = string.Format("耗时：{0}", DateTime.Now - dtBegin) + "  " + zipBuffer.Length; 

40
        binddata(dataSet); 

41
    } 

42
    private void binddata(DataSet dataSet) 

43
    { 

44
        this.dataGridView1.DataSource = dataSet.Tables[0]; 

45
        this.label5.Text = "共计：" + dataSet.Tables[0].Rows.Count + "条记录"; 

46
    }

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

1
客户端UnZipClass程序 

2
    public static class UnZipClass 

3
    { 

4
        public static byte[] Decompress(byte[] data) 

5
        { 

6
            try

7
            { 

8
                MemoryStream ms = new MemoryStream(data); 

9
                Stream zipStream = null; 

10
                zipStream = new GZipStream(ms, CompressionMode.Decompress); 

11
                byte[] dc_data = null; 

12
                dc_data = ExtractBytesFromStream(zipStream, data.Length); 

13
                return dc_data; 

14
            } 

15
            catch

16
            { 

17
                return null; 

18
            } 

19
        } 

20
        public static byte[] ExtractBytesFromStream(Stream zipStream, int dataBlock) 

21
        { 

22
            byte[] data = null; 

23
            int totalBytesRead = 0; 

24
            try

25
            { 

26
                while (true) 

27
                { 

28
                    Array.Resize(ref data, totalBytesRead + dataBlock + 1); 

29
                    int bytesRead = zipStream.Read(data, totalBytesRead, dataBlock); 

30
                    if (bytesRead == 0) 

31
                    { 

32
                        break; 

33
                    } 

34
                    totalBytesRead += bytesRead; 

35
                } 

36
                Array.Resize(ref data, totalBytesRead); 

37
                return data; 

38
            } 

39
            catch

40
            { 

41
                return null; 

42
            } 

43
        } 

44
    }

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

============2=============

效率调用问题，所以，我回说说如何实现同步与异步调用 webservice，如果说得哪里不对或者不好的地方，欢迎大家评论指导。

首先，什么是同步，什么是异步呢？打个比方来说，小明和小华，互相打架，小明打了小华3下之后，小华才能打回小明，这叫同步，如果，小华勇敢点，在小明打了第一下开始做出反击，也打回小明，这叫异步。也就是说，只能等待另外一个作业进行完才能进行下一个操作的叫同步，在另外一个作业进行的同时也进行其他操作，叫异步。

先创建一个webservice

1
using System; 

2
using System.Web; 

3
using System.Web.Services; 

4
using System.Web.Services.Protocols; 

5
  
6
[WebService(Namespace = "http://tempuri.org/")] 

7
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] 

8
//若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务，请取消对下行的注释。 

9
// [System.Web.Script.Services.ScriptService] 

10
public class GetWebService : System.Web.Services.WebService 

11
{ 

12
  
13
    [WebMethod] 

14
    public string HelloWorld() 

15
    { 

16
        int res = 0; 

17
        for (long i = 0; i < 1000000000; i++)    //循环10亿次，目的是模仿大批量操作，这里至少需要数秒的操作以便看出异步的效果 

18
        { 

19
            res++; 

20
        } 

21
        return " Hello World"; 

22
    } 

23
  
24
}

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视频教程，肯定很熟悉这个界面。我个人也是比较喜欢这种方法的。

编写代码

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

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

4
 
5
    //同步调用webservice 

6
     private void btnSyn_Click(object sender, EventArgs e) 

7
     { 

8
         string res = webservice.HelloWorld(); 

9
         this.textBox1.Text += "完成了"; 

10
         this.textBox1.Text += res + System.Environment.NewLine; 

11
     } 

12
 
13
     //异步调用webservice 

14
     private void btnAsyn_Click(object sender, EventArgs e) 

15
     { 

16
         //给HelloWorld方法注册调用完成时执行的方法AsyncHelloWorldComplete 

17
         webservice.HelloWorldCompleted += new localhost.HelloWorldCompletedEventHandler(AsyncHelloWorldComplete); 

18
         //开始异步调用 

19
         webservice.HelloWorldAsync(); 

20
         this.textBox1.Text += "完成了" + System.Environment.NewLine; 

21
     } 

22
 
23
     //完成webservice操作时会执行的方法 

24
     void AsyncHelloWorldComplete(object sender, localhost.HelloWorldCompletedEventArgs e) 

25
     { 

26
         string res = e.Result; 

27
         this.textBox1.Text += res + System.Environment.NewLine; 

28
     }

代码说明：

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

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

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

============================3======================

在前两讲里，我已经向大家演示了如何使用WebService、同步，异步调用WebService，而在实际开发过程中，可能会有多个WebService接口供你选择，而在程序执行过程中才决定使用哪一个 WebService的情况，而以前的情况往往是添加指定的web引用调用WebService，而这一讲中，会讲述动态调用WebService，也就是知道WebService的地址而不用使用添加引用的方法来调用WebService。

浅谈WebService开发（一）

浅谈WebService开发二（同步与异步调用）

首先贴出整个架构的示意图（图片来自浪曦），其中ServiceHelper类包括下面所示的五个步骤。

首先实现ServiceHelper类，代码如下：

1
using System.Collections.Generic; 

2
using System.Linq; 

3
using System.Text; 

4
  
5
using System.IO; 

6
using System.Configuration; 

7
using System.CodeDom; 

8
using System.CodeDom.Compiler; 

9
using System.Net; 

10
using System.Web.Services; 

11
using System.Web.Services.Description; 

12
using Microsoft.CSharp; 

13
  
14
namespace InvokeWebService 

15
{ 

16
    public static class WebServiceHelper 

17
    { 

18
        /// <summary> 

19
        /// 动态调用WebService 

20
        /// </summary> 

21
        /// <param name="url">WebService地址</param> 

22
        /// <param name="methodname">WebService方法名</param> 

23
        /// <param name="args">参数列表</param> 

24
        /// <returns>返回object</returns> 

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

26
        { 

27
            return InvokeWebService(url, null, methodname, args); 

28
        } 

29
        /// <summary> 

30
        /// 动态调用WebService 

31
        /// </summary> 

32
        /// <param name="url">WebService地址</param> 

33
        /// <param name="classname">类名</param> 

34
        /// <param name="methodname">WebService方法名</param> 

35
        /// <param name="args">参数列表</param> 

36
        /// <returns>返回object</returns> 

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

38
        { 

39
            string @namespace = "ServiceBase.WebService.DynamicWebLoad"; 

40
            if (string.IsNullOrEmpty(classname)) 

41
            { 

42
                classname = WebServiceHelper.GetClassName(url); 

43
            } 

44
            //获取服务描述语言(WSDL) 

45
            WebClient wc = new WebClient(); 

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

47
            ServiceDescription sd = ServiceDescription.Read(stream); 

48
            ServiceDescriptionImporter sdi = new ServiceDescriptionImporter(); 

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

50
            CodeNamespace cn = new CodeNamespace(@namespace); 

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

52
            CodeCompileUnit ccu = new CodeCompileUnit(); 

53
            ccu.Namespaces.Add(cn); 

54
            sdi.Import(cn, ccu); 

55
            CSharpCodeProvider csc = new CSharpCodeProvider(); 

56
            ICodeCompiler icc = csc.CreateCompiler(); 

57
            //设定编译器的参数 

58
            CompilerParameters cplist = new CompilerParameters(); 

59
            cplist.GenerateExecutable = false; 

60
            cplist.GenerateInMemory = true; 

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

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

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

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

65
            //编译代理类 

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

67
            if (true == cr.Errors.HasErrors) 

68
            { 

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

70
                foreach (CompilerError ce in cr.Errors) 

71
                { 

72
                    sb.Append(ce.ToString() + System.Environment.NewLine); 

73
                } 

74
                throw new Exception(sb.ToString()); 

75
            } 

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

77
            System.Reflection.Assembly assembly = cr.CompiledAssembly; 

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

79
            object obj = Activator.CreateInstance(t); 

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

81
            return mi.Invoke(obj, args); 

82
        } 

83
  
84
        /// <summary> 

85
        /// 得到URL中的WebService名称 

86
        /// </summary> 

87
        /// <param name="url">URL地址</param> 

88
        /// <returns>如http://wwww.baidu.com/service.asmx 则返回service</returns> 

89
        private static string GetClassName(string url) 

90
        { 

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

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

93
            return pps[0]; 

94
        } 

95
    } 

96
}

然后，我们可以新建1个WebService，看看是如何动态调用的：

1
private void button1_Click(object sender, EventArgs e) 

2
{ 

3
       string url = "http://localhost:2697/Service1.asmx"; //用于做测试的WebService 

4
       object b = InvokeWebService.WebServiceHelper.InvokeWebService(url, "HelloWorld", null); 

5
       MessageBox.Show(b.ToString()); 

6
 }

现在，整个项目中，没有像以往一样使用添加web引用来调用WebService，而是把WebService的调用地址，写在程序里面，结合业务逻辑可以动态调用wbeservice

ps：项目我是按着浪曦然后自己写的，WebServiceHelper类里面有些地方还不是很清楚，这里留下一份代码以作记录。