一.系統(tǒng)環(huán)境 2 二.gSOAP的簡(jiǎn)要使用例子 2 三.圖示說(shuō)明 6 四.要注意的問題 6 五.參考文檔 7 六.備注 7
一.系統(tǒng)環(huán)境 linux操作系統(tǒng)kernel2.4.2,安裝gsoap2.6到目錄/usr/local/gsoap 二.gSOAP的簡(jiǎn)要使用例子 下面是一個(gè)簡(jiǎn)單的例子,實(shí)現(xiàn)一個(gè)加法運(yùn)算的WebService,具體功能是cli端輸入num1和num2,server端返回一個(gè)num1和num2相加的結(jié)果sum。
1. 首先,我們需要做的是寫一個(gè)函數(shù)聲明文件,來(lái)定義接口函數(shù)ns__add,文件名字為add.h,內(nèi)容如下:
//gsoap ns service name: add //gsoap ns service namespace: http://mail.263.net/add.wsdl //gsoap ns service location: http://mail.263.net //gsoap ns service executable: add.cgi //gsoap ns service encoding: encoded //gsoap ns schema namespace: urn:add
int ns__add( int num1, int num2, int* sum );
2. 然后我們需要?jiǎng)?chuàng)建文件Makefile,從而利用gsoapcpp2工具由add.h生成一些.xml文件、.c文件和.h文件,這些文件均為自動(dòng)生成,Makefile的內(nèi)容如下:
GSOAP_ROOT=/usr/local/gsoap WSNAME=add CC=g++ -g -DWITH_NONAMESPACES INCLUDE=-I $(GSOAP_ROOT) SERVER_OBJS=$(WSNAME)C.o $(WSNAME)Server.o stdsoap2.o CLIENT_OBJS=$(GSOAP_ROOT)/env/envC.o $(WSNAME)ClientLib.o stdsoap2.o ALL_OBJS=${WSNAME}server.o $(WSNAME)C.o $(WSNAME)Server.o ${WSNAME}test.o ${WSNAME}client.o $(WSNAME)ClientLib.o
#總的目標(biāo) all:server
${WSNAME}.wsdl:${WSNAME}.h $(GSOAP_ROOT)/soapcpp2 -p$(WSNAME) -i -n -c ${WSNAME}.h
stdsoap2.o:$(GSOAP_ROOT)/stdsoap2.c $(CC) -c $?
#編譯一樣生成規(guī)則的.o文件 $(ALL_OBJS):%.o:%.c $(CC) -c $? $(INCLUDE)
#編譯服務(wù)器端 server:Makefile ${WSNAME}.wsdl ${WSNAME}server.o $(SERVER_OBJS) $(CC) ${WSNAME}server.o $(SERVER_OBJS) -o ${WSNAME}server
#編譯客戶端 client:Makefile ${WSNAME}.wsdl ${WSNAME}client.c ${WSNAME}test.c $(ALL_OBJS) stdsoap2.o $(CC) ${WSNAME}test.o ${WSNAME}client.o $(CLIENT_OBJS) -o ${WSNAME}test
cl: rm -f *.o *.xml *.a *.wsdl *.nsmap $(WSNAME)H.h $(WSNAME)C.c $(WSNAME)Server.c $(WSNAME)Client.c $(WSNAME)Stub.* $(WSNAME)$(WSNAME)Proxy.* $(WSNAME)$(WSNAME)Object.* $(WSNAME)ServerLib.c $(WSNAME)ClientLib.c $(WSNAME)server ns.xsd $(WSNAME)test
3.我們先來(lái)做一個(gè)server端,創(chuàng)建文件addserver.c文件,內(nèi)容如下:
#include "addH.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); add_serve(&add_soap);//該句說(shuō)明該server的服務(wù) soap_end(&add_soap); } } return 0; } //server端的實(shí)現(xiàn)函數(shù)與add.h中聲明的函數(shù)相同,但是多了一個(gè)當(dāng)前的soap連接的參數(shù) int ns__add(struct soap *add_soap, int num1, int num2, int *sum) { *sum = num1 + num2; return 0; }
4.讓我們的server跑起來(lái)吧: shell>make shell>./addserver 8888 如果終端打印出“Socket connection successful: master socket = 3”,那么你的server已經(jīng)在前臺(tái)run起來(lái)了,應(yīng)該是值得高興的。 打開IE,鍵入http://本機(jī)IP:8888,顯示XML,服務(wù)已經(jīng)啟動(dòng),終端打印出“Socket connection successful: slave socket = 4”,表示服務(wù)接收到了一次soap的連接。
5.讓我們?cè)賮?lái)寫個(gè)客戶端(這個(gè)只是將soap的客戶端函數(shù)封裝一下,具體的調(diào)用參見下面的addtest.c),創(chuàng)建文件addclient.c,內(nèi)容如下:
#include "addStub.h" #include "add.nsmap" /** * 傳入?yún)?shù):server:server的地址 * num1,num2:需要相加的數(shù) * 傳出參數(shù):sum:num1和num2相加的結(jié)果 * 返回值: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);
//該函數(shù)是客戶端調(diào)用的主要函數(shù),后面幾個(gè)參數(shù)和add.h中聲明的一樣,前面多了3個(gè)參數(shù),函數(shù)名是接口函數(shù)名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; }
6.我們最終寫一個(gè)可以運(yùn)行的客戶端調(diào)用程序,創(chuàng)建文件addtest.c,內(nèi)容如下:
#include <stdio.h> #include <stdlib.h>
int add(const char* server, int num1, int num2, int *sum);
int main(int argc, char **argv) { int result = -1; char* server="http://localhost:8888"; 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, &sum); if (result != 0) { printf("soap err,errcode = %d\n", result); } else { printf("%d+%d=%d\n", num1, num2, sum ); } return 0; }
7.讓我們的client端和server端通訊 shell>make client shell>./addtest 7 8 當(dāng)然,你的server應(yīng)該還在run,這樣得到輸出結(jié)果7+8=15,好了,你成功完成了你的第一個(gè)C寫的WebService,恭喜。 三.圖示說(shuō)明
四.要注意的問題 1. add.h文件前面的幾句注釋不能刪除,為soapcpp2需要識(shí)別的標(biāo)志 2. 接口函數(shù)的返回值只能是int,是soap調(diào)用的結(jié)果,一般通過soap.error來(lái)判斷soap的連接情況,這個(gè)返回值沒有用到。 3. 接口函數(shù)的最后一個(gè)參數(shù)為傳出參數(shù),如果需要傳出多個(gè)參數(shù),需要自己定義一個(gè)結(jié)構(gòu)將返回項(xiàng)封裝。 4. 在.h文件中不能include別的.h文件,可能不能生效,需要用到某些結(jié)構(gòu)的時(shí)候需要在該文件中直接聲明。 5. 如果客戶端的調(diào)用不需要返回值,那么最后一個(gè)參數(shù) 五.參考文檔 1.gsoap主頁(yè) http://gsoap2.sourceforge.net
2.跟我一起寫Makefile http://dev.csdn.net/develop/article/20/20025.shtm
3.Web Services: A Technical Introduction(機(jī)械工業(yè)出版社) 六.備注 192.168.18.233和192.168.18.234的/usr/local/gsoap目錄下的3個(gè)需要的文件及一個(gè)env目錄,不是編譯安裝的,是在別的地方編譯好了直接copy過來(lái)的(實(shí)際編譯結(jié)果中還有wsdl2h工具及其他一些文件,但是我們的實(shí)際開發(fā)中只是用到了這3個(gè)文件及env目錄)。因?yàn)闀r(shí)間倉(cāng)促,本人還沒有時(shí)間研究編譯的問題,相關(guān)細(xì)節(jié)可以查看參考文檔1。 在192.168.18.233的/home/weiqiong/soap/sample目錄下及192.168.18.234的/tmp/soap/sample目錄下有本文講到的加法運(yùn)算的例子。
|