gSOAP 源码分析(二)

梦里梦外; 2022-08-14 04:40 256阅读 0赞

gSOAP 源码分析(二)

2012-5-24 邵盛松

一 gSOAP XML介绍

Xml的全称是EXtensible Markup Language。可扩展标记语言。仅仅是一个纯文本。适合用于数据的存储和传输。里面的标签由作者赋予它含义

比如

<Email>

<From>a@domain.com/From>

<To>b@domain.com</To>

<Head>**Hello**</Head>

<Body>**Hello World**</Body>

</Email>

可以赋予这个xml文档含义是 a发送给b一封邮件,邮件标题是“Hello”，正文是“Hello World”

<ns:add>

0.0

</ns:add>

gSOAP赋予**add为一个接口函数的名称，a和b是接口函数参数**

二 命名空间

<?xml version="1.0" encoding="UTF-8"?>

<**SOAP-ENV:Envelope**

xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:ns="urn:calc">

<**SOAP-ENV:Body** SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<ns:add>

0.0

</ns:add>

<**/SOAP-ENV:Body**>

<**/SOAP-ENV:Envelope**>

由于标签是我们自定义的，多个XML文件中可能存在重复命名，但表示的含义却不一样，为了解决XML文档中命名的冲突问题 就出现了命名空间。所以需要加上一个namespace来区分多个xml文件之间相同的标签。

使用语法：xmlns:namespace-prefix="namespaceURI"

**xmlns的意思是XML Namespace**

URI是Uniform Resource Identifier 的缩写，作用是**赋予命名空间一个惟一的名称用来表示URI 一个是URL，一个是****URN**，gSOAP中URL和URN都使用了：xmlns:ns="urn:calc

其中**calc是一个接口文件的文件名**。这句是gsoap定义的默认命名空间有了默认的命名空间，直接是<a>0.0</a>就可以，而不用<ns:a>0.0</ns:a>

关于命名空间的处理代码如下

SOAP\_FMAC1 int SOAP\_FMAC2 soap\_match\_namespace(struct soap\*, const char \*, const char\*, size\_t n1, size\_t n2);

SOAP\_FMAC1 int SOAP\_FMAC2 soap\_set\_namespaces(struct soap\*, const struct Namespace\*);

SOAP\_FMAC1 void SOAP\_FMAC2 soap\_set\_local\_namespaces(struct soap\*);

SOAP\_FMAC1 void SOAP\_FMAC2 soap\_pop\_namespace(struct soap\*);

SOAP\_FMAC1 struct soap\_nlist\* SOAP\_FMAC2 soap\_push\_namespace(struct soap\*, const char \*,const char \*);

SOAP\_FMAC1 const char\* SOAP\_FMAC2 soap\_current\_namespace(struct soap \*soap, const char \*tag);

SOAP\_FMAC1 struct soap\_nlist\* SOAP\_FMAC2 soap\_lookup\_ns(struct soap \*soap, const char \*tag, size\_t n);

三 编码

gSOAP默认使用的是使用UTF-8编码

关于编码的处理函数

SOAP\_FMAC1 int SOAP\_FMAC2 soap\_pututf8(struct soap\*, unsigned long);

SOAP\_FMAC1 soap\_wchar SOAP\_FMAC2 soap\_getutf8(struct soap\*);

SOAP\_FMAC1 int SOAP\_FMAC2 soap\_putbase64(struct soap\*, const unsigned char\*, int);

SOAP\_FMAC1 unsigned char\* SOAP\_FMAC2 soap\_getbase64(struct soap\*, int\*, int);

SOAP\_FMAC1 int SOAP\_FMAC2 soap\_puthex(struct soap\*, const unsigned char\*, int);

SOAP\_FMAC1 unsigned char\* SOAP\_FMAC2 soap\_gethex(struct soap\*, int\*);

XML指令处理（XML PI）

目的是为了给XML解析器提供额外的信息。这里处理XML文件的编码信息 <?xml version="1.0" encoding="UTF-8"?>

gSOAP关于指令处理代码如下

soap\_get\_pi(struct soap \*soap)

