学步园

最近需要研究研究网络编程，看了以前保存的soket资料，本来要用协议写的，突然发现Web Service了，这个东西好啊。internet不知道性能如何，但是像局域网这样网络性能比较好的场合使用，确实比较方便分布式开发。

先转个介绍信的文章。

现在Internet正在不断地发展着，在互联网应用刚开始的时候，我们浏览的网页只是静态的，不可交互的。而现在随着技术的日益发展，将提供给网页浏览者一个可编程的Web 站点。这些站点将在组织、应用、服务、驱动上更加紧密的结合在一起，这些站点将通过一些应用软件直接连接到另一个Web 站点，这些可编程的Web 站点相比传统的web站点来说，将变得更加能重复使用，也更加智能化！
.net平台给我们提供了一种运行环境，即公用语言运行环境（CLR，Common Language Runtime）。对 CLR来说，它提供了一种内置机制来创建一个可编程的站点，、对于Web 程序开发者和VB 程序员来说，这将是一致、熟悉的。这种模型是可以重复使用，也可以再扩展。 它包含了开放的Internet标准（HTTP, XML, SOAP, SDL）。以便它能被网页浏览者访问。

ASP.NET 使用.asmx 文件来对Web Services的支持。.asmx 文件和.aspx文件一样都属于文本文件。它包含在.aspx文件之中，成为ASP.NET应用程序的一部分。

下面我们将举一个简单的例子来介绍.asmx文件，我们还是从"Hello，World"这个经典的例子说起，代码如下：

<!-- 文件名：webservice/sisam.asmx -->
<%@ WebService Language="VB" %>
Imports System.Web.Services
Public Class HelloWorld :Inherits WebService
Public Function <WebMethod( )> SayHelloWorld( ) As String
Return("Hello World")
End Function
End Class

说明：
1．编码最开始必须进行WebService声明，从而定义这个文件为一个Web Service。而且，在同一行中设置好编程语言的类型。 

2．然后，引入名字空间System.Web.Services。注意，这个名字空间属于最基本的元素，必须要包含它。

3．接着，声明service中的功能模块，也就是类模块，这里的类名叫HelloWorld。这个类来源于基类WebService，而且应该是public类型。

4．最后，定义service的可访问方法。在表示方法的符号前面，要设置好自定义属性。对应于C#语言，属性值就是[WebMethod]；对应于VB，就是。如果没有设置这个属性，那么这个方法就不能从service中访问。一个局部应用可以使用任何的public类型的类，但是只有具备[WebMethod]的类才可以通过SOAP被远程地访问。

当对service的请求发生时，.asmx文件将自动地被ASP.NET运行环境所编译。随后的请求就可以由缓冲的预编译类型对象执行。

为了测试编写好的代码，我们需用一个支持ASP.NET的Web服务器。假设这个Web服务器的名称叫做server1，其上有一个虚拟目录test。请跟随下面步骤开始测试：
1．将代码保存为HelloWorld.asmx 
2．放到Web服务器Foo的虚拟目录Bar下 
3．打开Internet Explorer5，在地址栏输入http://server1/test/HelloWorld.asmx 
这时，我们将看到关于这个Web Service的公用方法－也就是那些标记为WebMethod属性的字符，并得知调用这些方法可以使用的协议，比如SOAP或者HTTP GET。
在Internet Explorer的地址栏中输入http://Foo/Bar/HelloWorld.asmx?SDL后，将产生基于服务描述语言（Service Description Language ：SDL）语法的具备相同信息的XML文件。这个SDL文件非常重要，客户端就是使用它来访问service。

我们来看一下程序运行的效果：

从客户端进行访问：
除了允许开发者使用的创建Web Services的技术以外，Microsoft的.NET框架给客户端提供了一套访问并使用Web Services的精致且高深的工具和代码。由于Web Services是基于如简单对象访问协议SOAP（Simple Object Access Protocol）和HTTP这样的开放协议标准的，从而，我们就可以使用这种客户端技术使用非ASP.NET的Web Services。当然，这也需用高水平地合成ASP.NET Web Services和这种客户端技术。
SDK中有一个工具叫做WebServiceUtil.exe，我们可以使用它来下载一个Web Services的SDL描述语言，并创建表达这个Service的代理类。比如，当我们输入以下命令，就可以创建一个叫做HelloWorld.cs的代理类：

