gsoap使用总结

野性酷女 2022-08-06 14:05 165阅读 0赞

>>用C实现WebService，gsoap是最好的选择了。近一个月都在折腾这个，做个总结吧，估计会写得比较长。因为其中碰到了不少问题，但最终都解决调了。  
>>快速开始  
  1. gsoap官网。遇到问题时，官网往往是最能提供帮助的地方。  
     [http://gsoap2.sourceforge.net/][http_gsoap2.sourceforge.net]  
  2. 几个值得参考的链接。  
     GSoap使用心得： [http://www.cppblog.com/qiujian5628/archive/2008/10/11/54019.html][http_www.cppblog.com_qiujian5628_archive_2008_10_11_54019.html]  
     GSoap接口定义： [http://blog.sina.com.cn/s/blog\_5ee9235c0100de3g.html][http_blog.sina.com.cn_s_blog_5ee9235c0100de3g.html]  
       
>>测试代码。  
  我是在linux下用C开发的，那就Makefile入手吧。至于服务端的代码，和客户端的代码，可以参考《GSoap使用心得》，或者是gsoap自带的例子。  
     a. 用soapcpp2生产gsoap相关代码： $(GSOAP\_BIN)/soapcpp2 -c -x $\{WSNAME\}.h  
     b. 服务端所需的代码： soapC.c soapServer.c stdsoap2.c  
     c. 客户端所需的代码： soapC.c soapClient.c stdsoap2.c  
     d. 其中stdsoap2.c是从gsoap开发包中复制过来的，他的文件是(a)中命令产生的。  
       
\-------------分隔符------------------------------------  
GSOAP\_BIN=/usr/local/gSOAP/bin  
WSNAME0=soap  
WSNAME=SmsWBS  
SERVER\_OBJS=$(WSNAME0)C.o $(WSNAME0)Server.o stdsoap2.o    $\{WSNAME\}server.o  
CLIENT\_OBJS=$(WSNAME0)C.o $(WSNAME0)Client.o stdsoap2.o    $\{WSNAME\}client.o  
AA\_OBJS=$(WSNAME0)C.o $(WSNAME0)Server.o $(WSNAME0)Client.o stdsoap2.o $\{WSNAME\}server.o $\{WSNAME\}client.o

INCLUDE=  
LIBS=  
CC=g++ -g -DWITH\_NONAMESPACES

\#LIBS=-lz -lc -lncurses -lssl -lcrypto  
\#CC=g++ -g -DWITH\_NONAMESPACES -DWITH\_OPENSSL

all:server  
all:client

$\{WSNAME\}.wsdl:$\{WSNAME\}.h  
    $(GSOAP\_BIN)/soapcpp2 -c -x $\{WSNAME\}.h

$(AA\_OBJS):%.o:%.c  
    $(CC) -c $? $(INCLUDE)

server:Makefile $\{WSNAME\}.wsdl  $(SERVER\_OBJS)  
    $(CC) $(SERVER\_OBJS) $(LIBS) -o Smsserver -lpthread

client:Makefile $\{WSNAME\}.wsdl  $(CLIENT\_OBJS)  
    $(CC) $(CLIENT\_OBJS) $(LIBS) -o Smsclient

clean:  
    rm -f \*.o \*.xml \*.a \*.wsdl \*.nsmap \\  
    $(WSNAME0)H.h $(WSNAME0)C.c $(WSNAME0)Server.c $(WSNAME0)Client.c \\  
    $(WSNAME0)Stub.\* $(WSNAME)$(WSNAME)Proxy.\* $(WSNAME)$(WSNAME)Object.\* \\  
    $(WSNAME0)ServerLib.c $(WSNAME0)ClientLib.c $(WSNAME)server ns.xsd $(WSNAME)test

clear:  
    rm -f \*.o ns.xsd  
\-------------分隔符------------------------------------

>>接口定义，可参考《GSoap接口定义》。这里我将给出C\#引用这个webserver所对应的接口形式。  
  gsoap是根据我们定义好的.h文件，然后用工具产生了我们所需的.c文件。所以我们必须根据gsoap的要求编写.h。  
  1. 单个参数的传出：  
     int ns\_\_add( int a, int b, int \*c );  
     需要说明的是，这里的ns\_\_是必须的，必须以开始注释中的ns加两个下划线开始。返回值必须是int。  
     但是这里的int并不是接口的返回值，而是gsoap内部的返回值。真正的返回值是int \*c。  
       
     C\#中对应的接口:  int add( int a, int b );  返回值就是上述的int \*c参数。  
       
  2. 多个参数传出，在接口中必须使用结构体  
     typedef char \* xsd\_\_string;  
     typedef long   xsd\_\_int;  
     struct ns\_\_personResponse\{  
         xsd\_\_int age;  
         xsd\_\_string name;  
         xsd\_\_string address;  
     \};  
     int ns\_\_person( xsd\_\_string buf\_in, struct ns\_\_personResponse \* buf\_out );  
       
     在C\#中，并不是我们所声明的这样。而是：int person( string buf\_in, out string name, out string address );  
     即，结构体中的第一个域会变成返回值，其他的变成一个个的输出参数。  
       
  3. 返回结构体。如果要返回结构图，那么必须在结构体中再套一层结构体：  
     typedef char \* xsd\_\_string;  
     typedef long   xsd\_\_int;  
     struct ns\_\_person\{  
         xsd\_\_int age;  
         xsd\_\_string name;  
         xsd\_\_string address;       
     \};  
     struct ns\_\_personResponse\{  
         xsd\_\_int ret;  
         struct ns\_\_person person;  
     \};  
     int ns\_\_person( xsd\_\_string buf\_in, struct ns\_\_personResponse \* buf\_out );  
       
     那么在C\#中，看到的接口是这样的：int person( string buf\_in, person对应的结构类 );  
       
  4. 接口中的下划线，如果接口中的交易名有下划线，必须这么声明：  
     int ns\_\_echo\_USCOREreverse( char \* buf\_in, char \*\* buf\_out );  
       
     那么，C\#中实际上的接口名就是：string echo\_reverse( string buf\_in );

>>gsoap中返回字符串  
  1. 下面是一个逆转字符串的函数。  
     int ns\_\_echo\_USCOREreverse( char \* buf\_in, char \*\* buf\_out );  
     int ns\_\_echo\_USCOREreverse( struct soap \*add\_soap, char \*buf\_in, char \*\*buf\_out )  
     \{  
        int i, j, len;  
        printf( "ns\_\_interface: in=\[%s\]\\n", buf\_in );  
      
        len = strlen(buf\_in);  
        \*buf\_out = (char\*)soap\_malloc( add\_soap, len+1 );  
        for( i=len-1, j=0; i>=0; i--, j++ )\{  
            (\*buf\_out)\[j\] = buf\_in\[i\];  
        \}  
        (\*buf\_out)\[j\] = 0;

return 0;  
     \}  
       
     其中调用soap\_malloc申请空间，并且将他赋给返回参数buf\_out。这个空间会在调用soap\_end时被释放。  
       
>>gsoap传输中文。我使用utf-8编码格式来支持汉字的传输。  
  1. 设置gsoap为utf-8传输数据  
     soap\_set\_mode( &SmsWBS\_soap, SOAP\_C\_UTFSTRING );    //设置编码  
     SmsWBS\_soap.mode|=SOAP\_C\_UTFSTRING;  
       
  2. 使用下面得函数转换我们的传输内容，即将我们的数据转成UTF-8编码：  
     int conv\_charset( const char \*dest, const char \*src, char \*input, size\_t ilen, char \*output, size\_t olen )  
     \{  
         int convlen = olen;  
         iconv\_t conv = iconv\_open( dest, src );  
         if( conv == (iconv\_t) -1 )  
             return -1;  
      
          memset( output, 0, olen );  
         if( iconv( conv, &input, &ilen, &output, &olen ) )\{  
             iconv\_close(conv);  
             return -1;  
         \}

iconv\_close(conv);  
         return convlen-olen;  
     \}  
     例子： conv\_charset( "UTF-8", "GBK", "林学任.linxr", strlen("林学任.linxr"),  buf\_out->name, 100 );  
    
>>webserver发布  
  1. 在C\#中，可以直接引用一个webserver，但是我们写得webserver如何能用被其引用呢。其实只要实现gsoap的fget回调函数即可：  
     SmsWBS\_soap.fget = http\_get;  
  2. http\_get函数实现  
     int http\_get(struct soap \* soap)  
     \{   
         FILE \*fd = NULL;  
       
         char \*s = strchr( soap->path, '?' );  
         if( !s || strcmp( s, "?wsdl" ) )\{  
             return SOAP\_GET\_METHOD;  
         \}  
       
         fd = fopen( "SmsWBS.wsdl", "rb" );  
         if (!fd)\{  
             return 404;  
         \}  
       
         soap->http\_content = "text/xml";  
         soap\_response(soap, SOAP\_FILE);  
         for (;;)\{   
             size\_t r = fread(soap->tmpbuf, 1, sizeof(soap->tmpbuf), fd);  
             if( !r )\{  
                 break;  
             \}  
             if( soap\_send\_raw( soap, soap->tmpbuf, r) )\{  
                 break;   
             \}  
         \}  
       
         fclose(fd);  
         soap\_end\_send(soap);  
       
         return SOAP\_OK;  
     \}

[http_gsoap2.sourceforge.net]: http://gsoap2.sourceforge.net/
[http_www.cppblog.com_qiujian5628_archive_2008_10_11_54019.html]: http://www.cppblog.com/qiujian5628/archive/2008/10/11/54019.html
[http_blog.sina.com.cn_s_blog_5ee9235c0100de3g.html]: http://blog.sina.com.cn/s/blog_5ee9235c0100de3g.html