在现代的 web 开发中,我们经常需要与各种外部服务进行交互。restful api 凭借其简洁和灵活性,成为了主流选择。然而,在许多企业级应用或遗留系统中,soap (simple object access protocol) web service 仍然占据着一席之地。对于开发者而言,直接与 soap 服务打交道常常是一场“噩梦”。
问题:SOAP 集成的痛点
还记得那些年,为了调用一个简单的 SOAP 方法,我们不得不:
这些痛点让 SOAP 集成成为了许多 PHP 开发者的“心头大患”。我们渴望一种更优雅、更高效的方式来处理这些问题。
解决方案:wsdltophp/packagegenerator
立即学习“PHP免费学习笔记(深入)”;
幸运的是,PHP 社区从来不乏优秀的解决方案。
wsdltophp/packagegenerator
它是如何工作的?
wsdltophp/packagegenerator
使用 Composer 快速集成
首先,你需要通过 Composer 将
wsdltophp/packagegenerator
<pre class="brush:php;toolbar:false;">composer require wsdltophp/packagegenerator --dev
安装完成后,你就可以在你的 PHP 代码中调用它来生成 SDK 了。
代码生成示例:
假设我们要为 eBay 的 Web Services 生成一个 PHP SDK。以下是使用
wsdltophp/packagegenerator
<pre class="brush:php;toolbar:false;"><?php
require_once __DIR__ . '/vendor/autoload.php';
use WsdlToPhpPackageGeneratorConfigurationReaderGeneratorOptions;
use WsdlToPhpPackageGeneratorGeneratorGenerator;
try {
// 1. 定义生成选项
// GeneratorOptions::instance() 可以选择传入一个 YAML 配置文件路径,这里我们直接通过方法链设置
$options = GeneratorOptions::instance();
$options
// 设置 WSDL 文件的来源。可以是远程URL或本地文件路径。
->setOrigin('http://developer.ebay.com/webservices/latest/ebaySvc.wsdl')
// 设置生成的 SDK 存放的目标目录
->setDestination('./MyEbaySdk')
// 设置生成的 Composer 包名,用于 SDK 内部的 composer.json
->setComposerName('myproject/my-ebay-sdk')
// 你还可以设置其他高级选项,例如命名空间、类前缀等
// ->setNamespacePrefix('MyProject\EbaySdk\')
// ->setStructsAsClass(true) // 将复杂类型生成为类而不是数组
;
// 2. 实例化代码生成器
$generator = new Generator($options);
// 3. 执行包生成
echo "正在生成 eBay SDK,请稍候...
";
$generator->generatePackage();
echo "eBay SDK 生成成功!请查看 './MyEbaySdk' 目录。
";
} catch (Exception $e) {
echo "SDK 生成失败: " . $e->getMessage() . "
";
}运行这段 PHP 脚本后,你会在项目根目录下看到一个名为
MyEbaySdk
composer.json
src
vendor
standalone
现在,你就可以在你的主项目中引入这个新生成的 SDK,并像操作普通 PHP 对象一样,享受类型安全和 IDE 自动补全带来的便利了!
<pre class="brush:php;toolbar:false;">// 在你的主项目中使用生成的 SDK
// 首先确保你的主项目的 composer.json 已经通过 PSR-4 自动加载了 MyEbaySdk
// 例如: "MyProject\EbaySdk\": "MyEbaySdk/src/"
use MyProjectEbaySdkServiceTypeGet; // 假设有一个 Get 服务
use MyProjectEbaySdkStructTypeGeteBayOfficialTimeRequestType; // 假设有一个请求类型
// 实例化服务类
$service = new Get();
// 构建请求对象
$request = new GeteBayOfficialTimeRequestType();
// $request->setSomeParameter('value'); // 根据 WSDL 定义设置参数
// 调用服务方法
$response = $service->GeteBayOfficialTime($request);
if ($response->isSuccess()) {
echo "成功获取时间: " . $response->getTimestamp() . "
";
} else {
echo "获取时间失败: " . $response->getLastError() . "
";
}除了通过 PHP 代码调用,
wsdltophp/packagegenerator
<pre class="brush:php;toolbar:false;"># 命令行方式 (需先下载并配置 wsdltophp 可执行文件)
wsdltophp generate:package
--urlorpath="http://developer.ebay.com/webservices/latest/ebaySvc.wsdl"
--destination="./MyEbaySdk"
--composer-name="myproject/my-ebay-sdk"
--force
# Docker 方式
docker run --rm -it --volume $PWD:/var/www mikaelcom/wsdltophp:tagname generate:package
--urlorpath="http://developer.ebay.com/webservices/latest/ebaySvc.wsdl"
--destination="/var/www/MyEbaySdk"
--composer-name="myproject/my-ebay-sdk"
--force为什么选择 wsdltophp/packagegenerator
总结
wsdltophp/packagegenerator
以上就是告别SOAP噩梦:如何使用Composer和wsdltophp/packagegenerator快速生成PHPSDK的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号