不會游泳的魚

gSOAP是一個綁定SOAP/XML到C/C++語言的工具，使用它可以簡單快速地開發(fā)出SOAP/XML的服務(wù)器端和客戶端。由于 gSOAP具 有相當(dāng)不錯的兼容性，通過gSOAP，我們就可以調(diào)用由Java, .Net, Delhpi, PHP等語言開發(fā)的SOAP服務(wù)，或者向它們提供SOAP服務(wù)。

gSOAP的主頁是:
http://sourceforge.net/projects/gsoap2
下載解壓后，可以在gsoap\bin\win32里 找到wsdl2h.exe和soapcpp2.exe（另外還有l(wèi)inux和mac版本）。
wsdl2h.exe的作用是根據(jù)WSDL生成C/C++風(fēng)格的頭 文件
soapcpp2.exe的作用是根據(jù)頭文件自動生成調(diào)用遠(yuǎn)程 SOAP服務(wù)的客戶端代碼（稱為存根:Stub）和提供SOAP服務(wù)的框架代碼（稱為框架：Skeleton），另外它也能從頭文件生成WSDL文件。
gsoap\stdsoap2.cpp則是gSOAP的核心代碼，要使用 gSOAP只要在項(xiàng)目里包含這個文件以及由soapcpp2.exe生成的代碼即可。另外還有個stdsoap2.c，內(nèi)容與stdsoap2.cpp一 模一樣，用于純C項(xiàng)目。
gSOAP兩大工具的用法

從WSDL中產(chǎn)生頭文件
用法：

wsdl2h -o 頭文件名 WSDL文件名或URL

wsdl2h常用選項(xiàng)

• -o 文件名，指定輸出頭文件
• -n 名空間前綴 代替默認(rèn)的ns
• -c 產(chǎn)生純C代碼，否則是C++代碼
• -s 不要使用STL代碼
• -t 文件名，指定type map文件，默認(rèn)為typemap.dat
• -e 禁止為enum成員加上名空間前綴

type map文件用于指定SOAP/XML中的類型與C/C++之間的轉(zhuǎn)換規(guī)則，比如在wsmap.dat里寫

xsd__string = | std::wstring | wchar_t*

那么SOAP/XML中的string將轉(zhuǎn)換成std::wstring或wchar_t*，這樣能更好地支持中文。

例:

wsdl2h -o ayandy.h \
 -n ay -t wsmap.dat \
 http://www.ayandy.com/Service.asmx?WSDL

從http://www.ayandy.com/Service.asmx?WSDL 生成ayandy.h文件，名空間為ay，使用wsmap.dat指定的轉(zhuǎn)換規(guī)則。

wsdl2h生成的頭文件里的變量、類型等名稱的前面都會加上名空間前綴，以兩個下劃線分隔。如上面的命令生成的頭文件，有這樣的定義：

class ay1__ArrayOfString; 
enum ay1__theDayFlagEnum 
{ 
 ay1__theDayFlagEnum__Today, 
 ay1__theDayFlagEnum__Tomorrow, 
 ay1__theDayFlagEnum__theDayafterTomorrow, 
}; 

前面的ayandy1__的是名空間前綴，用以防止名稱沖突。 wsdl2h的-n選項(xiàng)可以改變這個名空間前綴(默認(rèn)為ns)。對于枚舉ay1__theDayFlagEnum內(nèi) 的成員，如果嫌它太長的話，可以用-e命令選項(xiàng)禁止加入名空間前綴。

從頭文件生成存根(stub)和框架(Skeleton)源文件

編寫SOAP程序除了頭文件是不夠的，還要有連接、通信、XML解析、序列/反序列化等工作。gSOAP提供的socapcpp2.exe就 是用于從頭文件中生成這些代碼的，我們只要關(guān)心真正的業(yè)務(wù)邏輯就行了。

用法:

soapcpp2 頭文件

例：

soapcpp2 ayandy.h

將生成下面這些文件

