使用gSOAP开发实例(5) libxml2解析SOAP响应消息

landuochong 发表于 2011-12-21 08:44

转载：http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx 电信provisioning系统中，常常需要与远程服务器实时交换一些数据，以完成用户的请求。由于简单对象访问协议（Simple Object Access Protocol, SOAP）的流行，许多涉及到第三方的应用，我们一般都比较乐意使用SOAP来开发。不过，由于可能涉及到公司的机密，本系列教程的开发实例尽量采用在网上已经公开的Web Service资源。
 
前面四节的教程，分别采用了股票信息和天气预报的例子。而这两个实例有一个共同点，SOAP响应消息的数据结构相对简单，只需要按拟定的次序，事先约定返回数据代表的意义，就能够实现无歧义的沟通。这就使得gSOAP能够以字符串数组的形式，定义返回结果，再加上一个整型变量，指示返回结果的个数。
 
查看一下这两个实例的soapStub.h，可以发现，它们的结果集定义正是这样的：
 

<div class="dp-highlighter"><div class="bar"><div class="tools"><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">view plain</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">copy to clipboard</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">print</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">?</a></div></div><ol class="dp-cpp" start="1"><li class="alt">struct ns1__ArrayOfString  </li><li class="">{  </li><li class="alt">        int __sizestring;       /* sequence of elements <string> */  </li><li class="">        char **string;  /* optional element of type xsd:string */  </li><li class="alt">};  </li></ol></div> 


但是，如果服务端返回的是一个相对复杂的结果集，事情就不那么好办了。例如，一个提供外汇汇率的Web Service，服务端会同时返回日元、瑞郎、英镑、欧元、澳元、加元、港币合计七种货币兑换美元的汇率情报，每种汇率情报又包括货币代码、当前汇率、涨跌幅、买入价、卖出价、时间戳等多个子项。显然，这不是一个线性结构，而是一个树形结构，就不能使用ArrayOfString来表示了。
 
这个案例的End point是：
<a href="http://webservice.webxml.com.cn/WebServices/ExchangeRateWebService.asmx">http://webservice.webxml.com.cn/WebServices/ExchangeRateWebService.asmx</a>
其WSDL是：
<a href="http://webservice.webxml.com.cn/WebServices/ExchangeRateWebService.asmx?wsdl">http://webservice.webxml.com.cn/WebServices/ExchangeRateWebService.asmx?wsdl</a>
 
参考前面四节的内容，快速建立其存根程序，不再累述。
 
<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">我们要实现的API<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">是getExchangeRate<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">，在soapStub.h<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">中搜索，可以发现其返回结果集最终的定义是：

<span style="font-size: 12pt; font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;"><div class="dp-highlighter"><div class="bar"><div class="tools"><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">view plain</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">copy to clipboard</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">print</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">?</a></div></div><ol class="dp-cpp" start="1"><li class="alt">struct _ns1__getExchangeRateResponse_getExchangeRateResult  </li><li class="">{  </li><li class="alt">        char *xsd__schema;      /* required element of type xsd:schema */  </li><li class="">        char *__any;  </li><li class="alt">};  </li></ol></div> 
 
