C++使用gsoap创建webService

gSOAP 是一个夸平台的，用于开发 Web Service 服务端和客户端的工具，在 Windows 、 Linux 、 MAC OS 和 UNIX 下使用 C 和 C++ 语言编码，集合了 SSL 功能。

下载地址： http://sourceforge.net/projects/gsoap2

官方网站： http://genivia.com/Products/gsoap/index.html

对于 Windows 平台下开发客户端，首先下载最新的 gsoap_win32_2.7.6c.zip 包，具体在以下地址： http://optusnet.dl.sourceforge.net/sourceforge/gsoap2/gsoap_win32_2.7.6c.zip

首先查看gsoap的User's Guide，基本就能对gsoap有个全面的了解，通过阅读Sample里的例子程序深入。然后搜索网上其它一些文章，比如：
gSOAP简单多线程服务器程序 http://blog.chinaunix.net/u1/55091/showart_430965.html
纯c gSoap实现WebService http://hi.baidu.com/2sky2sea/blog/item/40ec5555680279c1b745ae9b.html


接下来我结合自己的实践与理解，讲讲VC用gsoap下编写webService和客户端程序，有不对的地方还请大家指正，谢谢。
我以网上出现的实现一个简单的加法函数为例，讲讲我在操作过程中遇到的问题。

一 服务器端
1.首先编写 add.h文件：

[cpp:nogutter] view plain copy print ?

1. 1//gsoap ns service name: add
2. 2//gsoap ns service namespace: http://localhost/add.wsdl
3. 3//gsoap ns service location: http://localhost
4. 4//gsoap ns service executable: add.cgi
5. 5//gsoap ns service encoding: encoded
6. 6//gsoap ns schema namespace: urn:add
7. 7
8. 8int ns__add( int num1, int num2, int* sum );

1//gsoap ns service name: add 2//gsoap ns service namespace: http://localhost/add.wsdl 3//gsoap ns service location: http://localhost 4//gsoap ns service executable: add.cgi 5//gsoap ns service encoding: encoded 6//gsoap ns schema namespace: urn:add 7 8int ns__add( int num1, int num2, int* sum );

2.用gsoap/bin目录下的soapcpp2.exe程序，生成一些文件。可以把soapcpp2.exe拷贝到一add.h目录下，用cmd执行 soapcpp2.exe add.h就可以，在这个目录下会自动生成许多将来有用的文件，如 add.namap,soapH.h,soapC.cpp,soapClient.cpp,soapServer.cpp等文件。 soapcpp2.exe可以带参数执行，具体执行soapcpp2.exe -h查看。

3.新建一个win32控制台工程，加入wsock32.lib库，将刚才生成的那些文件添加到工程中。然后编写webserver.cpp主程序：

[cpp] view plain copy print ?

1. #include "add.h"
2. #include "add.nsmap"
3. int main(int argc, char* argv[])
4. {
6. int m, s; /**//* master and slave sockets */
7. struct soap add_soap;
8. soap_init(&add_soap);
9. //soap_set_namespaces(&add_soap, add_namespaces);
11. if (argc < 2)
12. {
13. printf("usage: %s <server_port> /n", argv[0]);
14. exit(1);
15. }
16. else
17. {
18. m = soap_bind(&add_soap, NULL, atoi(argv[1]), 100);
19. if (m < 0)
20. {
21. soap_print_fault(&add_soap, stderr);
22. exit(-1);
23. }
25. fprintf(stderr, "Socket connection successful: master socket = %d/n", m);
26. for ( ; ; )
27. {
28. s = soap_accept(&add_soap);
29. if (s < 0)
30. {
31. soap_print_fault(&add_soap, stderr);
32. exit(-1);
33. }
34. fprintf(stderr, "Socket connection successful: slave socket = %d/n", s);
36. soap_serve(&add_soap);//该句说明该server的服务
37. soap_end(&add_soap);
38. }
39. }
40. return 0;
41. }
42. //server端的实现函数与add.h中声明的函数相同，但是多了一个当前的soap连接的参数
43. int ns__add(struct soap *add_soap, int num1, int num2, int *sum)
44. {
45. *sum = num1 + num2;
46. return 0;
47. }

