应用程序开发 - 应用程序设计元素 - 交易处理程序

交易处理程序允许智能合约开发人员在应用程序与智能合约之间的交互过程中的关键点定义通用处理。交易处理程序是可选的，但如果定义，它们将在调用智能合约中的每个交易之前或之后获得控制。还有一个特定的处理程序，在发出请求以调用未在智能合约中定义的交易时接收控制。

这是 商业票据智能合约示例 的交易处理程序示例：

[图片上传失败...(image-8487f2-1576754636320)]

之前，之后和未知交易处理程序。在此示例中，在发行，购买和赎回交易之前调用 BeforeFunction()。在发行，购买和赎回交易之后调用 AfterFunction()。仅当发出请求以调用智能合约中未定义的交易时才调用 UnknownFunction()。 (通过不为每个交易重复 BeforeFunction 和 AfterFunction 框来简化该图。)

1. 处理程序类型

三种类型的交易处理程序涵盖了应用程序和智能合约之间交互的不同方面：

• Before handler：在每次智能合约交易被调用之前被调用。处理程序通常将修改交易上下文以供交易使用。处理程序可以访问所有的 Fabric API。例如，它可以发出 getState() 和 putState()。
• After handler：在每次智能合约交易被调用后被调用。处理程序通常将执行所有交易通用的后处理，并且还具有对 Fabric API 的完全访问权限。
• Unknown handler：如果尝试调用智能合约中未定义的交易，则会被调用。通常，处理程序将记录故障，以供管理员进行后续处理。处理程序具有对 Fabric API 的完全访问权限。

2. 定义处理程序

交易处理程序将作为具有明确定义名称的方法添加到智能合约中。这是一个添加每种类型的处理程序的示例：

CommercialPaperContract extends Contract {

    ...

    async beforeTransaction(ctx) {
        // Write the transaction ID as an informational to the console
        console.info(ctx.stub.getTxID());
    };

    async afterTransaction(ctx, result) {
        // This handler interacts with the ledger
        ctx.stub.cpList.putState(...);
    };

    async unknownTransaction(ctx) {
        // This handler throws an exception
        throw new Error('Unknown transaction function');
    };

}

交易处理程序定义的形式对于所有处理程序类型都是相似的，但是请注意afterTransaction(ctx，result) 如何也接收交易返回的任何结果。

3. 处理程序处理

将处理程序添加到智能合约后，便可以在交易处理期间将其调用。在处理期间，处理程序接收 ctx (交易上下文)，执行一些处理，并在完成时返回控制。处理继续如下：

• 在处理程序之前 (Before handler)：如果处理程序成功完成，则使用更新的上下文调用交易。如果处理程序引发异常，则不会调用该交易，并且智能合约将失败，并显示异常错误消息。
• 处理程序之后 (After handler)：如果处理程序成功完成，则智能合约将根据调用的交易完成。如果处理程序引发异常，则交易将失败并显示异常错误消息。
• 未知的处理程序 (Unknown handler)：处理程序应通过引发带有所需错误消息的异常来完成。如果未指定 Unknown 处理程序，或者未引发异常，则存在明智的默认处理；智能合约将失败，并显示未知的交易错误消息。

如果处理程序需要访问函数和参数，则很容易做到这一点：

async beforeTransaction(ctx) {
    // Retrieve details of the transaction
    let txnDetails = ctx.stub.getFunctionAndParameters();

    console.info(`Calling function: ${txnDetails.fcn} `);
    console.info(util.format(`Function arguments : %j ${stub.getArgs()} ``);
}

4. 多个处理程序

对于智能合约，最多只能为每种类型定义一个处理程序。如果智能合约需要在处理之前，之后或未知期间调用多个函数，则应在适当的函数内进行协调。

Reference

• Docs » Developing Applications » Application design elements » Transaction handlers, https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/transactionhandler.html
• Docs » Developing Applications » Smart Contract Processing, https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/smartcontract.html

项目源代码

项目源代码会逐步上传到 Github，地址为 https://github.com/windstamp。

Contributor

1. Windstamp, https://github.com/windstamp