Gsoap整理

一. WebService，soap，gsoap

WebService：就是一个应用程序，它向外界暴露出一个可以通过web进行调用的API，是分布式的服务组件。本质上就是要以标准的形式实现企业内外各个不同服务系统之间的互调和集成。

soap：简单对象访问协议，是一种轻量的、简单的、基于 XML 的协议，它被设计成在WEB 上交换结构化的和固化的信息。从这里的概念可以看得出来，soap是一个基于xml格式的web交互协议，而webservice是一种使用web方式实现的功能。就好像是网络视频服务器和http的关系，就是这里的webservice服务器和soap的关系。其实从历史上来说，先有的soap这种协议，然后微软用基于这种协议制作了webservice这种服务。

gsoap：是一种能够把C/C++语言的接口转换成基于soap协议的webservice服务的工具。

 

二． 基本流程

1.gsoap客户端代码支持两种实现方式：

1>代理类
2>非代理类的方式。

2.gSOAP主要包括两个exe：
wsdl2h.exe的作用是根据WSDL生成C/C++风格的头文件;
soapcpp2.exe的作用是根据头文件自动生成调用远程 SOAP服务的客户端代码（称为存根:Stub）和提供SOAP服务的框架代码（称为框架：Skeleton），另外它也能从头文件生成WSDL文件。

 

3.实现步骤

1. 从Web服务提供者处获取Web Service的WSDL文件，通常是一个URL，

如：http://www.cs.fsu.edu/~engelen/calc.wsdl

当然也可以是一个WSDL形式的XML文件。

2． 使用gSoap工具wsdl2h，根据WSDL生成一个C/C++语法结构的头文件。

如：wsdl2h -s -o calc.h http://www.cs.fsu.edu/~engelen/calc.wsdl

wsdl2h.exe -s -o Calc2.h calc.wsdl abcd.wsdl  --指定多个wsdl生成同一个的文件名为Calc2.h，并且不使用STL

这一步将会得到一个头文件，如：calc.h

该步的目的：实现WSDL文件到.h文件的数据映射。

3． 使用gSoap的预编译器soapcpp2，根据上一步得到的头文件来生成存根文件（soapStub.h）和客户端代码框架。

如：soapcpp2 -i -x -C -L calc.h

这一步将会得到几个. nsmap、.h和.cpp文件，如：calc.nsmap、soapC.cpp、soapH.h、soapStub.h、soapcalcProxy.cpp、soapcalcProxy.h

该步的目的：生成相应的底层通信代码。

三、注意事项

注1 ：wsdl2h的用法（WSDL/schema 解析和代码生成器）

wsdl2h [opt] 头文件名 WSDL文件名或URL

wsdl2h常用选项

-o 文件名，指定输出头文件

-n 名空间前缀 代替默认的ns

-c 产生纯C代码，否则是C++代码

-s 不要使用STL代码

-t 文件名，指定type map文件，默认为typemap.dat

-e 禁止为enum成员加上名空间前缀

-p  修改生成通讯框架名字

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

在本例中，使用的是：wsdl2h -s -o calc.h  http://www.cs.fsu.edu/~engelen/calc.wsdl

参数s就表示生成不带STL的C/C++语法结构的头文件calc.h。

如果不用s就会生成带STL的头文件，这样，在后边的编译中需要加入STL的头

stlvector.h，位于：gsoap/import/目录下。

注2 ：soapcpp2的用法（编译和代码生成器）

soapcpp2 [opt] 头文件名

soapcpp2常用选项

-C 仅生成客户端代码

-S 仅生成服务器端代码

-L 不要产生soapClientLib.c和soapServerLib.c文件

-c 产生纯C代码，否则是C++代码(与头文件有关)

-I 指定import路径（见上文）

-x 不要产生XML示例文件

-i 生成C++封装(代理)，客户端为xxxxProxy.h(.cpp)，服务器端为xxxxService.h(.cpp)。

 

本例中，使用的是：soapcpp2-i -x -C -L calc.h

注3 ：gSoap工具wsdl2和soapcpp所生成文件的简单分析

（1） wsdl2生成的具有C/C++语法结构的头文件，其作用就是：将XML语法结构的WSDL文件映射为C/C++语法结构的.h文件；并为下一步做准备。

（2） soapcpp（采用参数：-i -x -C -L）生成的文件共有6个文件：PlayerBeanPortBinding.nsmap、soapC.cpp、soapH.h、 soapPlayerBeanPortBindingProxy.cpp、soapPlayerBeanPortBindingProxy.h、 soapStub.h。

a.PlayerBeanPortBinding.nsmap文件

该文件的作用：An XML-to-C/C++ namespace mapping table，即WSDL文件与生成的客户端代码框架的一个名字空间的映射表。

b. soapStub.h

该文件就是直接由wsdl2生成的头文件转化而来，它详细定义了WSDL所描述的各项服务和数据结构。

它是soap的存根文件，定义了由wsdl2生成的头文件里对应的远程调用模型（RPC）。

c.soapPlayerBeanPortBindingProxy.cpp，soapPlayerBeanPortBindingProxy.cpp

这两个文件是客户端代码的一个简单封装，它封装了底层通信，并向外提供一个很简单的界面，该界面展示了用户能够使用的所有服务（由WSDL所描述）。

d. soapH.h和soapC.cpp

这个两个文件是soap的序列和反序列化代码，

注意：stdsoap2.h 和 stdsoap2.cpp 是从gsoap包中的gsoap-2.8\gsoap 目录下直接复制的。

注4 ：设置字符编码

  在利用gSoap编写Web Service客户端和服务器端的程序时，需要设置其编码方式。接口为：soap_set_mode，其实它是就是一个宏：

#define soap_set_mode(soap, n) ((soap)->imode |= (n),(soap)->omode |= (n))

如果要设置为UTF8

可以这样调用：soap_set_mode(&soap, SOAP_C_UTFSTRING);

详细信息可参考该宏所在文件：stdsoap2.h

 

注5：代理类和非代理类

参见http://www.cs.fsu.edu/~engelen/soap.html可知非代理类的方式是一个比较老的使用方式，现在官方推荐使用代理类的方式。