#include "add.h" #include "add.nsmap" int main(int argc, char* argv[]) { int m, s; /**//* master and slave sockets */ struct soap add_soap; soap_init(&add_soap); //soap_set_namespaces(&add_soap, add_namespaces); if (argc < 2) { printf("usage: %s <server_port> /n", argv[0]); exit(1); } else { m = soap_bind(&add_soap, NULL, atoi(argv[1]), 100); if (m < 0) { soap_print_fault(&add_soap, stderr); exit(-1); } fprintf(stderr, "Socket connection successful: master socket = %d/n", m); for ( ; ; ) { s = soap_accept(&add_soap); if (s < 0) { soap_print_fault(&add_soap, stderr); exit(-1); } fprintf(stderr, "Socket connection successful: slave socket = %d/n", s); soap_serve(&add_soap);//该句说明该server的服务 soap_end(&add_soap); } } return 0; } //server端的实现函数与add.h中声明的函数相同，但是多了一个当前的soap连接的参数 int ns__add(struct soap *add_soap, int num1, int num2, int *sum) { *sum = num1 + num2; return 0; }

4. 编译这个程序，会提示错误，将gsoap_win32目录下stdsoap2.cpp，stdsoap2.h文件加入工程，重新编译如果还有错误，可能是你将add.h生成的文件添加入工程出错的原因。实际上在编写server程序时，无须带Client的那些文件，还有带Lib的文件也无须添加到工程中。再重新编译应该就没有问题了，启动4567端口，在ie中输入localhost:4567,如果显示xml页面，说明程序已经启动。

二 对应的客户端
1。客户端程序代码如下:

[cpp] view plain copy print ?

1. #include <stdio.h>
2. #include <stdlib.h>
3. #include "soapH.h"
4. #include "add.nsmap"
6. int add(const char* server, int num1, int num2, int *sum);
7. int main(int argc, char **argv)
8. {
9. int result = -1;
10. char* server="http://localhost:4567";
11. int num1 = 0;
12. int num2 = 0;
13. int sum = 0;
14. if( argc < 3 )
15. {
16. printf("usage: %s num1 num2 /n", argv[0]);
17. exit(0);
18. }
20. num1 = atoi(argv[1]);
21. num2 = atoi(argv[2]);
23. result = add(server, num1, num2, ∑);
24. if (result != 0)
25. {
26. printf("soap err,errcode = %d/n", result);
27. }
28. else
29. {
30. printf("%d+%d=%d/n", num1, num2, sum );
31. }
32. return 0;
33. }
34. int add( const char* server, int num1, int num2, int *sum )
35. {
36. struct soap add_soap;
37. int result = 0;
38. soap_init(&add_soap);
39. // soap_set_namespaces(&add_soap, add_namespaces);
41. //该函数是客户端调用的主要函数，后面几个参数和add.h中声明的一样，前面多了3个参数，函数名是接口函数名ns__add前面加上soap_call_
42. soap_call_ns__add( &add_soap, server, "", num1, num2, sum );
43. if(add_soap.error)
44. {
45. printf("soap error:%d,%s,%s/n", add_soap.error, *soap_faultcode(&add_soap), *soap_faultstring(&add_soap) );
46. result = add_soap.error;
47. }
48. soap_end(&add_soap);
49. soap_done(&add_soap);
50. return result;
51. }

#include <stdio.h> #include <stdlib.h> #include "soapH.h" #include "add.nsmap" int add(const char* server, int num1, int num2, int *sum); int main(int argc, char **argv) { int result = -1; char* server="http://localhost:4567"; int num1 = 0; int num2 = 0; int sum = 0; if( argc < 3 ) { printf("usage: %s num1 num2 /n", argv[0]); exit(0); } num1 = atoi(argv[1]); num2 = atoi(argv[2]); result = add(server, num1, num2, ∑); if (result != 0) { printf("soap err,errcode = %d/n", result); } else { printf("%d+%d=%d/n", num1, num2, sum ); } return 0; } int add( const char* server, int num1, int num2, int *sum ) { struct soap add_soap; int result = 0; soap_init(&add_soap); // soap_set_namespaces(&add_soap, add_namespaces); //该函数是客户端调用的主要函数，后面几个参数和add.h中声明的一样，前面多了3个参数，函数名是接口函数名ns__add前面加上soap_call_ soap_call_ns__add( &add_soap, server, "", num1, num2, sum ); if(add_soap.error) { printf("soap error:%d,%s,%s/n", add_soap.error, *soap_faultcode(&add_soap), *soap_faultstring(&add_soap) ); result = add_soap.error; } soap_end(&add_soap); soap_done(&add_soap); return result; }