\{ char buf\[64\];

/\* This is a quick way to parse XML PI and we could use a callback instead to

\* enable applications to intercept processing instructions \*/

while ((int)c != EOF && c != '?')

\{ if (--i > 0)

\{ if (soap\_blank(c))

c = ' ';

\*s++ = (char)c;

c = soap\_getchar(soap);

\*s = '\\0';

DBGLOG(TEST, SOAP\_MESSAGE(fdebug, "XML PI <?%s?>\\n", buf));

if (!strncmp(buf, "xml ", 4))

\{ s = strstr(buf, " encoding=");

if (s && s\[10\])

\{ if (!soap\_tag\_cmp(s + 11, "iso-8859-1\*")

|| !soap\_tag\_cmp(s + 11, "latin1\*"))

\{ DBGLOG(TEST, SOAP\_MESSAGE(fdebug, "Switching to latin1 encoding\\n"));

soap->mode |= SOAP\_ENC\_LATIN;

else if (!soap\_tag\_cmp(s + 11, "utf-8\*"))

\{ DBGLOG(TEST, SOAP\_MESSAGE(fdebug, "Switching to utf-8 encoding\\n"));

soap->mode &= ~SOAP\_ENC\_LATIN;

if ((int)c != EOF)

c = soap\_getchar(soap);

return c;

四 XML Schema

定义了文档中的元素，属性，数据类型，默认值等

因为WSDL 是一种基于 schema 的语言，所以这个看WDSL文档更清楚

<schema targetNamespace="urn:calc"

xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:ns="urn:calc"

xmlns="http://www.w3.org/2001/XMLSchema"

elementFormDefault="unqualified"

attributeFormDefault="unqualified">

<import namespace="http://schemas.xmlsoap.org/soap/encoding/"/>

</schema>

<message name="addRequest">

<part name="a" type="xsd:double"/>

<part name="b" type="xsd:double"/>

</message>

<message name="addResponse">

<part name="result" type="xsd:double"/>

</message>

定义简易元素的语法：

<part name="xxx" type="yyy"/>

上面示例中a,b,result指的是元素的名称 double是数据类型,xsd:double 表示是XMLSchema

内建的数据类型

elementFormDefault="unqualified"

elementFormDefault这一属性用来指示 XML Schema 处理程序把这个 XML schema 中定义的元素或者类型放到哪个命名空间

Unqualified 表示目标命名空间下的这个属性不需要带命名空间前缀，子元素不必使用命名空间前缀

attributeFormDefault="unqualified"

表示目标命名空间下的这个属性不需要带命名空间前缀.

<import namespace="http://schemas.xmlsoap.org/soap/encoding/"/> 表示需要导入的命名空间

五 xml数据的绑定

soapcalcService.h文件中的接口声明函数

virtual int add(double a, double b, double \*result) SOAP\_PURE\_VIRTUAL;

soapcalcService.cpp文件中的实现函数

int calcService::add(double a, double b, double \*result)

\*result = a + b;

return SOAP\_OK;

Req.Xml文件中 body元素中的内容

<ns:add>

0.0

</ns:add>

res.xml文件中 body元素中的内容

<ns:addResponse>

</ns:addResponse>

WSDL文件中add部分

<message name="addRequest">

<part name="a" type="xsd:double"/>

<part name="b" type="xsd:double"/>

</message>

<message name="addResponse">

<part name="result" type="xsd:double"/>

</message>

存根文件soapStub.h文件中

struct ns\_\_add

public:

double a; /\* required element of type xsd:double \*/

double b; /\* required element of type xsd:double \*/

\};

struct ns\_\_addResponse

public:

double \*result; /\* SOAP 1.2 RPC return element (when namespace qualified) \*//\* optional element of type xsd:double \*/

\};

对比上述各个文件关于add的描述

目的是将数据解析到一个对象中，这些对象可以应用到我们的程序中。不需要编写代码搜索xml节点元素，只需要调用add这个函数，就可以得到double返回值

数据绑定，就是将xml数据转换成C++对象，这个C++对象可以表达出xml的数据块

六 xml数据的传输

soapC.cpp文件中关于add部分

add发送请求部分

soap\_default\_ns\_\_add

soap\_serialize\_ns\_\_add

soap\_out\_ns\_\_add

soap\_in\_ns\_\_add

soap\_put\_ns\_\_add

soap\_get\_ns\_\_add

soap\_instantiate\_ns\_\_add

soap\_copy\_ns\_\_add

add应答部分

soap\_default\_ns\_\_addResponse

soap\_serialize\_ns\_\_addResponse

soap\_out\_ns\_\_addResponse

soap\_in\_ns\_\_addResponse

soap\_put\_ns\_\_addResponse

soap\_get\_ns\_\_addResponse

soap\_instantiate\_ns\_\_addResponse

soap\_copy\_ns\_\_addResponse

每个函数都类似以上格式 一个发送请求的 default,serialize,out，in，put,get,instantiate,copy。

gSOAP 源码分析(二)

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关若依源码分析（二）-登录流程源码分析

相关【containerd 源码分析】containerd cri PodRunSandbox 源码分析之二

相关 RocketMQ源码分析【二】NameServer启动流程源码分析

相关鸿蒙源码分析（二十二）

相关 gSOAP 源码分析(二)

相关 gSOAP 源码分析(一)

相关 openMPM源码分析（二）

相关 ARouter源码分析（二）—— 拦截器源码分析

相关 ArrayList的源码分析(二)

相关深入源码分析SpringIOC（二）