gSoap工具wsdl2h及soapcpp2指令汇总

　　gSoap开发包的下载地址http://sourceforge.net/projects/gsoap2，在bin目录下提供了两个工具：

　　1：wsdl2h：The gSOAP wsdl2h tool imports one or more WSDLs and XML schemas and generates a gSOAP header le with familiar C/C++ syntax to define the Web service operations and the C/C++ data types.利用WSDL和XML schemas生成包含WS属性和操作的C++风格gSoap头文件。

　　2：The gSOAP soapcpp2 compiler then takes this header file and generates XML serializers for the data types (soapH.h and soapC.cpp), the client-side stubs (soapClient.cpp), and server-side skeletons (soapServer.cpp).编译头文件并生成xml等文件。其中，soapH.h and soapC.cpp包含了数据类型的描述，soapClient.cpp给客户端使用，soapServer.cpp给服务端使用。

　　通过官方给出的介绍可知，wsdl2h用作wsdl和.h文件的转换。soapcpp2用头文件生成客户端/服务端等开发需要的h和cpp文件。下面是官方给出的一个例子：

wsdl2h -o calc.h http://www.genivia.com/calc.wsdl
soapcpp2 -i -C calc.h

 

　　我下载是gSoap2.8.14，经过整理文档，wsdl2h和soapcpp的可选指令如下：

　　1：wsdl2h指令汇总

　　经常使用的一些指令如下：

　　-o　filename.h　　　将wsdl转化为filename.h头文件。

　　-s　　　　　　　　　不生成STL代码

　　-c　　　　　　　　　生成纯C风格的头文件，这将去除C++的一些特性

　　-n  name　　　　　 使用name代替默认前缀ns

　　-t　filename.dat　　使用filename.dat代替默认的typemap.dat文件

　　-zX　　　　　　　　兼容之前的X版本

　　2：soapcpp2

　　经常使用的一些指令如下：

　　-i　　　　 生成server的proxy和object，这种object继承于soap struct。

　　-j　　　　 和-i类似，区别在于生成的代理类不继承于soap struct，而是包含了包含了一个soap结构的指针。此种方式生存的代理类便于互相通信

　　-C　　　　仅生成客户端client代码

　　-S　　　　仅生成服务端server代码

　　-x　　　　不生成xml文件。不用此项的话，将对头文件中定义的每个operation生成一个描述性的xml文件

　　-L　　　　不生成soapClientLib文件和soapServerLib文件

　　-p name  修改文件名前缀，代替soap

　　-q name  指定代理类和对象使用的名空间name，包含文件名前缀

　　3：soapcpp2生成的各文件释义

转自：https://www.cnblogs.com/hgwang/p/5840265.html

 

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)。

转自：https://www.oschina.net/question/10320_7573