2002-09-16 11:40
.NET中的Web service的开发
.NET平台内建了对Web service的支持,包括Web service的构建和使用。
与其它开发平台不同,使用.NET平台,你不需要其他的工具或者SDK就可以完成Web service的开发了。.NET Framework本身就全面支持Web
service,包括服务器端的请求处理器和对客户端发送和接受SOAP消息的支持。本节将带你用.NET创建和使用一个简单的Web
service。
要在.NET中创建Web
service,你只需建立一个.asmx文件。这个文件中有一个WebService标签,包含Language和class两个属性,分别用于指定编程语言和Web
service中暴露出的类。然后你就可以像平常一样编写你的类了。最后,在每个你想要暴露出的方法前面加一个System.Web.Services.WebMethodAttribute属性就可以了。最终代码类似于下面的程序清单。
'a
WebService in VB.NET (calc_vb.asmx)
<%@WebService Language="VB"class="Calc"
%>
Imports System.Web.Services
Public Class Calc
<WebMethod()>
_
Public Function Add(ByVal a As Double, _
ByVal b As Double) As
Double
Return a + b
End Function
End Class
用浏览器来浏览这个.asmx文件,你可以得到一张测试这个Web service的页面。例如,你把calc_vb.asmx
文件放到了Web服务器的myService目录下,那么相应的URL就是:
http://localhost/myService/calc_vb.asmx
测试页如下图所示。这一页是自动生成的。它显示了Web
service 的名字并列出了可以调用的方法。列表后面有一段文字,意思是你正在使用缺省的命名空间http://tempuri.org/,如果你想要发布这个Web
service的话,最好换一个你自己的命名空间,以避免名字上的冲突。本书后面的部分将会讨论Web service
命名空间的问题。在第六章中,我还会介绍怎样使用.NET的属性来指定命名空间和其他一些东西。
自动生成的Web service测试页
在测试页里点击Add方法,你会得到一个HTML表单,用来测试这个方法(见下图)。在这个表单里,Add方法所接受的所有参数都有一个相应的文本框。填好所有的参数,点击"Invoke"按钮,这个表单就会被提交到Web服务器。实际上,这就是通过HTTP
GET的形式在调用Web service。得到的结果是一个如下的简单XML文档:
<double xmlns="http://tempuri.org/">158</double>
浏览下面这个URL,可以直接调用Add方法:
http://localhost/myService/calc_vb.asmx/Add?a=123&b=35
如你所见,方法的名字是你所请求的资源(注意,这里是区分大小写的),而函数中的每个参数都映射为查询字符串中的一个参数。这种形式对快速测试一个Web
service 是非常方便的。不过,因为这种方式使用的是HTTP
GET,所以它在数据类型和参数传递方向等方面都有一些局限。我们将在第六章中详细讨论这些局限。
自动生成的Add方法测试页
回到前面的Web service测试页,我们还可以看到页面的顶部有一个Service Description链接。点击过去你就可以得到描述这个Web
service的WSDL文档,如下图。在Web service的URL后面加上一个"WSDL"查询字符串,你也可以直接浏览到这一页:
http://localhost/myService/calc_vb.asmx?wsdl
Calc Web service的WSDL文档。注意,为了显示更多内容,所有的XML元素都已折叠起来。
Calc Web
service的WSDL文档。注意,为了显示更多内容,所有的XML元素都已折叠起来。
要在.NET中调用一个Web service
,你需要先运行wsdl.exe工具。这个工具会从Web service中读出它的WSDL描述文档,生成一个可以调用这个Web
service的代理类。例如,在命令行中执行下面的命令,可以生成Calc Web service的代理类:
wsdl.exe
/language:VB http://localhost/myService/calc_vb.asmx?wsdl
程序清单1-2截取自生成的VB代理类源码。这个代理类继承自System.Web.Services.Protocols.SoapHttpClientProtocol类,并且暴露出一个Add方法,这个方法接收两个double型浮点数,返回一个double型浮点数。
程序清单1
2 截取自wsdl.exe 生成的Web service代理类源代码
Imports
System.Web.Services.Protocols
'省略其他代码
Public Class Calc
Inherits
SoapHttpClientProtocol
'省略其他代码
<System.Diagnostics.DebuggerStepThroughAttribute(),_
SoapDocumentMethodAttribute(
_
"http://tempuri.org/Add",
_
Use:=System.Web.Services.Description.SoapBindingUse.Literal,_
ParameterStyle:=
SoapParameterStyle.Wrapped)>_
Public Function Add(ByVal a As Double,
ByValb As Double) As Double
Dim results() As Object =
Me.Invoke("Add",_
New Object() {a, b})
Return CType(results(0),
Double)
End Function
'省略其他代码
End Class
此后的工作就非常简单了。要调用CalculatorWeb
service,只需实例化一个Calc的代理对象,再调用它的Add方法:
Dim ws As New Calc()
Dim result As
Double = ws.Add(20.5, 10.9)
MessageBox.Show("结果是:" &result.ToString)
实际上,代理类中的Add方法仅仅是通过.NET Framework的SoapHttpClientProtocol类来调用Web
service,然后再把Web service 的返回值返回给调用者。
当然,除了上面的这些演示之外,.NET Web
service的创建和调用还有很多的内容。不过,在深入这些细节之前,我们需要先理解Webservice里面的几个关键技术:XSD、SOAP和WSDL。