.asmx處理程序提供的功能之自動(dòng)生成WSDL
自動(dòng)生成WSDL
在您寫好并部署了 WebMethod 之后,客戶端需要明確知道為了與它成功通訊而必須使 SOAP 消息具有什么樣的外觀。提供 Web 服務(wù)說(shuō)明的標(biāo)準(zhǔn)方法是通過(guò) WSDL(以及嵌入的 XSD 定義)進(jìn)行的。為了幫助適應(yīng)這種情況,.asmx 處理程序自動(dòng)生成可讀的文檔頁(yè),以及能準(zhǔn)確反映 WebMethod 接口的 WSDL 定義。如果您對(duì) WebMethod 應(yīng)用了許多映射屬性,則它們都會(huì)反映在生成的文檔中。
如果您瀏覽 .asmx 文件,將會(huì)看到一個(gè)如圖 2 所示的可供人工讀取的文檔頁(yè)。此文檔頁(yè)是由一個(gè)名為 DefaultWsdlHelpGenerator.aspx(位于 C:\windows\Microsoft.NET\Framework\ v1.0.3705\config)的 .aspx 頁(yè)生成的。如果您打開這個(gè)文件,將會(huì)發(fā)現(xiàn)這僅僅是一個(gè)標(biāo)準(zhǔn)的 ASP.NET 頁(yè),該頁(yè)使用 .NET 反射生成文檔。此功能允許您的文檔總是與代碼保持同步。您只需修改此文件即可自定義所生成的文檔。
還可以通過(guò)在 Web.config 文件中指定一個(gè)不同的文檔文件來(lái)避免在虛擬目錄中生成文檔:
- < configuration>
- < system.web>
- < webServices>
- < wsdlHelpGenerator href="MyDocumentation.aspx"/>
- < /webServices>
- ...
如果客戶端對(duì) .asmx 終結(jié)點(diǎn)發(fā)出 GET 請(qǐng)求,而且查詢字符串中有 “?wsdl”,那么,.asmx 處理程序會(huì)生成 WSDL 定義,而不生成可供人工讀取的文檔。客戶端可以使用 WSDL 定義來(lái)生成代理類,這些類可自動(dòng)了解如何與 Web 服務(wù)通訊(例如,使用 .NET 中的 Wsdl.exe)。
自動(dòng)生成WSDL:自定義過(guò)程
要自定義 WSDL 生成過(guò)程,可以編寫一個(gè) SoapExtensionReflector 類,并在 Web.config 文件中向 WebMethod 框架注冊(cè)該類。然后,當(dāng) .asmx 處理程序生成 WSDL 定義時(shí),它將調(diào)用反射器類,并使您有機(jī)會(huì)自定義向客戶端提供的最終定義。有關(guān)如何編寫 SoapExtensionReflector 類的更多信息,請(qǐng)查看 SoapExtensionReflectors in ASP.NET Web Services。
您還可以使用兩種不同的方法來(lái)完全跳過(guò) WSDL 生成過(guò)程。***種方法是,在虛擬目錄中提供一個(gè)可供客戶端訪問(wèn)的靜態(tài) WSDL 文檔,然后通過(guò)將文檔生成器從 Web.config 文件中刪除來(lái)禁用它,如下所示:
- < configuration>
- < system.web>
- < webServices>
- < protocols>
- < remove name="Documentation"/>
- < /protocols>
- ...
另一種自動(dòng)化程度較之稍高的方法是,使用 [WebServicesBinding] 屬性來(lái)指定由 WebMethod 類實(shí)現(xiàn)的靜態(tài) WSDL 文檔在虛擬目錄中的位置。您還必須使用 [SoapDocumentMethod] 屬性為每個(gè) WebMethod 實(shí)現(xiàn)的 WSDL 綁定指定名稱。這樣做之后,WSDL自動(dòng)生成過(guò)程將導(dǎo)入靜態(tài) WSDL 文件,并在它周圍包裝一個(gè)新的服務(wù)說(shuō)明。
目前,因?yàn)槿詻]有太多可用的 WSDL 編輯器,所以手工編寫 WSDL 是極其困難的。因此,文檔/WSDL 的自動(dòng)生成是 WebMethod 框架中很有價(jià)值的一部分,沒有它,許多開發(fā)人員的日子會(huì)很難過(guò)。
【編輯推薦】