智能合约编写之 Solidity 的高级特性

前言

FISCO BCOS 使用了 Solidity 语言进行智能合约开发。Solidity 是一门面向区块链平台设计、图灵完备的编程语言，支持函数调用、修饰器、重载，事件、继承和库等多种高级语言的特性。

本文将介绍 Solidity 的一些高级特性，帮助读者快速入门，编写高质量、可复用的 Solidity 代码。

合理控制函数和变量的类型

基于最少知道原则（Least Knowledge Principle）中经典面向对象编程原则，一个对象应该对其他对象保持最少的了解。优秀的 Solidity 编程实践也应符合这一原则：每个合约都清晰、合理地定义函数的可见性，暴露最少的信息给外部，做好对内部函数可见性的管理。

同时，正确地修饰函数和变量的类型，可给合约内部数据提供不同级别的保护，以防止程序中非预期的操作导致数据产生错误；还能提升代码的可读性与质量，减少误解和 bug；更有利于优化合约执行的成本，提升链上资源的使用效率。

守住函数操作的大门：函数可见性

Solidity 有两种函数调用方式：

• 内部调用：又被称为『消息调用』。常见的有合约内部函数、父合约的函数以及库函数的调用。（例如，假设 A 合约中存在 f 函数，则在 A 合约内部，其他函数调用 f 函数的调用方式为 f()。）

• 外部调用：又被称为『EVM 调用』。一般为跨合约的函数调用。在同一合约内部，也可以产生外部调用。（例如，假设 A 合约中存在 f 函数，则在 B 合约内可通过使用 A.f()调用。在 A 合约内部，可以用 this.f()来调用）。

函数可以被指定为 external ，public ，internal 或者 private 标识符来修饰。

基于以上表格，我们可以得出函数的可见性 public > external > internal > private。

另外，如果函数不使用上述类型标识符，那么默认情况下函数类型为 public。

综上所述，我们可以总结一下以上标识符的不同使用场景：

• public，公有函数，系统默认。通常用于修饰可对外暴露的函数，且该函数可能同时被内部调用。

• external，外部函数，推荐只向外部暴露的函数使用。当函数的某个参数非常大时，如果显式地将函数标记为 external，可以强制将函数存储的位置设置为 calldata，这会节约函数执行时所需存储或计算资源。

• internal，内部函数，推荐所有合约内不对合约外暴露的函数使用，可以避免因权限暴露被攻击的风险。

• private，私有函数，在极少数严格保护合约函数不对合约外部开放且不可被继承的场景下使用。

不过，需要注意的是，无论用何种标识符，即使是 private，整个函数执行的过程和数据是对所有节点可见，其他节点可以验证和重放任意的历史函数。实际上，整个智能合约所有的数据对区块链的参与节点来说都是透明的。

刚接触区块链的用户常会误解，在区块链上可以通过权限控制操作来控制和保护上链数据的隐私。

这是一种错误的观点。事实上，在区块链业务数据未做特殊加密的前提下，区块链同一账本内的所有数据经过共识后落盘到所有节点上，链上数据是全局公开且相同的，智能合约只能控制和保护合约数据的执行权限。

如何正确地选择函数修饰符是合约编程实践中的『必修课』，只有掌握此节真谛方可自如地控制合约函数访问权限，提升合约安全性。

对外暴露最少的必要信息：变量的可见性

与函数一样，对于状态变量，也需要注意可见性修饰符。状态变量的修饰符默认是 internal，不能设置为 external。此外，当状态变量被修饰为 public，编译器会生成一个与该状态变量同名的函数。

具体可参考以下示例：