WebServiceUtil /c:proxy /pa:http://someDomain.com/someFolder/HelloWorld.asmx?SDL

这个类看起来与前面创建的类非常相似。它包含一个方法SayHelloWorld，该方法返回一个字符串。将这个代理类编译到一个应用程序中，然后调用这个代理类的方法，结果就是：通过HTTP，这个代理类包装SOAP请求，然后接收SOAP编码响应，最后汇集成为一个字符串。

从客户端来看，代码是很简单的，返回的结果也很简单，就是一个字符串"Hello World"。同样为了对照方便，我们列出了使用VB、C#以及JScript三种语言编写的代码： 
C#
HelloWorld myHelloWorld = new HelloWorld();
String sReturn = myHelloWorld.SayHelloWorld();

VB
Dim myHelloWorld As New HelloWorld()
Dim sReturn As String = myHelloWorld.SayHelloWorld()

JScript
var myHelloWorld:HelloWorld = new HelloWorld();
var sReturn:String = myHelloWorld.SayHelloWorld();

通过上面的例程，你可能对Web Services有了初步的印象。下面，我们将介绍Web Services中涉及到的各种数据类型，也就是Web Services方法的输入/输出参数类型。因为Web Services的执行是建立在XML架构之上的，所以它能够支持丰富的数据类型。下表列出了使用SOAP协议时Web Services支持的数据类型：

当通过SOAP或者HTTP GET/POST调用Web Services时，返回值可以是上述提到的任何一种数据类型。
参数的数据类型
使用SOAP协议时，"通过值"以及"通过引用"这两种输入/输出参数形式都可被支持。如果是"通过引用"的参数类型，就会产生两种方式的数据发送效果：到服务器的以及返回到客户端的。但是，当通过HTTP GET/POST传递输入参数给Web Services时，就只支持有限的数据类型了，而且还必须是"通过值"形式的参数。这些类型如下：

现在我们将举一个例子，来说明上面我们介绍的数据类型：
这个例子利用WebServiceUtil.exe建立的SOAP代理来使用上面列出的数据类型。注意：因为在.asmx文件中定义了多于一个的公用类，所以，我们必须要指定哪一个作为WebService类，这可以通过设置WebService标识的Class属性来实现，代码如下： 

<%@ WebService Language="C#" %>

源文件webservice/datatype.asmx的内容如下：

<%@ WebService Language="VB" %>

Imports System
Imports System.Web.Services

Public Enum Mode

EOn = 1
EOff = 2

End Enum

Public Class Order

Public OrderID As Integer
Public Price As Double
End Class

Public Class DataTypes

'SayHello方法显示从service中返回的一个字符串信息。
Public Function <WebMethod()> SayHello() As String

Return "Hello World!"
End Function

'SayHelloName方法返回一个字符串，并接受一个字符串参数。
Public Function <WebMethod()> SayHelloName(Name As String) As String

Return "Hello" & Name
End Function

'GetIntArray方法显示了如何返回一个整数数组。
Public Function <WebMethod()> GetIntArray() As Integer()

Dim I As Integer
Dim A(5) As Integer
For I = 0 to 4
A(I) = I*10
Next
Return A
End Function

'GetMode方法返回一个枚举数值。
Public Function <WebMethod()> GetMode() As Mode

Return Mode.EOff
End Function

'GetOrder方法返回一个类。
Public Function <WebMethod()> GetOrder() As Order

Dim MyOrder As New Order

MyOrder.Price=34.5
MyOrder.OrderID = 323232

Return MyOrder
End Function

'GetOrders方法返回定单对象数组。
Public Function <WebMethod()> GetOrders() As Order()

Dim MyOrder(2) As Order

MyOrder(0) = New Order()
MyOrder(0).Price=34.5
MyOrder(0).OrderID = 323232
MyOrder(1) = New Order()
MyOrder(1).Price=99.4
MyOrder(1).OrderID = 645645

Return MyOrder
End Function

End Class

程序运行的效果如下：

当我们单击invoke的时候，将显示：

对于使用客户端应用程序而言，使用WebServiceUtil代理生成工具配置这些数据类型是透明的。请看关于Web Service的一个客户端例程：