• soapStub.h    // soap的存根文件，定義了ayandy.h里對應(yīng)的遠(yuǎn)程調(diào)用模型
• soapC.c soapH.h  // soap的序列和反序列代碼，它已經(jīng)包含了soapStub.h，服務(wù)器端與客戶端都要包含它
• soapClient.c soapClientLib.c // 客戶端代碼，soapClientLib.c文件則只是簡單地包含soapClient.c和soapC.c
• soapServer.c soapServerLib.c // 服務(wù)器端代碼,soapServerLib.c文件則只是簡單地包含soapServer.c和soapC.c
• ServiceSoap.nsmap ServiceSoap12.nsmap // 名空間定義，服務(wù)器端與客戶端都要包含它
• soapServiceSoapProxy.h soapServiceSoap12Proxy.h // 客戶端的C++簡單包裝(如果頭文件是純C代碼，這兩個文件就不會生成)

綜上所述

• 如果編寫服務(wù)器端，項(xiàng)目里應(yīng)該加入soapServerLib.c，代碼里包含頭文件soapH.h
• 如果編寫客戶端，項(xiàng)目里應(yīng)該加入soapClientLib.c，代碼里包含頭文件SoapH.h（或xxxxProxy.h）
• 當(dāng)然，還要加入gsoap庫里的stdsoap2.cpp文件（如果是寫C代碼，則加入stdsoap2.c）

如果看到soapcpp2提示:”Critical error: #import: Cannot open file "stlvector.h" for reading.“， 那是因?yàn)槲覀兊念^文件使用了STL(wsdl2h 沒用-s選項(xiàng))，這時要使用-I選項(xiàng)指定gSOAP的 import文件路徑，這個路徑是"$gsoap\gsoap\import":

soapcpp2 ayandy.h -I D:\gsoap-2.7\gsoap\import

soapcpp2常用選項(xiàng)

• -C 僅生成客戶端代碼
• -S 僅生成服務(wù)器端代碼
• -L 不要產(chǎn)生soapClientLib.c和soapServerLib.c文件
• -c 產(chǎn)生純C代碼，否則是C++代碼(與頭文件有關(guān))
• -I 指定import路徑（見上文）
• -x 不要產(chǎn)生XML示例文件
• -i 生成C++包裝，客戶端為xxxxProxy.h(.cpp)，服務(wù)器端為xxxxService.h(.cpp)。
  

編寫SOAP客戶端

下面將演示使用gSOAP到網(wǎng)上取得天氣預(yù)報，互聯(lián)網(wǎng)上有不少網(wǎng)站提供SOAP服務(wù)，比如Google提供的搜索API（現(xiàn)在已不再提 供新的License Key了），不少博客提供的API等。這里介紹一個提供天氣預(yù)報服務(wù)的SOAP服務(wù)，地址是http://www.ayandy.com

它提供了三個函數(shù)：
getSupportCity 查詢本天氣WebService支持的城市信息。
getSupportProvince 查詢本天氣 WebService支持的省份信息。
getWeatherbyCityName 根據(jù)城市名稱獲得天 氣情況。
它的WSDL地址是http://www.ayandy.com/Service.asmx?WSDL
現(xiàn)在，我們編寫一個客戶端去調(diào)用getWeatherbyCityName來 取得天氣情況
1. 從WSDL得到頭文件

wsdl2h -o ayandy.h http://www.ayandy.com/Service.asmx?WSDL

2. 從頭文件得到存根(Stub)源文件

soapcpp2 -i -C -x ayandy.h -ID:\gsoap-2.7\gsoap\import

命令選項(xiàng)注釋:
 -i 直接使用C++包裝類
 -x 不要生成一堆看了就惡心的xml
 -C 只生成客戶端相關(guān)代碼
 -I 指定import路徑
3. 建立新項(xiàng)目
把gsoap庫里的stdsoap2.cpp文件，以及上一步生成的soapServiceSoapProxy.cpp和soapC.cpp都加入到項(xiàng) 目。
設(shè)置加入的這三個文件為不使用預(yù)編譯頭。
4. 編寫代碼
由于參數(shù)及回傳的數(shù)據(jù)都是中文，所有讓gSOAP使用UTF8方式傳送以防止亂碼。