用gSOAP开发Web Service程序

gSOAP是一个绑定SOAP/XML到C/C++语言的工具，使用它可以简单快速地开发出SOAP/XML的服务器端和客户端。由于 gSOAP具 有相当不错的兼容性，通过gSOAP，我们就可以调用由Java, .Net, Delhpi, PHP等语言开发的SOAP服务，或者向它们提供SOAP服务。

gSOAP的主页是:
http://sourceforge.net/projects/gsoap2
下载解压后，可以在gsoap\bin\win32里 找到wsdl2h.exe和soapcpp2.exe（另外还有linux和mac版本）。
wsdl2h.exe的作用是根据WSDL生成C/C++风格的头 文件
soapcpp2.exe的作用是根据头文件自动生成调用远程 SOAP服务的客户端代码（称为存根:Stub）和提供SOAP服务的框架代码（称为框架：Skeleton），另外它也能从头文件生成WSDL文件。
gsoap\stdsoap2.cpp则是gSOAP的核心代码，要使用 gSOAP只要在项目里包含这个文件以及由soapcpp2.exe生成的代码即可。另外还有个stdsoap2.c，内容与stdsoap2.cpp一 模一样，用于纯C项目。
gSOAP两大工具的用法

从WSDL中产生头文件
用法：

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

wsdl2h常用选项

• -o 文件名，指定输出头文件
• -n 名空间前缀 代替默认的ns
• -c 产生纯C代码，否则是C++代码
• -s 不要使用STL代码
• -t 文件名，指定type map文件，默认为typemap.dat
• -e 禁止为enum成员加上名空间前缀

type map文件用于指定SOAP/XML中的类型与C/C++之间的转换规则，比如在wsmap.dat里写

xsd__string  =   |  std::wstring  |  wchar_t *

那么SOAP/XML中的string将转换成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指定的转换规则。

wsdl2h生成的头文件里的变量、类型等名称的前面都会加上名空间前缀，以两个下划线分隔。如上面的命令生成的头文件，有这样的定义：

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

前面的ayandy1__的是名空间前缀，用以防止名称冲突。 wsdl2h的-n选项可以改变这个名空间前缀(默认为ns)。对于枚举ay1__theDayFlagEnum内 的成员，如果嫌它太长的话，可以用-e命令选项禁止加入名空间前缀。

从头文件生成存根(stub)和框架(Skeleton)源文件

编写SOAP程序除了头文件是不够的，还要有连接、通信、XML解析、序列/反序列化等工作。gSOAP提供的socapcpp2.exe就 是用于从头文件中生成这些代码的，我们只要关心真正的业务逻辑就行了。

用法:

soapcpp2 头文件

例：

soapcpp2 ayandy.h

将生成下面这些文件

• soapStub.h    // soap的存根文件，定义了ayandy.h里对应的远程调用模型
• soapC.c soapH.h  // soap的序列和反序列代码，它已经包含了soapStub.h，服务器端与客户端都要包含它
• soapClient.c soapClientLib.c // 客户端代码，soapClientLib.c文件则只是简单地包含soapClient.c和soapC.c
• soapServer.c soapServerLib.c // 服务器端代码,soapServerLib.c文件则只是简单地包含soapServer.c和soapC.c
• ServiceSoap.nsmap ServiceSoap12.nsmap // 名空间定义，服务器端与客户端都要包含它
• soapServiceSoapProxy.h soapServiceSoap12Proxy.h // 客户端的C++简单包装(如果头文件是纯C代码，这两个文件就不会生成)

综上所述

• 如果编写服务器端，项目里应该加入soapServerLib.c，代码里包含头文件soapH.h
• 如果编写客户端，项目里应该加入soapClientLib.c，代码里包含头文件SoapH.h（或xxxxProxy.h）
• 当然，还要加入gsoap库里的stdsoap2.cpp文件（如果是写C代码，则加入stdsoap2.c）

如果看到soapcpp2提示:”Critical error: #import: Cannot open file "stlvector.h" for reading.“， 那是因为我们的头文件使用了STL(wsdl2h 没用-s选项)，这时要使用-I选项指定gSOAP的 import文件路径，这个路径是"$gsoap\gsoap\import":

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

soapcpp2常用选项

• -C 仅生成客户端代码
• -S 仅生成服务器端代码
• -L 不要产生soapClientLib.c和soapServerLib.c文件
• -c 产生纯C代码，否则是C++代码(与头文件有关)
• -I 指定import路径（见上文）
• -x 不要产生XML示例文件
• -i 生成C++包装，客户端为xxxxProxy.h(.cpp)，服务器端为xxxxService.h(.cpp)。
  

编写SOAP客户端

下面将演示使用gSOAP到网上取得天气预报，互联网上有不少网站提供SOAP服务，比如Google提供的搜索API（现在已不再提 供新的License Key了），不少博客提供的API等。这里介绍一个提供天气预报服务的SOAP服务，地址是http://www.ayandy.com

它提供了三个函数：
getSupportCity 查询本天气WebService支持的城市信息。
getSupportProvince 查询本天气 WebService支持的省份信息。
getWeatherbyCityName 根据城市名称获得天 气情况。
它的WSDL地址是http://www.ayandy.com/Service.asmx?WSDL
现在，我们编写一个客户端去调用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

命令选项注释:
 -i 直接使用C++包装类
 -x 不要生成一堆看了就恶心的xml
 -C 只生成客户端相关代码
 -I 指定import路径
3. 建立新项目
把gsoap库里的stdsoap2.cpp文件，以及上一步生成的soapServiceSoapProxy.cpp和soapC.cpp都加入到项 目。
设置加入的这三个文件为不使用预编译头。
4. 编写代码
由于参数及回传的数据都是中文，所有让gSOAP使用UTF8方式传送以防止乱码。