Hyperledger Composer中JS事务内调用Webservice API可行性及示例咨询

当然可行啦！作为Hyperledger Composer的初学者，你完全可以在JavaScript事务处理器里调用外部Webservice API，实现JSON格式的请求和响应交互——这在很多实际场景里都非常实用，比如和外部系统做数据同步、校验第三方数据之类的。

下面给你一套完整的示例流程和代码，帮你快速上手：

一、准备工作 #

• 确保你的Hyperledger Composer开发环境已经搭建完成，事务处理器的项目结构（包含.cto模型文件、lib逻辑目录等）完整
• 因为要发起HTTP请求，我们需要用到request这个常用的HTTP库（也可以用axios，不过request在Composer环境里兼容性不错），记得先在事务处理器目录下执行安装命令：

  npm install request --save
  

• 重要提醒：事务处理器是运行在区块链节点上的，所以要保证节点服务器能访问到你要调用的Webservice地址（网络打通、没有防火墙限制）

二、定义事务与资产模型（.cto文件） #

首先在你的模型文件（比如models/basic.cto）里，定义一个用来触发API调用的事务，以及对应的资产：

namespace org.example.basic

// 触发外部API调用的事务
transaction CallExternalAPI {
  --> Person targetPerson  // 关联要处理的Person资产
}

// 示例资产：Person
asset Person identified by personId {
  o String personId
  o String firstname
  o String lastname
  o String gender
}

三、编写JavaScript事务处理器逻辑 #

在lib/logic.js文件里，编写处理事务的代码，实现JSON请求发送和响应处理：

'use strict';

const { TransactionHandler } = require('composer-sdk');
const request = require('request');

class CallExternalAPIHandler extends TransactionHandler {
    constructor() {
        // 指定处理的命名空间
        super('org.example.basic');
    }

    async transactionHandler(transaction) {
        try {
            // 1. 构造你要发送的JSON请求体（和你给出的示例格式一致）
            const requestBody = [
                {
                    "firstname": transaction.targetPerson.firstname,
                    "lastname": transaction.targetPerson.lastname,
                    "gender": transaction.targetPerson.gender
                }
            ];

            // 2. 配置API请求参数
            const apiOptions = {
                method: 'POST', // 根据你的API需求选择GET/POST等
                url: 'https://your-webservice-url.com/api/process', // 替换成你的实际API地址
                headers: {
                    'Content-Type': 'application/json',
                    // 如果API需要认证，这里可以加Authorization头，比如：
                    // 'Authorization': 'Bearer your-token-here'
                },
                body: JSON.stringify(requestBody)
            };

            // 3. 发送请求并处理响应
            const responseBody = await new Promise((resolve, reject) => {
                request(apiOptions, (error, response, body) => {
                    if (error) {
                        console.error('API调用失败:', error);
                        reject(new Error(`API调用出错: ${error.message}`));
                        return;
                    }
                    // 检查HTTP响应状态码
                    if (response.statusCode < 200 || response.statusCode >= 300) {
                        reject(new Error(`API返回错误状态码: ${response.statusCode}`));
                        return;
                    }
                    resolve(body);
                });
            });

            // 4. 解析JSON响应并做后续处理（比如更新区块链上的资产）
            const responseData = JSON.parse(responseBody);
            console.log('API返回的响应数据:', responseData);

            // 示例：根据响应更新Person资产的字段（假设API返回了更新后的firstname）
            if (responseData[0] && responseData[0].updatedFirstname) {
                transaction.targetPerson.firstname = responseData[0].updatedFirstname;
                // 获取资产注册表并更新资产
                const personRegistry = await this.registryFactory.getAssetRegistry('org.example.basic.Person');
                await personRegistry.update(transaction.targetPerson);
            }

            return '外部API调用成功，已完成资产更新';
        } catch (error) {
            console.error('事务处理出错:', error);
            throw error; // 抛出错误会导致事务回滚
        }
    }
}

module.exports = CallExternalAPIHandler;

四、关键注意事项 #

• 异步处理：API调用是异步操作，一定要用Promise或者async/await来处理，保证事务能等待API响应完成后再继续执行
• 错误处理：务必捕获API调用可能出现的各种错误（网络问题、状态码错误、JSON解析失败等），否则会导致整个事务失败回滚
• 性能与可靠性：如果API响应较慢，可能会影响事务的处理时间，建议选择性能稳定的Webservice，或者考虑异步回调的方式（不过Composer事务通常需要同步完成）
• 安全问题：如果API需要敏感信息（比如密钥），不要硬编码在代码里，建议通过环境变量或者Composer的配置机制来管理

内容的提问来源于stack exchange，提问作者peterDalis. st