2.客户端程序既可以新建一个新的win32控制台程序，将刚才生成的nsmap,soapH.h,soapClient.h等文件加入工程，编译既可。我是直接在原先工程中加入一客户端代码，将webserver.cpp文件移除，并且将soapServer.cpp等server端需要的文件移除，将 soapClient.cpp等client端需要的cpp添加到工程，编译既可。
3.启动server程序，F5客户端程序，经测试正常。

三 遇到的问题
1.server端可以编译成CGI方式执行，而并不是绑定到某个端口，这种方式我没有实践。

[cpp] view plain copy print ?

1. if (argc < 2) // no args: assume this is a CGI application
2. {
3. soap_serve(&soap); // serve request, one thread, CGI style
4. soap_destroy(&soap); // dealloc C++ data
5. soap_end(&soap); // dealloc data and clean up
6. }

if (argc < 2) // no args: assume this is a CGI application { soap_serve(&soap); // serve request, one thread, CGI style soap_destroy(&soap); // dealloc C++ data soap_end(&soap); // dealloc data and clean up }

2.在编译服务器及客户端程序时一开始对add.h生成的文件添加到工程，经常出现问题，需要自己不调试。特别是链接时段，server/client要与其生成的文件相对应，server调用生成的soapserver.cpp，client调用生成的soapclient.cpp文件。
3.多线程方式，在windows下建议用pthread_win32库，这里给出多线程下的例子。

[cpp] view plain copy print ?

