网络笔记(33) 基于XML的SOAP协议：不要说NBA，请说美国职业篮球联赛

╰半橙微兮° 2022-02-03 06:23 205阅读 0赞

## ONC RPC 存在哪些问题？ ##

ONC RPC 将客户端要发送的参数，以及服务端要发送的回复，都压缩为一个二进制串，这样固然能够解决双方的协议约定问题，但是存在一定的不方便。

首先，**需要双方的压缩格式完全一致**，一点都不能差。一旦有少许的差错，多一位，少一位或者错一位，都可能造成无法解压缩。当然，我们可以用传输层的可靠性以及加入校验值等方式，来减少传输过程中的差错。

其次，**协议修改不灵活**。如果不是传输过程中造成的差错，而是客户端因为业务逻辑的改变，添加或者删除了字段，或者服务端添加或者删除了字段，而双方没有及时通知，或者线上系统没有及时升级，就会造成解压缩不成功。

因而，当业务发生改变，需要多传输一些参数或者少传输一些参数的时候，都需要及时通知对方，并且根据约定好的协议文件重新生成双方的 Stub 程序。自然，这样灵活性比较差。

如果仅仅是沟通的问题也还好解决，其实更难弄的还有**版本的问题**。比如在服务端提供一个服务，参数的格式是版本一的，已经有 50 个客户端在线上调用了。现在有一个客户端有个需求，要加一个字段，怎么办呢？这可是一个大工程，所有的客户端都要适配这个，需要重新写程序，加上这个字段，但是传输值是 0，不需要这个字段的客户端很“冤”，本来没我啥事儿，为啥让我也忙活？

最后，**ONC RPC 的设计明显是面向函数的，而非面向对象**。而当前面向对象的业务逻辑设计与实现方式已经成为主流。

这一切的根源就在于压缩。这就像平时我们爱用缩略语。如果是篮球爱好者，你直接说 NBA，他马上就知道什么意思，但是如果你给一个大妈说 NBA，她可能就不知所云。

所以，这种 RPC 框架只能用于客户端和服务端全由一拨人开发的场景，或者至少客户端和服务端的开发人员要密切沟通，相互合作，有大量的共同语言，才能按照既定的协议顺畅地进行工作。

## XML 与 SOAP ##

但是，一般情况下，我们做一个服务，都是要提供给陌生人用的，你和客户不会经常沟通，也没有什么共同语言。就像你给别人介绍 NBA，你要说美国职业篮球赛，这样不管他是干啥的，都能听得懂。

放到我们的场景中，对应的就是用**文本类**的方式进行传输。无论哪个客户端获得这个文本，都能够知道它的意义。

一种常见的文本类格式是 XML。我们这里举个例子来看。