<span style="font-size: 12pt; font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;"><span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">仅仅是两个字符串！于是，最初版本的外汇汇率客户端程序只能这样写：
<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">
<span style="font-size: 12pt; font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;"><span style="font-size: 12pt; font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;"><div class="dp-highlighter"><div class="bar"><div class="tools"><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">view plain</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">copy to clipboard</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">print</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">?</a></div></div><ol class="dp-cpp" start="1"><li class="alt">#include <iconv.h>  </li><li class="">  </li><li class="alt">#include "soapH.h"  </li><li class="">#include "ExchangeRateWebServiceSoap12.nsmap"  </li><li class="alt">  </li><li class="">int conv_charset(const char *dest, const char *src, char *input, size_t ilen, char *output, size_t olen) {  </li><li class="alt">    iconv_t conv = iconv_open(dest, src);  </li><li class="">    if ( conv == (iconv_t) -1 )  </li><li class="alt">        return -1;  </li><li class="">    memset(output, 0, olen);  </li><li class="alt">    if ( iconv(conv, &input, &ilen, &output, &olen) )  </li><li class="">        return -1;  </li><li class="alt">    iconv_close(conv);  </li><li class="">    return 0;  </li><li class="alt">}  </li><li class="">  </li><li class="alt">int main(int argc, char **argv) {  </li><li class="">    if ( argc != 2 && argc != 3 ) {  </li><li class="alt">        printf("Usage: %s type \n", argv);  </li><li class="">        printf("\ttype = A : all rate\n");  </li><li class="alt">        printf("\ttype = B : basic rate\n");  </li><li class="">        printf("\ttype = C : cross rate\n");  </li><li class="alt">        exit(-1);  </li><li class="">    }  </li><li class="alt">  </li><li class="">    struct soap soap;  </li><li class="alt">    soap_init(&soap);  </li><li class="">    // don't set is OK  </li><li class="alt">    //soap_set_mode(&soap, SOAP_C_UTFSTRING);  </li><li class="">  </li><li class="alt">    struct _ns1__getExchangeRate request;  </li><li class="">    struct _ns1__getExchangeRateResponse response;  </li><li class="alt">  </li><li class="">    request.theType = argv;  </li><li class="alt">    char *endpoint = NULL;  </li><li class="">    if ( argc == 3 )  </li><li class="alt">        endpoint = argv;  </li><li class="">    if ( soap_call___ns3__getExchangeRate(&soap, endpoint, NULL, &request, &response) == SOAP_OK ) {  </li><li class="alt">        printf("%s\n", response.getExchangeRateResult->xsd__schema);  </li><li class="">        printf("----------\n");  </li><li class="alt">        int ilen = strlen(response.getExchangeRateResult->__any);  </li><li class="">        int olen = ilen * 2;  </li><li class="alt">        char *output = (char *) malloc(sizeof(char) * olen);  </li><li class="">        conv_charset("GBK", "UTF-8", response.getExchangeRateResult->__any, ilen, output, olen);  </li><li class="alt">        printf("%s\n", output);  </li><li class="">        free(output);  </li><li class="alt">    }  </li><li class="">    else {  </li><li class="alt">        soap_print_fault(&soap, stderr);  </li><li class="">    }  </li><li class="alt">  </li><li class="">    soap_destroy(&soap);  </li><li class="alt">    soap_end(&soap);  </li><li class="">    soap_done(&soap);  </li><li class="alt">    return 0;  </li><li class="">}  </li></ol></div> 
<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">
<span style="font-size: 12pt; font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;"><span style="font-size: 12pt; font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">
其中，xsd__schema没有中文字符，而__any含有中文字符，需要转换成GBK编码，具体可以参考前面两节。
 
<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;">编译执行，输出结果如下图：
 

<span style="font-family: 宋体; mso-ascii-font-family: 'Courier New'; mso-hansi-font-family: 'Courier New'; mso-bidi-font-family: 'Courier New'; mso-ansi-language: EN-US; mso-fareast-language: ZH-CN; mso-bidi-language: AR-SA;"><img src="http://hi.csdn.nethttp://blog.chinaunix.net/attachment/201007/26/0_1280154201f2nH.gif" alt="">
 
可以看出，服务端返回的两个长字符串实际上都是基于XML形式的。gSOAP能够自动帮我们完成的也就到此为止，剩下的需要我们自力更生了。
 
不过，大家也不用头疼，我们还有另外一个利器——libxml2！网上有很多关于libxml2的教程，所以我也不必多说，只要利用其中几个函数和语句即可。
 
1.     xmlParseMemory，字符串转为XML文档
2.     xmlDocGetRootElement，获取XML文档根节点
3.     xmlStrcmp，比较XML字符串，与strcmp差不多
4.     curr = curr->xmlChildrenNode，XML节点指针指向第一个子节点
5.     curr = curr->next，XML节点指针指向下一个兄弟节点
6.     xmlNodeGetContent，获取XML节点的内容
7.     xmlFreeDoc，释放节点，与free差不多
 
最终的外汇汇率客户端程序如下：
 
