用C實現WebService

轉文

一．系統環境 2
二．gSOAP的簡要使用例子 2
三．圖示說明 6
四．要注意的問題 6
五．參考文檔 7
六．備註 7

一．系統環境
linux操作系統kernel2.4.2，安裝gsoap2.6到目錄/usr/local/gsoap
二．gSOAP的簡要使用例子
下面是一個簡單的例子，實現一個加法運算的WebService，具體功能是cli端輸入num1和num2，server端返回一個num1和num2相加的結果sum。

1． 首先，我們需要做的是寫一個函數聲明文件，來定義介面函數ns__add，文件名字為add.h，內容如下：

//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． 然後我們需要創建文件Makefile，從而利用gsoapcpp2工具由add.h生成一些.xml文件、.c文件和.h文件，這些文件均為自動生成，Makefile的內容如下：

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

#總的目標
all:server

${WSNAME}.wsdl: ${WSNAME}.h
$(GSOAP_ROOT)/soapcpp2 -p$(WSNAME) -i -n -c ${WSNAME}.h

stdsoap2.o: $(GSOAP_ROOT)/stdsoap2.c
$(CC) -c $?

#編譯一樣生成規則的.o文件
$(ALL_OBJS):%.o:%.c
$(CC) -c $? $(INCLUDE)

#編譯伺服器端
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．我們先來做一個server端，創建文件addserver.c文件，內容如下：

#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 \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);//該句說明該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．讓我們的server跑起來吧：
shell>make
shell>./addserver 8888
如果終端列印出「Socket connection successful: master socket = 3」，那麼你的server已經在前台run起來了，應該是值得高興的。
打開IE，鍵入http://本機IP:8888，顯示XML，服務已經啟動，終端列印出「Socket connection successful: slave socket = 4」，表示服務接收到了一次soap的連接。

5．讓我們再來寫個客戶端（這個只是將soap的客戶端函數封裝一下，具體的調用參見下面的addtest.c），創建文件addclient.c，內容如下：

#include "addStub.h"
#include "add.nsmap"
/**
* 傳入參數：server：server的地址
* num1,num2：需要相加的數
* 傳出參數：sum：num1和num2相加的結果
* 返回值：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;
}

6．我們最終寫一個可以運行的客戶端調用程序，創建文件addtest.c，內容如下：

#include
#include

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
當然，你的server應該還在run，這樣得到輸出結果7+8=15，好了，你成功完成了你的第一個C寫的WebService，恭喜。
三．圖示說明

四．要注意的問題
1． add.h文件前面的幾句註釋不能刪除，為soapcpp2需要識別的標誌
2． 介面函數的返回值只能是int，是soap調用的結果，一般通過soap.error來判斷soap的連接情況，這個返回值沒有用到。
3． 介面函數的最後一個參數為傳出參數，如果需要傳出多個參數，需要自己定義一個結構將返回項封裝。
4． 在.h文件中不能include別的.h文件，可能不能生效，需要用到某些結構的時候需要在該文件中直接聲明。
5． 如果客戶端的調用不需要返回值，那麼最後一個參數
五．參考文檔
1．gsoap主頁
http://gsoap2.sourceforge.net

2．跟我一起寫Makefile
http://dev.csdn.net/develop/article/20/20025.shtm

3．Web Services： A Technical Introduction（機械工業出版社）
六．備註
192.168.18.233和192.168.18.234的/usr/local/gsoap目錄下的3個需要的文件及一個env目錄，不是編譯安裝的，是在別的地方編譯好了直接copy過來的（實際編譯結果中還有wsdl2h工具及其他一些文件，但是我們的實際開發中只是用到了這3個文件及env目錄）。因為時間倉促，本人還沒有時間研究編譯的問題，相關細節可以查看參考文檔1。
在192.168.18.233的/home/weiqiong/soap/sample目錄下及192.168.18.234的/tmp/soap/sample目錄下有本文講到的加法運算的例子。

[ Last edited by 風雨無阻 on 2005-11-24 at 00:58 ]

Tags: linux system 內核