1. 一 gSOAP需要的头文件：
2. //gsoap ns service name: calc
3. //gsoap ns service style: rpc
4. //gsoap ns service encoding: encoded
5. //gsoap ns service namespace: http://127.0.0.1:8089/calc.wsdl
6. //gsoap ns service location: http://127.0.0.1:8089/cal
7. //gsoap ns schema namespace: urn:calc
8. int ns__add(double a, double b, double *result);
9. int ns__sub(double a, double b, double *result);
10. int ns__mul(double a, double b, double *result);
11. int ns__div(double a, double b, double *result);
12. int ns__pow(double a, double b, double *result);
13. 二 多线程服务器关键代码
14. #include
15. #include "calc.nsmap"
16. #include "soapH.h"
17. /**//
18. ///宏与全局变量的定义
19. #define BACKLOG (100)
20. #define MAX_THR (10)
21. #define MAX_QUEUE (1000)
23. pthread_mutex_t queue_cs; //队列锁
24. pthread_cond_t queue_cv; //条件变量
25. SOAP_SOCKET queue[MAX_QUEUE]; //数组队列
26. int head =0, tail =0; //队列头队列尾初始化
27. /**///
29. //
30. void * process_queue(void *); //线程入口函数
31. int enqueue(SOAP_SOCKET); //入队列函数
32. SOAP_SOCKET dequeue(void); //出队列函数
33. /**///
34. //线程入口函数
35. void * process_queue(void * soap)
36. {
37. struct soap * tsoap = (struct soap *)soap;
38. for(;;)
39. {
40. tsoap->socket = dequeue();
41. if (!soap_valid_socket(tsoap->socket))
42. {
43. break;
44. }
45. soap_serve(tsoap);
46. soap_destroy(tsoap);
47. soap_end(tsoap);
48. }
49. return NULL;
50. }
51. //入队列操作
52. int enqueue(SOAP_SOCKET sock)
53. {
54. int status = SOAP_OK;
55. int next;
56. pthread_mutex_lock(&queue_cs);
57. next = tail +1;
58. if (next >= MAX_QUEUE)
59. next = 0;
60. if (next == head)
61. status = SOAP_EOM;
62. else
63. {
64. queue[tail] =sock;
65. tail = next;
66. }
67. pthread_cond_signal(&queue_cv);
68. pthread_mutex_unlock(&queue_cs);
69. return status;
70. }
71. //出队列操作
72. SOAP_SOCKET dequeue()
73. {
74. SOAP_SOCKET sock;
75. pthread_mutex_lock(&queue_cs);
76. while (head == tail )
77. {
78. pthread_cond_wait(&queue_cv,&queue_cs);
79. }
80. sock = queue[head++];
81. if (head >= MAX_QUEUE)
82. {
83. head =0;
84. }
85. pthread_mutex_unlock(&queue_cs);
86. return sock;
87. }
89. /**///具体服务方法
90. //加法的实现
91. int ns__add(struct soap *soap, double a, double b, double *result)
92. {
93. *result = a + b;
94. return SOAP_OK;
95. }
96. //减法的实现
97. int ns__sub(struct soap *soap, double a, double b, double *result)
98. {
99. *result = a - b;
100. return SOAP_OK;
101. }
102. //乘法的实现
103. int ns__mul(struct soap *soap, double a, double b, double *result)
104. {
105. *result = a * b;
106. return SOAP_OK;
107. }
108. //除法的实现
109. int ns__div(struct soap *soap, double a, double b, double *result)
110. {
111. if (b)
112. *result = a / b;
113. else
114. {
115. char *s = (char*)soap_malloc(soap, 1024);
116. sprintf(s, "Can't">http://tempuri.org/">Can't divide %f by %f", a, b);
117. return soap_sender_fault(soap, "Division by zero", s);
118. }
119. return SOAP_OK;
120. }
121. //乘方的实现
122. int ns__pow(struct soap *soap, double a, double b, double *result)
123. {
124. *result = pow(a, b);
125. if (soap_errno == EDOM) /**//* soap_errno 和errorno类似, 但是和widnows兼容 */
126. {
127. char *s = (char*)soap_malloc(soap, 1024);
128. sprintf(s, "Can't take the power of %f to %f", a, b);
129. sprintf(s, "Can't">http://tempuri.org/">Can't take power of %f to %f", a, b);
130. return soap_sender_fault(soap, "Power function domain error", s);
131. }
132. return SOAP_OK;
133. }
134. /**///
135. //主函数
136. int main(int argc,char ** argv)
137. {
138. struct soap ServerSoap;
139. //初始话运行时环境
140. soap_init(&ServerSoap);
141. //如果没有参数，当作CGI程序处理
142. if (argc <2)
143. {
144. //CGI 风格服务请求，单线程
145. soap_serve(&ServerSoap);
146. //清除序列化的类的实例
147. soap_destroy(&ServerSoap);
148. //清除序列化的数据
149. soap_end(&ServerSoap);
150. }else
151. {
152. struct soap * soap_thr[MAX_THR];
153. pthread_t tid[MAX_THR];
154. int i,port = atoi(argv[1]);
155. SOAP_SOCKET m,s;
156. //锁和条件变量初始化
157. pthread_mutex_init(&queue_cs,NULL);
158. pthread_cond_init(&queue_cv,NULL);
159. //绑定服务端口
160. m = soap_bind(&ServerSoap,NULL,port,BACKLOG);
161. //循环直至服务套接字合法
162. while (!soap_valid_socket(m))
163. {
164. fprintf(stderr,"Bind port error! ");
165. m = soap_bind(&ServerSoap,NULL,port,BACKLOG);
166. }
167. fprintf(stderr,"socket connection successful %d ",m);
169. //生成服务线程
170. for(i = 0; i <MAX_THR; i++)
171. {
172. soap_thr[i] = soap_copy(&ServerSoap);
173. fprintf(stderr,"Starting thread %d ",i);
174. pthread_create(&tid[i],NULL,(void*(*)(void*))process_queue,(void*)soap_thr[i]);
175. }
177. for(;;)
178. {
179. //接受客户端的连接
180. s = soap_accept(&ServerSoap);
181. if (!soap_valid_socket(s))
182. {
183. if (ServerSoap.errnum)
184. {
185. soap_print_fault(&ServerSoap,stderr);
186. continue;
187. }else
188. {
189. fprintf(stderr,"Server timed out ");
190. break;
191. }
192. }
193. //客户端的IP地址
194. fprintf(stderr,"Accepted connection from IP= %d.%d.%d.%d socket = %d ",
195. ((ServerSoap.ip)>>24)&&0xFF,((ServerSoap.ip)>>16)&0xFF,((ServerSoap.ip)>>8)&0xFF,(ServerSoap.ip)&0xFF,(ServerSoap.socket));
196. //请求的套接字进入队列，如果队列已满则循环等待
197. while(enqueue(s) == SOAP_EOM)
198. Sleep(1000);
199. }
200. //服务结束后的清理工作
201. for(i = 0; i < MAX_THR; i++)
202. {
203. while (enqueue(SOAP_INVALID_SOCKET) == SOAP_EOM)
204. {
205. Sleep(1000);
206. }
207. }
208. for(i=0; i< MAX_THR; i++)
209. {
210. fprintf(stderr,"Waiting for thread %d to terminate ..",i);
211. pthread_join(tid[i],NULL);
212. fprintf(stderr,"terminated ");
213. soap_done(soap_thr[i]);
214. free(soap_thr[i]);
215. }
216. pthread_mutex_destroy(&queue_cs);
217. pthread_cond_destroy(&queue_cv);
218. }
219. //分离运行时的环境
220. soap_done(&ServerSoap);
221. return 0;
222. }