<div class="dp-highlighter"><div class="bar"><div class="tools"><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">view plain</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">copy to clipboard</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">print</a><a href="http://blog.csdn.net/yui/archive/2010/07/26/5767494.aspx#">?</a></div></div><ol class="dp-cpp" start="1"><li class="alt">#include <iconv.h>  </li><li class="">#include <libxml/parser.h>  </li><li class="alt">#include <libxml/xmlmemory.h>  </li><li class="">  </li><li class="alt">#include "soapH.h"  </li><li class="">#include "ExchangeRateWebServiceSoap12.nsmap"  </li><li class="alt">  </li><li class="">#define FIELD_LEN 16  </li><li class="alt">  </li><li class="">int conv_charset(const char *dest, const char *src, char *input, size_t ilen, char *output, size_t olen) {  </li><li class="alt">    iconv_t conv = iconv_open(dest, src);  </li><li class="">    if ( conv == (iconv_t) -1 )  </li><li class="alt">        return -1;  </li><li class="">    memset(output, 0, olen);  </li><li class="alt">    if ( iconv(conv, &input, &ilen, &output, &olen) )  </li><li class="">        return -1;  </li><li class="alt">    iconv_close(conv);  </li><li class="">    return 0;  </li><li class="alt">}  </li><li class="">  </li><li class="alt">int main(int argc, char **argv) {  </li><li class="">    if ( argc != 2 && argc != 3 ) {  </li><li class="alt">        printf("Usage: %s type \n", argv);  </li><li class="">        printf("\ttype = A : all rate\n");  </li><li class="alt">        printf("\ttype = B : basic rate\n");  </li><li class="">        printf("\ttype = C : cross rate\n");  </li><li class="alt">        exit(-1);  </li><li class="">    }  </li><li class="alt">  </li><li class="">    struct soap soap;  </li><li class="alt">    soap_init(&soap);  </li><li class="">    // don't set is OK  </li><li class="alt">    //soap_set_mode(&soap, SOAP_C_UTFSTRING);  </li><li class="">  </li><li class="alt">    struct _ns1__getExchangeRate request;  </li><li class="">    struct _ns1__getExchangeRateResponse response;  </li><li class="alt">  </li><li class="">    request.theType = argv;  </li><li class="alt">    char *endpoint = NULL;  </li><li class="">    if ( argc == 3 )  </li><li class="alt">        endpoint = argv;  </li><li class="">    if ( soap_call___ns3__getExchangeRate(&soap, endpoint, NULL, &request, &response) == SOAP_OK ) {  </li><li class="alt">        int len = strlen(response.getExchangeRateResult->__any);  </li><li class="">        xmlDocPtr pdoc = xmlParseMemory(response.getExchangeRateResult->__any, len);  </li><li class="alt">        xmlNodePtr root = xmlDocGetRootElement(pdoc);  </li><li class="">        xmlNodePtr curr = root;  </li><li class="alt">        while ( xmlStrcmp(curr->name, (const xmlChar *) "getExchangeRate") )  </li><li class="">            curr = curr->xmlChildrenNode;  </li><li class="alt">        for ( curr = curr->xmlChildrenNode; curr; curr = curr->next ) {  </li><li class="">            xmlNodePtr data;  </li><li class="alt">            for ( data = curr->xmlChildrenNode; data; data = data->next ) {  </li><li class="">                char ifield;  </li><li class="alt">                char ofield;  </li><li class="">                strcpy(ifield, xmlNodeGetContent(data));  </li><li class="alt">                if ( conv_charset("GBK", "UTF-8", ifield, strlen(ifield), ofield, FIELD_LEN) )  </li><li class="">                    printf("%s\t%s\n", data->name, ifield);  </li><li class="alt">                else  </li><li class="">                    printf("%s\t%s\n", data->name, ofield);  </li><li class="alt">            }  </li><li class="">            printf("\n");  </li><li class="alt">        }  </li><li class="">        xmlFreeDoc(pdoc);  </li><li class="alt">    }  </li><li class="">    else {  </li><li class="alt">        soap_print_fault(&soap, stderr);  </li><li class="">    }  </li><li class="alt">  </li><li class="">    soap_destroy(&soap);  </li><li class="alt">    soap_end(&soap);  </li><li class="">    soap_done(&soap);  </li><li class="alt">    return 0;  </li><li class="">}  </li></ol></div> 
 
编译时，需要链接libxml2库，同时指定头文件所在路径：
gcc -O2 -o exchange exchange.c soapC.c soapClient.c ../../stdsoap2.c -I../.. -I/usr/include/libxml2 -L../.. -lgsoap -lxml2
 
执行结果（部分）如下：
 
-bash-3.2$ ./exchange B
Code    JPY
Currency        日元
ClosePrice      87.08
DiffPercent     -0.29%
DiffAmount      -0.25
OpenPrice       87.5
HighPrice       87.71
LowPrice        87.04
Range   0.77%
BuyPrice        87.08
SellPrice       87.12
ChangeColor     Green
DataTime        16:57:54
 
Code
CHF
Currency        瑞郎
ClosePrice      1.0552
DiffPercent     0.16%
DiffAmount      0.0017
OpenPrice       1.054
HighPrice       1.0552
LowPrice        1.0498
Range   0.51%
BuyPrice        1.0552
SellPrice       1.0556
ChangeColor     Red
DataTime        16:57:52

页: [1]

Chinaunix's Archiver

使用gSOAP开发实例(5) libxml2解析SOAP响应消息