智能合约编写之 Solidity 的基础特性
目前大部分的联盟链平台,包括 FISCO BCOS,都采用 Solidity 作为智能合约开发语言,因此熟悉并上手 Solidity 十分必要。
作为一门面向区块链平台设计的图灵完备的编程语言,Solidity 支持函数调用、修饰符、重载、事件、继承等多种特性,在区块链社区中,拥有广泛的影响力和踊跃的社区支持。但对于刚接触区块链的人而言,Solidity 是一门陌生的语言。
智能合约编写阶段将从 Solidity 基础特性、高级特性、设计模式以及编程攻略分别展开,带读者认识 Solidity 并掌握其运用,更好地进行智能合约开发。
本篇将围绕 Solidity 的基础特性,带大家上手开发一个最基本的智能合约。
智能合约代码结构
任何编程语言都有其规范的代码结构,用于表达在一个代码文件中如何组织和编写代码,Solidity 也一样。
本节,我们将通过一个简单的合约示例,来了解智能合约的代码结构。
复制代码
pragma solidity ^0.4.25; contract Sample{ //State variables addressprivate_admin; uintprivate_state; //Modifier modifieronlyAdmin(){ require(msg.sender == _admin,"You are not admin"); _; } //Events eventSetState(uintvalue); //Constructor constructor()public{ _admin = msg.sender; } //Functions functionsetState(uintvalue)publiconlyAdmin{ _state =value; emitSetState(value); } functiongetValue()publicviewreturns(uint){ return_state; } }
上面这段程序包括了以下功能:
- 通过构造函数来部署合约
- 通过 setValue 函数设置合约状态
- 通过 getValue 函数查询合约状态
整个合约主要分为以下几个构成部分:
- 状态变量 – _admin, _state,这些变量会被永久保存,也可以被函数修改
- 构造函数 – 用于部署并初始化合约
- 事件 – SetState, 功能类似日志,记录了一个事件的发生
- 修饰符 – onlyAdmin, 用于给函数加一层 ” 外衣 ”
- 函数 – setState, getState,用于读写状态变量
下面将逐一介绍上述构成部分。
状态变量
状态变量是合约的骨髓,它记录了合约的业务信息。用户可以通过函数来修改这些状态变量,这些修改也会被包含到交易中;交易经过区块链网络确认后,修改即为生效。
复制代码
uintprivate_state;
状态变量的声明方式为:[类型] [访问修饰符 – 可选] [字段名]
构造函数
构造函数用于初始化合约,它允许用户传入一些基本的数据,写入到状态变量中。
在上述例子中,设置了 _admin 字段,作为后面演示其他功能的前提。
复制代码
constructor()public{ _admin = msg.sender; }
和 java 不同的是,构造函数不支持重载,只能指定一个构造函数。
函数
函数被用来读写状态变量。对变量的修改将会被包含在交易中,经区块链网络确认后才生效。生效后,修改会被永久的保存在区块链账本中。
函数签名定义了函数名、输入输出参数、访问修饰符、自定义修饰符。
复制代码
functionsetState(uintvalue)publiconlyAdmin;
函数还可以返回多个返回值:
复制代码
functionfunctionSample()publicviewreturns(uint, uint){ return(1,2); }
在本合约中,还有一个配备了 view 修饰符的函数。这个 view 表示了该函数不会修改任何状态变量。
与 view 类似的还有修饰符 pure,其表明该函数是纯函数,连状态变量都不用读,函数的运行仅仅依赖于参数。
复制代码
functionadd(uinta,uintb)publicpurereturns(uint){ returna+b; }
如果在 view 函数中尝试修改状态变量,或者在 pure 函数中访问状态变量,编译器均会报错。
事件
事件类似于日志,会被记录到区块链中,客户端可以通过 web3 订阅这些事件。
定义事件
复制代码
eventSetState(uintvalue);
构造事件
复制代码
emitSetState(value);
这里有几点需要注意:
- 事件的名称可以任意指定,不一定要和函数名挂钩,但推荐两者挂钩,以便清晰地表达发生的事情.
- 构造事件时,也可不写 emit,但因为事件和函数无论是名称还是参数都高度相关,这样操作很容易笔误将事件写成函数调用,因此不推荐。
复制代码
functionsetState(uintvalue)publiconlyAdmin{ _state =value; //emit SetState(value); // 这样写也可以,但不推荐,因为很容易笔误写成 setState SetState(value); }
- Solidity 编程风格应采用一定的规范。关于编程风格,建议参考 https://learnblockchain.cn/docs/solidity/style-guide.html#id16
修饰符
修饰符是合约中非常重要的一环。它挂在函数声明上,为函数提供一些额外的功能,例如检查、清理等工作。
在本例中,修饰符 onlyAdmin 要求函数调用前,需要先检测函数的调用者是否为函数部署时设定的那个管理员 (即合约的部署人)。
复制代码
//Modifer modifieronlyAdmin(){ require(msg.sender == _admin,"You are not admin"); _; } ... //Functions functionsetState(uintvalue)publiconlyAdmin{ ... }
值得注意的是,定义在修饰符中的下划线“_”,表示函数的调用,指代的是开发者用修饰符修饰的函数。在本例中,表达的是 setState 函数调用的意思。
智能合约的运行
了解了上述的智能合约示例的结构,就可以直接上手运行,运行合约的方式有多种,大家可以任意采取其中一种:
- 方法一:可以使用 FISCO BCOS 控制台的方式来部署合约,具体请参考
- https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/installation.html#id7
- 方法二:使用 FISCO BCOS 开源项目 WeBASE 提供的在线 ide WEBASE-front 运行
- 方法三:通过在线 ide remix 来进行合约的部署与运行, remix 的地址为 http://remix.ethereum.org/
本例中使用 remix 作为运行示例。
编译
首先,在 remix 的文件 ide 中键入代码后,通过编译按钮来编译。成功后会在按钮上出现一个绿色对勾:
部署
编译成功后就可进行部署环节,部署成功后会出现合约实例。
setState
合约部署后,我们来调用 setState(4)。在执行成功后,会产生一条交易收据,里面包含了交易的执行信息。
在这里,用户可以看到交易执行状态 (status)、交易执行人 (from)、交易输入输出 (decoded input, decoded output)、交易开销 (execution cost) 以及交易日志 (logs)。
在 logs 中,我们看到 SetState 事件被抛出,里面的参数也记录了事件传入的值 4。
如果我们换一个账户来执行,那么调用会失败,因为 onlyAdmin 修饰符会阻止用户调用。
getState
调用 getState 后,可以直接看到所得到的值为 4,正好是我们先前 setState 所传入的值:
Solidity 数据类型
在前文的示例中,我们用到了 uint 等数据类型。由于 Solidity 类型设计比较特殊,这里也会简单介绍一下 Solidity 的数据类型。
整型系列
Solidity 提供了一组数据类型来表示整数, 包含无符号整数与有符号整数。每类整数还可根据长度细分,具体细分类型如下。
定长 bytes 系列
Solidity 提供了 bytes1 到 bytes32 的类型,它们是固定长度的字节数组。
用户可以读取定长 bytes 的内容。
复制代码
functionbytesSample()public{ bytes32barray; //Initializebaarray //readbrray[0] byteb=barray[0]; }
并且,可以将整数类型转换为 bytes。
复制代码
uint256s =1; bytes32b=bytes32(s);
这里有一个关键细节,Solidity 采取大端序编码,高地址存的是整数的小端。例如,b[0] 是低地址端,它存整数的高端,所以值为 0;取 b[31] 才是 1。
复制代码
functionbytesSample()public pure returns(byte,byte){ uint256 value =1; bytes32b=bytes32(value); //Shouldbe(0,1) return (b[0],b[31]); }
变长 bytes
从上文中,读者可了解定长 byte 数组。此外,Solidity 还提供了一个变长 byte 数组:bytes。使用方式类似数组,后文会有介绍。
string
Solidity 提供的 string,本质是一串经 UTF-8 编码的字节数组,它兼容于变长 bytes 类型。
目前 Solidity 对 string 的支持不佳,也没有字符的概念。用户可以将 string 转成 bytes。
复制代码
functionstringSample()public view returns(bytes){ stringmemorystr="abc"; bytesmemoryb=bytes(str); //0x616263 returnb; }
要注意的是,当将 string 转换成 bytes 时,数据内容本身不会被拷贝,如上文中,str 和 b 变量指向的都是同一个字符串 abc。
address
address 表示账户地址,它由私钥间接生成,是一个 20 字节的数据。同样,它也可以被转换为 bytes20。
复制代码
function addressSample() public view returns(bytes20){ addressme = msg.sender; bytes20 b = bytes20(me); return b; }
mapping
mapping 表示映射, 是极其重要的数据结构。它与 java 中的映射存在如下几点差别:
- 它无法迭代 keys,因为它只保存键的哈希,而不保存键值,如果想迭代,可以用开源的可迭代哈希类库
- 如果一个 key 未被保存在 mapping 中,一样可以正常读取到对应 value,只是 value 是空值(字节全为 0)。所以它也不需要 put、get 等操作,用户直接去操作它即可。
复制代码
contract Sample{ mapping(uint=>string) privatevalues; functionmappingSample()publicviewreturns(bytes20){ //put a keyvaluepair values[10] = "hello"; //readvalue stringvalue=values[10]; } }
数组
如果数组是状态变量,那么支持 push 等操作:
复制代码
contract Sample{ string[]privatearr; functionarraySample()publicview{ arr.push("Hello"); uintlen = arr.length;//should be 1 stringvalue= arr[0];//should be Hello } }
数组也可以以局部变量的方式使用,但稍有不同:
复制代码
function arraySample()publicview returns(uint){ //create an emptyarrayof length 2 uint] memory p =newuint[; p[3] = 1;//THIS WILL THROW EXCEPTION returnp.length; }
struct
Solidity 允许开发者自定义结构对象。结构体既可以作为状态变量存储,也可以在函数中作为局部变量存在。
复制代码
structPerson{ uintage; stringname; } Personprivate _person; functionstructExample() { Personmemory p = Person(1,"alice"); _person= p; }
本节中只介绍了比较常见的数据类型,更完整的列表可参考 Solidity 官方网站:
全局变量
示例合约代码的构造函数中,包含 msg.sender。它属于全局变量。在智能合约中,全局变量或全局方法可用于获取和当前区块、交易相关的一些基本信息,如块高、块时间、合约调用者等。
比较常用的全局变量是 msg 变量,表示调用上下文,常见的全局变量有以下几种:
- msg.sender:合约的直接调用者。
- 由于是直接调用者,所以当处于 用户 A-> 合约 1-> 合约 2 调用链下,若在合约 2 内使用 msg.sender,得到的会是合约 1 的地址。如果想获取用户 A,可以用 tx.origin.
- tx.origin:交易的 ” 始作俑者 “,整个调用链的起点。
- msg.calldata:包含完整的调用信息,包括函数标识、参数等。calldata 的前 4 字节就是函数标识,与 msg.sig 相同。
- msg.sig:msg.calldata 的前 4 字节,用于标识函数。
- block.number:表示当前所在的区块高度。
- now:表示当前的时间戳。也可以用 block.timestamp 表示。
这里只列出了部分常见全局变量,完整版本请参考:
https://solidity.readthedocs.io/en/v0.4.24/units-and-global-variables.html 。
结语
本文以一个简单的示例合约作为引入,介绍了运用 Solidity 开发智能合约的基本知识。读者可以尝试运行该合约,感受智能合约的开发。
若想更深入学习智能合约示例,推荐官方网站示例供读者学习,也可关注本专题后续系列文章:
https://solidity.readthedocs.io/en/v0.6.2/solidity-by-example.html 。
在官网的示例中,提供了投票、竞拍、微支付通道等多个案例,这些案例贴近实际生活,是很好的学习资料。
关于作者
储雨知,FISCO BCOS 核心开发者。