如何将基于回调的 SOAP 方法封装为 Promise 并正确返回结果

1次阅读

如何将基于回调的 SOAP 方法封装为 Promise 并正确返回结果

本文详解如何将不支持 promise 的回调式 SOAP 方法(如 CreateCredential)封装为标准 Promise,解决因未正确链式返回导致的 undefined 问题,并提供 then/catch 与 async/await 两种专业实践方案。

本文详解如何将不支持 promise 的回调式 soap 方法(如 `createcredential`)封装为标准 promise,解决因未正确链式返回导致的 `undefined` 问题,并提供 `then/catch` 与 `async/await` 两种专业实践方案。

在 Node.js 环境中调用基于 SOAP 协议的遗留服务时,常遇到方法仅支持回调(callback)而非 Promise 的情况——例如 soap 库中的 CreateCredential。若直接在 .then() 链中使用回调函数却不显式返回 Promise,整个链会中断,最终 undefined 被传递至外层 .then(),这正是原代码中 result is undefined 的根本原因。

关键在于:所有异步操作必须被统一纳入 Promise 链,并确保每个 .then() 回调都明确 return 下一个 Promise。以下是推荐的封装与调用方式:

✅ 正确封装回调为 Promise

使用 new Promise() 包装原始回调方法,实现标准化 Promise 接口

function createCredentialWithPromise(credentialClient, rpaReservation, rpaResource, rpaReservationDateFormatted, rpaScheduleGrid) {   return new Promise((resolve, reject) => {     credentialClient.CredentialService.CredentialPort.CreateCredential(       {         Credential: {           CredentialHolderReference: holderReference,           CredentialIdentifier: {             Type: {               Name: 'pt:PIN',               FormatType: 'SIMPLE_NUMBER16'             },             Value: rpaReservation.access_code           },           CredentialAccessProfile: {             AccessProfileToken: rpaResource.access_control_identifier,             ValidFrom: `${rpaReservationDateFormatted} ${rpaScheduleGrid.start_hour}:00`,             ValidTo: `${rpaReservationDateFormatted} ${rpaScheduleGrid.end_hour}:00`           }         }       },       (err, result) => {         if (err) {           console.error('SOAP CreateCredential failed:', err);           reject(err);         } else {           resolve(result);         }       },       { auth }     );   }); }

⚠️ 注意:务必在 reject() 中传入错误对象(而非空调用),以便上层可捕获并处理异常;同时建议添加日志便于调试。

✅ 方案一:链式 .then() 写法(兼容性好)

function _callAccessControl(response, rpaReservation) {   if (rpaResource.access_control_identifier && !accessControlExist) {     return soap.createClientAsync('https://ipevia.com/public/files/onvif/credential.wsdl', {       endpoint: 'https://ipevia.com/index.php?OnvifServer',       forceSoap12Headers: true     })       .then(credentialClient =>          createCredentialWithPromise(credentialClient, rpaReservation, rpaResource, rpaReservationDateFormatted, rpaScheduleGrid)       )       .then(result =>          rpaReservation.update({           access_control_identifier: parseInt(result.Token, 10)         })       )       .catch(err => {         console.error('Access control setup failed:', err);         throw err; // 保持错误冒泡,避免静默失败       });   } else {     return Promise.resolve(rpaReservation); // 统一返回 Promise,保证调用方接口一致   } }

✅ 方案二:async/await 写法(更清晰、易维护)

async function _callAccessControl(response, rpaReservation) {   if (rpaResource.access_control_identifier && !accessControlExist) {     try {       const credentialClient = await soap.createClientAsync(         'https://ipevia.com/public/files/onvif/credential.wsdl',         {           endpoint: 'https://ipevia.com/index.php?OnvifServer',           forceSoap12Headers: true         }       );        const result = await createCredentialWithPromise(         credentialClient,         rpaReservation,         rpaResource,         rpaReservationDateFormatted,         rpaScheduleGrid       );        return rpaReservation.update({         access_control_identifier: parseInt(result.Token, 10)       });     } catch (err) {       console.error('Access control setup failed:', err);       throw err;     }   } else {     return rpaReservation;   } }

? 核心原则总结

  • 永远返回 Promise:即使分支逻辑不同(如 else 分支),也应通过 Promise.resolve(value) 保持返回类型统一;
  • 拒绝必须传递错误:reject(err) 而非 reject(),否则无法区分错误类型;
  • 避免混合风格:不在 async 函数中混用 .then() 链(除非必要),优先用 await 提升可读性;
  • 错误边界要明确:.catch() 或 try/catch 不仅用于兜底,更是可观测性与运维的关键环节。

通过以上改造,_callAccessControl(…).then(result => {…}) 将稳定接收到预期的更新后 rpaReservation 实例,彻底规避 undefined 返回陷阱。

text=ZqhQzanResources