去年幫客戶和某超商作欠費的即時查詢及代收的整合,剛開始試寫了幾種方法,但是超商都說我回的Message他們驗證不過吃不進去,最後是超商提供的一個C#範例程式,我拿來改成VB.Net,所以當時有一些Attribute的語法被不明就裡的拿來套用,剛好最近兩天有空就拿來研究,終於都搞通了,以下就是這兩天的研究成果
以VS2005開發Web Service來傳遞自訂物件時,如下例
Public Class Service1
Inherits System.Web.Services.WebService
<WebMethod()> _
Public Function Operation(ByVal obj As MyObj) As MyObj
.....
End Function
End Class
Public Class MyObj
.....
End Class
預設Request和Response的SOAP Message會長的像這樣:
=======Request=======
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope ...>
<soap:Body>
<obj>
....
</obj>
</soap:Body>
</soap:Envelope>
=======Response=======
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope ...>
<soap:Body>
<OperationResult>
....
</OperationResult>
</soap:Body>
</soap:Envelope>
但超商希望的是無論在Request和Response的訊息都是在SOAP BODY內包一個<OLTP>...</OLTP>就好,長的像這樣:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope ...>
<soap:Body>
<OLTP>
....
</OLTP>
</soap:Body>
</soap:Envelope>
要怎麼作呢?
要修改Request時的Message容易!
Public Class Service1
Inherits System.Web.Services.WebService
<WebMethod()> _
Public Function Operation(ByVal objOLTP As MyObj) As MyObj
.....
End Function
End Class
要改Response時的Message就要在我們的自訂物件上多加一些Attribute的東西
Imports System.Xml.Serialization
<XmlRootAttribute(ElementName:="OLTP")> _
Public Class MyObj
.....
End Class
不過這樣(加上Attribute)改過之後,如果您是在VS2005直接用加入Web參考的方式,去呼叫這個Web Service會發現收不到傳回值,而且您的測試專案可能就會有一個運算式沒有產生值的錯誤訊息,去看Reference.vb(在專案的.\Web References\Web參考資料夾名稱下)會發現您呼叫的是一個Sub而不是Function,當然您可以直接修改這隻程式,不過我強烈建議絶對不要這樣作,因為那一天您不小心去更新Web參考時就毀了,VS2005會重新產生這個檔案,您所作的修改就不見了。所以我建議如果會有要自己修改Reference.vb這個檔案的人,請照這樣作!
- 先移去剛剛加的<XmlRootAttribute(ElementName:="OLTP")> _,存檔並重新建置(重建一定要作,不然後面就白作了)
- 先開啟VS2005命令提示字元
- 輸入 WSDL /l:VB http://伺服器IP/WebService名稱.asmx
- 在現行資料夾下會產生一個 WebService名稱.vb 的檔案
- 將這個.vb的檔案複製到測試專案資料夾下並加入到測試專案中
- 修改測試專案程式碼,將原本程式碼中的 Web參考資料夾名稱.ServiceName 改成 ServiceName,Web參考資料夾名稱.MyObj 改成 MyObj
- 作到這裡,看起來已經沒有錯誤訊息了,但是實際執行時,您會發現雖然是Function但傳回值卻永遠是Nothing,那是因為VS2005只會去讀SOAP BODY內的<XXXXResult>...</XXXXResult>內容當作傳回值(XXXX就是您WebMethod的Function名稱)
- 打開 WebService名稱.vb ,修改Function宣告式的傳回值部份,在XmlElementAttribute中加入ElementName:="OLTP" 讓VS2005會去讀SOAP BODY中的<OLTP>...</OLTP>內容當作傳回值即可
Public Function Operation( <System.Xml.Serialization.XmlElementAttribute( _
[Namespace]:="http://tempuri.org/")> ByVal OLTP As MyObj) _
As <System.Xml.Serialization.XmlElementAttribute([Namespace]:="http://tempuri.org/", ElementName:="OLTP")> MyObj
Dim results() As Object = Me.Invoke("Operation", New Object() {OLTP})
Return CType(results(0),MyObj)
End Function