> <?xml version="1.0" encoding="UTF-8"?>
> 
> <geek:purchaseOrder xmlns:xsi=“[http://www.w3.org/2001/XMLSchema-instance][http_www.w3.org_2001_XMLSchema-instance]” xmlns:geek=“[http://www.example.com/geek][http_www.example.com_geek]”>  
>   
> 2018-07-01  
> 趣谈网络协议  
> 刘超  
> 68  
>   
> </geek:purchaseOrder>

我这里不准备详细讲述 XML 的语法规则，但是你相信我，看完下面的内容，即便你没有学过 XML，也能一看就懂，这段 XML 描述的是什么，不像全面的二进制，你看到的都是 010101，不知所云。

有了这个，刚才我们说的那几个问题就都不是问题了。

首先，**格式没必要完全一致**。比如如果我们把 price 和 author 换个位置，并不影响客户端和服务端解析这个文本，也根本不会误会，说这个作者的名字叫 68。

如果有的客户端想增加一个字段，例如添加一个推荐人字段，只需要在上面的文件中加一行：

对于不需要这个字段的客户端，只要不解析这一行就是了。只要用简单的处理，就不会出现错误。

另外，这种表述方式显然是描述一个订单对象的，是一种面向对象的、更加接近用户场景的表示方式。

既然 XML 这么好，接下来我们来看看怎么把它用在 RPC 中。

### 传输协议问题 ###

我们先解决第一个，传输协议的问题。

基于 XML 的最著名的通信协议就是**SOAP**了，全称**简单对象访问协议**（Simple Object Access Protocol）。它使用 XML 编写简单的请求和回复消息，并用 HTTP 协议进行传输。

SOAP 将请求和回复放在一个信封里面，就像传递一个邮件一样。信封里面的信分**抬头**和**正文**。

> <?xml version="1.0"?>
> 
> <soap:Envelope xmlns:soap=“[http://www.w3.org/2001/12/soap-envelope][http_www.w3.org_2001_12_soap-envelope]”  
> soap:encodingStyle=“[http://www.w3.org/2001/12/soap-encoding][http_www.w3.org_2001_12_soap-encoding]”>  
> soap:Header  
> <m:Trans xmlns:m=“[http://www.w3schools.com/transaction/][http_www.w3schools.com_transaction]”  
> soap:mustUnderstand=“1”>1234  
> </m:Trans>  
> </soap:Header>  
> <soap:Body xmlns:m=“[http://www.geektime.com/perchaseOrder][http_www.geektime.com_perchaseOrder]”>  
> <m:purchaseOrder">  
>   
> 2018-07-01  
> 趣谈网络协议  
> 刘超  
> 68  
>   
> </m:purchaseOrder>  
> </soap:Body>  
> </soap:Envelope>

HTTP 协议我们学过，这个请求使用 POST 方法，发送一个格式为 application/soap + xml 的 XML 正文给 [www.geektime.com][]，从而下一个单，这个订单封装在 SOAP 的信封里面，并且表明这是一笔交易（transaction），而且订单的详情都已经写明了。

### 协议约定问题 ###

接下来我们解决第二个问题，就是双方的协议约定是什么样的？

因为服务开发出来是给陌生人用的，就像上面下单的那个 XML 文件，对于客户端来说，它如何知道应该拼装成上面的格式呢？这就需要对于服务进行描述，因为调用的人不认识你，所以没办法找到你，问你的服务应该如何调用。

当然你可以写文档，然后放在官方网站上，但是你的文档不一定更新得那么及时，而且你也写的文档也不一定那么严谨，所以常常会有调试不成功的情况。因而，我们需要一种相对比较严谨的**Web 服务描述语言**，**WSDL**（Web Service Description Languages）。它也是一个 XML 文件。

在这个文件中，要定义一个类型 order，与上面的 XML 对应起来。

> wsdl:types  
> <xsd:schema targetNamespace=“[http://www.example.org/geektime][http_www.example.org_geektime]”>  
> <xsd:complexType name=“order”>  
> <xsd:element name=“date” type=“xsd:string”></xsd:element>  
> <xsd:element name=“className” type=“xsd:string”></xsd:element>  
> <xsd:element name=“Author” type=“xsd:string”></xsd:element>  
> <xsd:element name=“price” type=“xsd:int”></xsd:element>  
> </xsd:complexType>  
> </xsd:schema>  
> </wsdl:types>

接下来，需要定义一个 message 的结构。

> <wsdl:message name=“purchase”>  
> <wsdl:part name=“purchaseOrder” element=“tns:order”></wsdl:part>  
> </wsdl:message>

> <wsdl:portType name=“PurchaseOrderService”>  
> <wsdl:operation name=“purchase”>  
> <wsdl:input message=“tns:purchase”></wsdl:input>  
> <wsdl:output message="…"></wsdl:output>  
> </wsdl:operation>  
> </wsdl:portType>

接下来，应该暴露一个端口。

> <wsdl:binding name=“purchaseOrderServiceSOAP” type=“tns:PurchaseOrderService”>  
> <soap:binding style=“rpc”  
> transport=“[http://schemas.xmlsoap.org/soap/http][http_schemas.xmlsoap.org_soap_http]” />  
> <wsdl:operation name=“purchase”>  
> wsdl:input  
> <soap:body use=“literal” />  
> </wsdl:input>  
> wsdl:output  
> <soap:body use=“literal” />  
> </wsdl:output>  
> </wsdl:operation>  
> </wsdl:binding>

然后，我们来编写一个 binding，将上面定义的信息绑定到 SOAP 请求的 body 里面。

最后，我们需要编写 service。

> <wsdl:service name=“PurchaseOrderServiceImplService”>  
> <wsdl:port binding=“tns:purchaseOrderServiceSOAP” name=“PurchaseOrderServiceImplPort”>  
> <soap:address location=“[http://www.geektime.com:8080/purchaseOrder][http_www.geektime.com_8080_purchaseOrder]” />  
> </wsdl:port>  
> </wsdl:service>

对于某个服务，哪怕是一个陌生人，都可以通过在服务地址后面加上“?wsdl”来获取到这个文件，但是这个文件还是比较复杂，比较难以看懂。不过好在也有工具可以根据 WSDL 生成客户端 Stub，让客户端通过 Stub 进行远程调用，就跟调用本地的方法一样。WSDL 还是有些复杂的，不过好在有工具可以生成。

### 服务发现问题 ###

最后解决第三个问题，服务发现问题。

这里有一个**UDDI**（Universal Description, Discovery, and Integration），也即**统一描述、发现和集成协议**。它其实是一个注册中心，服务提供方可以将上面的 WSDL 描述文件，发布到这个注册中心，注册完毕后，服务使用方可以查找到服务的描述，封装为本地的客户端进行调用。

## 小结 ##

好了，这一节就到这里了，我们来总结一下。

*  原来的二进制 RPC 有很多缺点，格式要求严格，修改过于复杂，不面向对象，于是产生了基于文本的调用方式——基于 XML 的 SOAP。
 *  SOAP 有三大要素：协议约定用 WSDL、传输协议用 HTTP、服务发现用 UDDL。

来源:

1.  刘超-趣谈网络协议系列课；

[http_www.w3.org_2001_XMLSchema-instance]: http://www.w3.org/2001/XMLSchema-instance
[http_www.example.com_geek]: http://www.example.com/geek
[http_www.w3.org_2001_12_soap-envelope]: http://www.w3.org/2001/12/soap-envelope
[http_www.w3.org_2001_12_soap-encoding]: http://www.w3.org/2001/12/soap-encoding
[http_www.w3schools.com_transaction]: http://www.w3schools.com/transaction/
[http_www.geektime.com_perchaseOrder]: http://www.geektime.com/perchaseOrder
[www.geektime.com]: http://www.geektime.com/
[http_www.example.org_geektime]: http://www.example.org/geektime
[http_schemas.xmlsoap.org_soap_http]: http://schemas.xmlsoap.org/soap/http
[http_www.geektime.com_8080_purchaseOrder]: http://www.geektime.com:8080/purchaseOrder