客户端访问的文件：clint.aspx，内容如下：
<%@ Import Namespace="DataTypesService" %>

<html>
<style>
div 
{ 
font: 8pt verdana;
background-color:cccccc;
border-color:black;
border-width:1;
border-style:solid;
padding:10,10,10,10; 
}

</style>

<script language="VB" runat="server">

Public Sub Page_Load(Sender As Object, E As EventArgs)

Dim D As DataTypes = New DataTypes() 
Message1.InnerHtml = D.SayHello()
Message1.InnerHtml = Message1.InnerHtml & D.SayHelloName("Bob")
Message3.InnerHtml = Message3.InnerHtml & D.GetMode()

Dim MyIntArray As Integer() = D.GetIntArray()
Dim MyString As String = "Contents of the Array:<BR>"

For I = 0 To MyIntArray.Length - 1
MyString = MyString & MyIntArray(I) & "<BR>"
Next

Message2.InnerHtml = Message2.InnerHtml & MyString

Dim MyOrder As Order = D.GetOrder()
Message4.InnerHtml = Message4.InnerHtml & "<BR>OrderID: " & MyOrder.OrderID
Message4.InnerHtml = Message4.InnerHtml & "<BR>Price: " & MyOrder.Price

Dim MyOrders As Order() = D.GetOrders()
Message5.InnerHtml = Message5.InnerHtml & "<BR>OrderID: " & MyOrders(0).OrderID
Message5.InnerHtml = Message5.InnerHtml & "<BR>Price: " & MyOrders(0).Price

End Sub

</script>

<body style="font: 10pt verdana">
<H4>Using DataTypes with Web Services</H4>

<h5>Methods that return a Primitive (String): </h5>
<div id="Message1" runat="server"/>

<h5>Methods that return an Array of Primitives (Integers): </h5>
<div id="Message2" runat="server"/>

<h5>Method that returns an Enum: </h5>
<div id="Message3" runat="server"/>

<h5>Method that returns a Class/Struct: </h5>
<div id="Message4" runat="server"/>

<h5>Method that returns an array of Classes/Structs: </h5>
<div id="Message5" runat="server"/>

</body>
</html>

在客户端程序中，我们使用<%@ Import Namespace="DataTypesService" %>来引入DataTypesService这个我们自定义的名字空间。然后在程序中只是调用了DataTypesService中的方法。

现在我们来看如何生成名字空间：
1． Datatype.vb中的内容：

Imports System.Xml.Serialization
Imports System.Web.Services.Protocols
Imports System.Web.Services

Namespace DataTypesService
Public Class DataType
Inherits System.Web.Services.Protocols.SoapClientProtocol
Public Sub New()
MyBase.New Me.Url="http://localhost/QuickStart/aspplus/samples/services/DataTypes/VB/DataTypes.asmx" End Sub