pragma solidity ^0.4.0;
contract TestContract {    uint public year = 2020;}
contract Caller {    TestContract c = new TestContract();    function f() public {        uint local = c.year();        //expected to be 2020    }}

这个机制有点像 Java 语言里 lombok 库所提供的 @Getter 注解，默认为一个 POJO 类变量生成 get 函数，大大简化了某些合约代码的书写。

同样，变量的可见性也需要被合理地修饰，不该公开的变量果断用 private 修饰，使合约代码更符合『最少知道』的设计原则。

精确地将函数分类：函数的类型

函数可以被声明为 pure、view，两者的作用可见下图。

那么，什么是读取或修改状态呢？简单来说，两个状态就是读取或修改了账本相关的数据。

在 FISCO BCOS 中，读取状态可能是：

• 读取状态变量。

• 访问 block，tx， msg 中任意成员 （除 msg.sig 和 msg.data 之外）。

• 调用任何未标记为 pure 的函数。

• 使用包含某些操作码的内联汇编。

而修改状态可能是：

• 修改状态变量。

• 产生事件。

• 创建其它合约。

• 使用 selfdestruct。

• 调用任何没有标记为 view 或者 pure 的函数。

• 使用底层调用。

• 使用包含特定操作码的内联汇编。

需要注意的是，在某些版本编译器中，并没有对这两个关键字进行强制的语法检查。

推荐尽可能使用 pure 和 view 来声明函数，例如将没有读取或修改任何状态的库函数声明为 pure，这样既提升了代码可读性，也使其更赏心悦目，何乐而不为？

编译时就确定的值：状态常量

所谓的状态常量是指被声明为 constant 的状态变量。

一旦某个状态变量被声明为 constant，那么该变量值只能为编译时确定的值，无法被修改。编译器一般会在编译状态计算出此变量实际值，不会给变量预留储存空间。所以，constant 只支持修饰值类型和字符串。

状态常量一般用于定义含义明确的业务常量值。

面向切片编程：函数修饰器（modifier）

Solidity 提供了强大的改变函数行为的语法：函数修饰器（modifier）。一旦某个函数加上了修饰器，修饰器内定义的代码就可以作为该函数的装饰被执行，类似其他高级语言中装饰器的概念。

这样说起来很抽象，让我们来看一个具体的例子：

pragma solidity ^0.4.11;
contract owned {    function owned() public { owner = msg.sender; }    address owner;
    // 修饰器所修饰的函数体会被插入到特殊符号 _; 的位置。    modifier onlyOwner {        require(msg.sender == owner);        _;    }
    // 使用onlyOwner修饰器所修饰，执行changeOwner函数前需要首先执行onlyOwner"_;"前的语句。    function changeOwner(address _owner) public onlyOwner {        owner = _owner;    }}

如上所示，定义 onlyOwner 修饰器后，在修饰器内，require 语句要求 msg.sender 必须等于 owner。后面的"_;"表示所修饰函数中的代码。

所以，代码实际执行顺序变成了：

• 执行 onlyOwner 修饰器的语句，先执行 require 语句。（执行第 9 行）

• 执行 changeOwner 函数的语句。（执行第 15 行）

由于 changeOwner 函数加上了 onlyOwner 的修饰，故只有当 msg.sender 是 owner 才能成功调用此函数，否则会报错回滚。

同时，修饰器还能传入参数，例如上述的修饰器也可写成：

modifier onlyOwner(address sender) {    require(sender == owner);    _;}
function changeOwner(address _owner) public onlyOwner(msg.sender) {        owner = _owner;}

同一个函数可有多个修饰器，中间以空格间隔，修饰器依次检查执行。此外，修饰器还可以被继承和重写。

由于其所提供的强大功能，修饰器也常被用来实现权限控制、输入检查、日志记录等。

比如，我们可以定义一个跟踪函数执行的修饰器：

event LogStartMethod();event LogEndMethod();
modifier logMethod {    emit LogStartMethod();    _;    emit LogEndMethod();}

这样，任何用 logMethod 修饰器来修饰的函数都可记录其函数执行前后的日志，实现日志环绕效果。如果你已经习惯了使用 Spring 框架的 AOP，也可以试试用 modifier 实现一个简单的 AOP 功能。

modifier 最常见的打开方式是通过提供函数的校验器。在实践中，合约代码的一些检查语句常会被抽象并定义为一个 modifier，如上述例子中的 onlyOwner 就是个最经典的权限校验器。这样一来，连检查的逻辑也能被快速复用，用户也不用再为智能合约里到处都是参数检查或其他校验类代码而苦恼。

可以 debug 的日志：合约里的事件（Event）

介绍完函数和变量，我们来聊聊 Solidity 其中一个较为独有的高级特性——事件机制。

事件允许我们方便地使用 EVM 的日志基础设施，而 Solidity 的事件有以下作用：

• 记录事件定义的参数，存储到区块链交易的日志中，提供廉价的存储。

• 提供一种回调机制，在事件执行成功后，由节点向注册监听的 SDK 发送回调通知，触发回调函数被执行。

• 提供一个过滤器，支持参数的检索和过滤。

事件的使用方法非常简单，两步即可玩转。

第一步，使用关键字『event』来定义一个事件。建议事件的命名以特定前缀开始或以特定后缀结束，这样更便于和函数区分，在本文中我们将统一以『Log』前缀来命名事件。下面，我们用『event』来定义一个函数调用跟踪的事件：

event LogCallTrace(address indexed from, address indexed to, bool result);

事件在合约中可被继承。当他们被调用时，会将参数存储到交易的日志中。这些日志被保存到区块链中，与地址相关联。在上述例子中，用 indexed 标记参数被搜索，否则，这些参数被存储到日志的数据中，无法被搜索。

第二步，在对应的函数内触发定义事件。调用事件的时候，在事件名前加上『emit』关键字：

function f() public {    emit LogCallTrace(msg.sender, this, true);}

这样，当函数体被执行的时候，会触发执行 LogCallTrace。

最后，在 FISCO BCOS 的 Java SDK 中，合约事件推送功能提供了合约事件的异步推送机制，客户端向节点发送注册请求，在请求中携带客户端关注的合约事件参数，节点根据请求参数对请求区块范围的 Event Log 进行过滤，将结果分次推送给客户端。更多细节可以参考合约事件推送功能文档。在 SDK 中，可以根据事件的 indexed 属性，根据特定值进行搜索。

合约事件推送功能文档：https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/sdk/java_sdk.html#id14

不过，日志和事件无法被直接访问，甚至在创建的合约中也无法被直接访问。

但好消息是日志的定义和声明非常利于在『事后』进行追溯和导出。

例如，我们可以在合约的编写中，定义和埋入足够的事件，通过 WeBASE 的数据导出子系统我们可以将所有日志导出到 MySQL 等数据库中。这特别适用于生成对账文件、生成报表、复杂业务的 OLTP 查询等场景。此外，WeBASE 提供了一个专用的代码生成子系统帮助分析具体的业务合约，自动生成相应的代码。

WeBASE 的数据导出子系统：

https://webasedoc.readthedocs.io/zh_CN/latest/docs/WeBASE-Collect-Bee/index.html

代码生成子系统：

https://webasedoc.readthedocs.io/zh_CN/latest/docs/WeBASE-Codegen-Monkey/index.html

在 Solidity 中，事件是一个非常有用的机制，如果说智能合约开发最大的难点是 debug，那善用事件机制可以让你快速制伏 Solidity 开发。

面向对象之重载

重载是指合约具有多个不同参数的同名函数。对于调用者来说，可使用相同函数名来调用功能相同，但参数不同的多个函数。在某些场景下，这种操作可使代码更清晰、易于理解，相信有一定编程经验的读者对此一定深有体会。

下面将展示一个典型的重载语法：

pragma solidity ^0.4.25;
contract Test {    function f(uint _in) public pure returns (uint out) {        out = 1;    }
    function f(uint _in, bytes32 _key) public pure returns (uint out) {        out = 2;    }}

需要注意的是，每个合约只有一个构造函数，这也意味着合约的构造函数是不支持重载的。

我们可以想像一个没有重载的世界，程序员一定绞尽脑汁、想方设法给函数起名，大家的头发可能又要多掉几根。

面向对象之继承

Solidity 使用『is』作为继承关键字。因此，以下这段代码表示的是，合约 B 继承了合约 A：

pragma solidity ^0.4.25;
contract A {}
contract B is A {}

而继承的合约 B 可以访问被继承合约 A 的所有非 private 函数和状态变量。

在 Solidity 中，继承的底层实现原理为：当一个合约从多个合约继承时，在区块链上只有一个合约被创建，所有基类合约的代码被复制到创建的合约中。

相比于 C++或 Java 等语言的继承机制，Solidity 的继承机制有点类似于 Python，支持多重继承机制。因此，Solidity 中可以使用一个合约来继承多个合约。

在某些高级语言中，比如 Java，出于安全性和可靠性的考虑，只支持单重继承，通过使用接口机制来实现多重继承。对于大多数场景而言，单继承的机制就可以满足需求了。

多继承会带来很多复杂的技术问题，例如所谓的『钻石继承』等，建议在实践中尽可能规避复杂的多继承。

继承简化了人们对抽象合约模型的认识和描述，清晰体现了相关合约间的层次结构关系，并且提供软件复用功能。这样，能避免代码和数据冗余，增加程序的重用性。

面向对象之抽象类和接口

根据依赖倒置原则，智能合约应该尽可能地面向接口编程，而不依赖具体实现细节。

Solidity 支持抽象合约和接口的机制。

如果一个合约，存在未实现的方法，那么它就是抽象合约。例如：

pragma solidity ^0.4.25;
contract Vehicle {    //抽象方法    function brand() public returns (bytes32);}

抽象合约无法被成功编译，但可以被继承。

接口使用关键字 interface，上面的抽象也可以被定义为一个接口。

pragma solidity ^0.4.25;
interface Vehicle {    //抽象方法    function brand() public returns (bytes32);}

接口类似于抽象合约，但不能实现任何函数，同时，还有进一步的限制：

• 无法继承其他合约或接口；

• 无法定义构造函数；

• 无法定义变量；

• 无法定义结构体；

• 无法定义枚举。

合适地使用接口或抽象合约有助于增强合约设计的可扩展性。但是，由于区块链 EVM 上计算和存储资源的限制，切忌过度设计，这也是从高级语言技术栈转到 Solidity 开发的老司机常常会陷入的天坑。

避免重复造轮子：库(Library)

在软件开发中，很多经典原则可以提升软件的质量，其中最为经典的就是尽可能复用久经考验、反复打磨、严格测试的高质量代码。此外，复用成熟的库代码还可以提升代码的可读性、可维护性，甚至是可扩展性。

和所有主流语言一样，Solidity 也提供了库（Library）的机制。Solidity 的库有以下基本特点：

• 用户可以像使用合约一样使用关键词 library 来创建合约。

• 库既不能继承也不能被继承。

• 库的 internal 函数对调用者都是可见的。

• 库是无状态的，无法定义状态变量，但是可以访问和修改调用合约所明确提供的状态变量。

接下来，我们来看一个简单的例子，以下是 FISCO BCOS 社区中一个 LibSafeMath 的代码库。我们对此进行了精简，只保留了加法的功能：

pragma solidity ^0.4.25;
library LibSafeMath {  /**  * @dev Adds two numbers, throws on overflow.  */  function add(uint256 a, uint256 b) internal returns (uint256 c) {    c = a + b;    assert(c >= a);    return c;  }}

我们只需在合约中 import 库的文件，然后使用 L.f()的方式来调用函数，（例如 LibSafeMath.add(a,b)）。

接下来，我们编写调用这个库的测试合约，合约内容如下：

pragma solidity ^0.4.25;
import "./LibSafeMath.sol";
contract TestAdd {
  function testAdd(uint256 a, uint256 b) external returns (uint256 c) {    c = LibSafeMath.add(a,b);  }}

在 FISCO BCOS 控制台中，我们可以测试合约的结果（控制台的介绍文章详见FISCO BCOS 控制台详解，飞一般的区块链体验），运行结果如下：

=============================================================================================Welcome to FISCO BCOS console(1.0.8)!Type 'help' or 'h' for help. Type 'quit' or 'q' to quit console. ________ ______  ______   ______   ______       _______   ______   ______   ______|        |      \/      \ /      \ /      \     |       \ /      \ /      \ /      \| $$$$$$$$\$$$$$|  $$$$$$|  $$$$$$|  $$$$$$\    | $$$$$$$|  $$$$$$|  $$$$$$|  $$$$$$\| $$__     | $$ | $$___\$| $$   \$| $$  | $$    | $$__/ $| $$   \$| $$  | $| $$___\$$| $$  \    | $$  \$$    \| $$     | $$  | $$    | $$    $| $$     | $$  | $$\$$    \| $$$$$    | $$  _\$$$$$$| $$   __| $$  | $$    | $$$$$$$| $$   __| $$  | $$_\$$$$$$\| $$      _| $$_|  \__| $| $$__/  | $$__/ $$    | $$__/ $| $$__/  | $$__/ $|  \__| $$| $$     |   $$ \\$$    $$\$$    $$\$$    $$    | $$    $$\$$    $$\$$    $$\$$    $$ \$$      \$$$$$$ \$$$$$$  \$$$$$$  \$$$$$$      \$$$$$$$  \$$$$$$  \$$$$$$  \$$$$$$
=============================================================================================[group:1]> deploy TestAddcontract address: 0xe2af1fd7ecd91eb7e0b16b5c754515b775b25fd2
[group:1]> call TestAdd 0xe2af1fd7ecd91eb7e0b16b5c754515b775b25fd2 testAdd 2000 20transaction hash: 0x136ce66603aa6e7fd9e4750fcf25302b13171abba8c6b2109e6dd28111777d54---------------------------------------------------------------------------------------------Outputfunction: testAdd(uint256,uint256)return type: (uint256)return value: (2020)---------------------------------------------------------------------------------------------
[group:1]>

通过以上示例，我们可清晰了解在 Solidity 中应如何使用库。

类似 Python，在某些场景下，指令『using A for B;』可用于附加库函数（从库 A）到任何类型（B）。这些函数将接收到调用它们的对象作为第一个参数（像 Python 的 self 变量）。这个功能使库的使用更加简单、直观。

例如，我们对代码进行如下简单修改：

pragma solidity ^0.4.25;
import "./LibSafeMath.sol";
contract TestAdd {  // 添加using ... for ... 语句，库 LibSafeMath 中的函数被附加在uint256的类型上  using LibSafeMath for uint256;
  function testAdd(uint256 a, uint256 b) external returns (uint256 c) {        //c = LibSafeMath.add(a,b);        c = a.add(b);        //对象a直接被作为add方法的首个参数传入。  }}

验证一下结果依然是正确的。

=============================================================================================Welcome to FISCO BCOS console(1.0.8)!Type 'help' or 'h' for help. Type 'quit' or 'q' to quit console. ________ ______  ______   ______   ______       _______   ______   ______   ______|        |      \/      \ /      \ /      \     |       \ /      \ /      \ /      \| $$$$$$$$\$$$$$|  $$$$$$|  $$$$$$|  $$$$$$\    | $$$$$$$|  $$$$$$|  $$$$$$|  $$$$$$\| $$__     | $$ | $$___\$| $$   \$| $$  | $$    | $$__/ $| $$   \$| $$  | $| $$___\$$| $$  \    | $$  \$$    \| $$     | $$  | $$    | $$    $| $$     | $$  | $$\$$    \| $$$$$    | $$  _\$$$$$$| $$   __| $$  | $$    | $$$$$$$| $$   __| $$  | $$_\$$$$$$\| $$      _| $$_|  \__| $| $$__/  | $$__/ $$    | $$__/ $| $$__/  | $$__/ $|  \__| $$| $$     |   $$ \\$$    $$\$$    $$\$$    $$    | $$    $$\$$    $$\$$    $$\$$    $$ \$$      \$$$$$$ \$$$$$$  \$$$$$$  \$$$$$$      \$$$$$$$  \$$$$$$  \$$$$$$  \$$$$$$
=============================================================================================[group:1]> deploy TestAddcontract address: 0xf82c19709a9057d8e32c19c23e891b29b708c01a
[group:1]> call TestAdd 0xf82c19709a9057d8e32c19c23e891b29b708c01a testAdd 2000 20transaction hash: 0xcc44a80784404831d8522dde2a8855606924696957503491eb47174c9dbf5793---------------------------------------------------------------------------------------------Outputfunction: testAdd(uint256,uint256)return type: (uint256)return value: (2020)---------------------------------------------------------------------------------------------
[group:1]>

更好地使用 Solidity library 有助于开发者更好地复用代码。除了 Solidity 社区提供的大量开源、高质量的代码库外，FISCO BCOS 社区也计划推出全新的 Solidity 代码库，开放给社区用户，敬请期待。

当然，你也可以自己动手，编写可复用的代码库组件，并分享到社区。

总结

本文介绍了 Solidity 合约编写的若干高级语法特性，旨在抛砖引玉，帮助读者快速沉浸到 Solidity 编程世界。

编写高质量、可复用的 Solidity 代码的诀窍在于：多看社区优秀的代码，多动手实践编码，多总结并不断进化。期待更多朋友在社区里分享 Solidity 的宝贵经验和精彩故事，have fun :)

作者介绍

毛嘉宇，FISCO BCOS 核心开发者。