当前位置： 技术文章>> Python 如何使用 SOAP 协议进行通信？

文章标题：Python 如何使用 SOAP 协议进行通信？
  • 文章分类: 后端
  • 8161 阅读

在Python中，使用SOAP（Simple Object Access Protocol）协议进行通信是一种常见的需求，尤其是在与那些遵循SOAP标准的旧系统或企业级服务进行交互时。SOAP是一种基于XML的协议，它定义了在Web服务中交换信息的格式。尽管近年来RESTful API因其轻量级和易用性而日益流行，但SOAP仍因其强大的数据表示能力和安全特性在某些领域占据一席之地。

Python中的SOAP客户端实现

在Python中，有多种库可以帮助你实现SOAP客户端，其中最流行的包括suds（现已不维护，但仍有大量遗留项目使用）、zeep和lxml结合requests库手动构建SOAP请求。这里，我们将重点介绍zeep库，因为它不仅功能强大，而且持续维护，非常适合新项目。

安装Zeep

首先，你需要安装zeep库。你可以通过pip轻松安装：

pip install zeep

使用Zeep创建SOAP客户端

使用zeep创建一个SOAP客户端非常简单。你首先需要知道SOAP服务的WSDL（Web Services Description Language）文件的URL，WSDL文件描述了服务的接口。

from zeep import Client

# WSDL文件的URL
wsdl = 'http://example.com/service?wsdl'

# 创建一个客户端实例
client = Client(wsdl=wsdl)

调用SOAP服务的方法

一旦你有了客户端实例，就可以调用WSDL中定义的方法了。假设WSDL定义了一个名为GetUserInfo的方法，该方法接受一个用户名作为参数并返回用户信息。

# 调用GetUserInfo方法，这里假设它接受一个名为'username'的参数
result = client.service.GetUserInfo(username='john_doe')

# 打印结果
print(result)

处理复杂类型和命名空间

SOAP服务经常涉及复杂的数据类型和命名空间。zeep能够很好地处理这些情况，但你可能需要手动指定命名空间或使用zeep提供的工具来生成或解析复杂类型。

如果WSDL中的方法参数或返回类型是复杂类型，你可能需要首先创建一个该类型的实例，然后将其作为参数传递。zeep允许你通过查看服务的类型定义来创建这些实例。

# 假设GetUserInfo需要一个复杂的UserType作为参数
from zeep import xsd

# 创建一个UserType实例
user_type = client.get_type('ns0:UserType')(
    username='john_doe',
    email='john.doe@example.com',
    # 可能还有其他字段
)

# 调用方法
result = client.service.GetUserInfo(user=user_type)

错误处理

在调用SOAP服务时，处理可能出现的错误是非常重要的。zeep会将SOAP错误转换为Python异常，你可以通过捕获这些异常来优雅地处理错误。

try:
    result = client.service.GetUserInfo(username='non_existent_user')
except Exception as e:
    print(f"An error occurred: {e}")

手动构建SOAP请求（使用lxml和requests）

虽然zeep等库大大简化了SOAP客户端的开发，但在某些情况下，你可能需要更直接地控制SOAP请求的构建过程。这时，你可以使用lxml库来构建XML请求体，并使用requests库来发送HTTP请求。

安装lxml和requests

pip install lxml requests

构建SOAP请求

from lxml import etree
import requests

# SOAP请求模板
soap_template = """
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetUserInfo xmlns="http://example.com/webservice/">
      <username>{username}</username>
    </GetUserInfo>
  </soap:Body>
</soap:Envelope>
"""

# 替换模板中的占位符
username = 'john_doe'
soap_request = soap_template.format(username=username)

# 将字符串转换为XML对象
soap_xml = etree.fromstring(soap_request)

# 构建HTTP请求
headers = {
    'Content-Type': 'text/xml; charset=utf-8',
    'SOAPAction': 'http://example.com/webservice/GetUserInfo'
}
url = 'http://example.com/service'

# 发送请求
response = requests.post(url, data=etree.tostring(soap_xml, pretty_print=True), headers=headers)

# 解析响应
response_xml = etree.fromstring(response.content)
# 这里需要根据实际的XML结构来解析响应内容

注意事项

  • 安全性：当与SOAP服务交互时，请确保遵守所有相关的安全最佳实践，如使用HTTPS、验证SOAP消息的签名和加密等。
  • 兼容性：不同的SOAP服务可能在细节上有所不同，如命名空间的使用、复杂类型的定义等。务必参考服务的WSDL文档和任何可用的开发指南。
  • 性能：SOAP请求通常比RESTful API请求更重，因为它们基于XML。在性能敏感的应用中，请考虑这一点。

结语

在Python中使用SOAP协议进行通信是一个强大的功能，尤其是在需要与企业级服务或旧系统集成时。zeep库提供了一个简单而强大的方式来创建SOAP客户端，而手动构建SOAP请求则提供了更高的灵活性。无论你选择哪种方法，都请确保你充分理解了SOAP协议的工作原理以及你正在与之交互的服务的具体要求。

在探索Python的SOAP通信时，不妨访问我的网站码小课，那里可能有更多关于此主题的深入教程和示例代码，帮助你更好地掌握这项技术。

推荐文章