Public Function 
<System.Web.Services.Protocols.SoapMethodAttribute("http://tempuri.org/SayHello")> SayHello() As String
Dim results() As Object = Me.Invoke("SayHello", New Object(0) {})
Return CType(results(0),String)
End Function
Public Function BeginSayHello(ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("SayHello", New Object(0) {}, callback, asyncState)
End Function
Public Function EndSayHello(ByVal asyncResult As System.IAsyncResult) As String
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),String)
End Function
Public Function <System.Web.Services.Protocols.SoapMethodAttribute("http://tempuri.org/SayHelloName")> SayHelloName(ByVal <System.Xml.Serialization.XmlElementAttribute("Name", IsNullable:=true)> name As String) As String
Dim results() As Object = Me.Invoke("SayHelloName", New Object() {name})
Return CType(results(0),String)
End Function
Public Function BeginSayHelloName(ByVal name As String, ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("SayHelloName", New Object() {name}, callback, asyncState)
End Function
Public Function EndSayHelloName(ByVal asyncResult As System.IAsyncResult) As String
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),String)
End Function
Public Function <System.Web.Services.Protocols.SoapMethodAttribute("http://tempuri.org/GetIntArray"), _
System.Xml.Serialization.XmlArrayAttribute(IsNullable:=true, ArrayType:=System.Xml.Serialization.XmlArrayType.Soap), _
System.Xml.Serialization.XmlArrayItemAttribute("int", IsNullable:=false)> GetIntArray() As Integer()
Dim results() As Object = Me.Invoke("GetIntArray", New Object(0) {})
Return CType(results(0),Integer())
End Function
Public Function BeginGetIntArray(ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("GetIntArray", New Object(0) {}, callback, asyncState)
End Function
Public Function EndGetIntArray(ByVal asyncResult As System.IAsyncResult) As Integer()
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),Integer())
End Function
Public Function <System.Web.Services.Protocols.SoapMethodAttribute("http://tempuri.org/GetMode")> GetMode() As Mode
Dim results() As Object = Me.Invoke("GetMode", New Object(0) {})
Return CType(results(0),Mode)
End Function
Public Function BeginGetMode(ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("GetMode", New Object(0) {}, callback, asyncState)
End Function
Public Function EndGetMode(ByVal asyncResult As System.IAsyncResult) As Mode
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),Mode)
End Function
Public Function <System.Web.Services.Protocols.SoapMethodAttribute("http://tempuri.org/GetOrder")> GetOrder() As Order
Dim results() As Object = Me.Invoke("GetOrder", New Object(0) {})
Return CType(results(0),Order)
End Function
Public Function BeginGetOrder(ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("GetOrder", New Object(0) {}, callback, asyncState)
End Function
Public Function EndGetOrder(ByVal asyncResult As System.IAsyncResult) As Order
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),Order)
End Function
Public Function <System.Web.Services.Protocols.SoapMethodAttribute("http://tempuri.org/GetOrders"), _
System.Xml.Serialization.XmlArrayAttribute(IsNullable:=true, ArrayType:=System.Xml.Serialization.XmlArrayType.Soap), _
System.Xml.Serialization.XmlArrayItemAttribute("Order", IsNullable:=true)> GetOrders() As Order()
Dim results() As Object = Me.Invoke("GetOrders", New Object(0) {})
Return CType(results(0),Order())
End Function
Public Function BeginGetOrders(ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("GetOrders", New Object(0) {}, callback, asyncState)
End Function
Public Function EndGetOrders(ByVal asyncResult As System.IAsyncResult) As Order()
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),Order())
End Function

End Class
Public Enum <System.Xml.Serialization.XmlRootAttribute("result", [Namespace]:="http://tempuri.org/", IsNullable:=false)> Mode

EOn
EOff

End Enum
Public Class <System.Xml.Serialization.XmlRootAttribute("result", [Namespace]:="http://tempuri.org/", IsNullable:=true)> Order

Public OrderID As Integer
Public Price As Double

End Class
End Namespace

在这个vb文件中，我们定义了一个名字空间DataTypesService。
请看vb文件的其中一段代码段：
Public Function <System.Web.Services.Protocols.SoapMeth_&
odAttribute("http://tempuri.org/SayHello")> SayHello() As String
Dim results() As Object = Me.Invoke("SayHello", New Object(0) {})
Return CType(results(0),String)
End Function

Public Function BeginSayHello(ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
Return Me.BeginInvoke("SayHello", New Object(0) {}, callback, asyncState) End Function

Public Function EndSayHello(ByVal asyncResult As System.IAsyncResult) As String
Dim results() As Object = Me.EndInvoke(asyncResult)
Return CType(results(0),String)
End Function
上面的代码，是触发invoke的单击事件。然后，调用我们在datatype.asmx中定义的方法。

要生成上面的名字空间，我们使用webserviceutil.exe来编译。

webserviceutil -c:proxy /pa:DataTypes.sdl /l:VB /n:DataTypesService

5.1.1 小结
web service提供了在不同体系机构下构建的网站之间相互提供应用接口服务、数据的一种方案。它采用通用的SOAP、HTTP以及XML，就可以把原本互不相干的站点服务形成一整套分布的、自动化和智能化的网络应用，大大减轻了程序员的开发工作量，充分地利用了已经拥有的网络资源和开发资源。在asp.net中，web service文件后缀名采用.asmx，开始应使用<%@ WebService …%>申明，接着引用System.Web.Services命名空间，然后定义一个公用类继承自WebService基类，最后实现自己的类，其中向网络开放的功能，应在其方法前面加上WebMethod属性。

原帖：http://www.bych.cn/HTML/2007-03/5163.HTML