Solidity 教程系列第6篇 - Solidity 结构体与映射。
Solidity 系列完整的文章列表请查看分类-Solidity。
写在前面
Solidity是以太坊智能合约编程语言,阅读本文前,你应该对以太坊、智能合约有所了解,
如果你还不了解,建议你先看以太坊是什么
本文前半部分是参考Solidity官方文档(当前最新版本:0.4.20)进行翻译,后半部分是结合实际合约代码实例说明类型的使用(仅针对专栏订阅用户)。
结构体(Structs)
Solidity提供__struct__ 来定义自定义类型,自定义的类型是引用类型。
我们看看下面的例子:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
| pragma solidity ^0.4.11;
contract CrowdFunding { // 定义一个包含两个成员的新类型 struct Funder { address addr; uint amount; }
struct Campaign { address beneficiary; uint fundingGoal; uint numFunders; uint amount; mapping (uint => Funder) funders; }
uint numCampaigns; mapping (uint => Campaign) campaigns;
function newCampaign(address beneficiary, uint goal) public returns (uint campaignID) { campaignID = numCampaigns++; // campaignID 作为一个变量返回 // 创建一个结构体实例,存储在storage ,放入mapping里 campaigns[campaignID] = Campaign(beneficiary, goal, 0, 0); }
function contribute(uint campaignID) public payable { Campaign storage c = campaigns[campaignID]; // 用mapping对应项创建一个结构体引用 // 也可以用 Funder(msg.sender, msg.value) 来初始化. c.funders[c.numFunders++] = Funder({addr: msg.sender, amount: msg.value}); c.amount += msg.value; }
function checkGoalReached(uint campaignID) public returns (bool reached) { Campaign storage c = campaigns[campaignID]; if (c.amount < c.fundingGoal) return false; uint amount = c.amount; c.amount = 0; c.beneficiary.transfer(amount); return true; } }
|
上面是一个简化版的众筹合约,但它可以让我们理解__structs__ 的基础概念,struct 可以用于映射和数组中作为元素。其本身也可以包含映射和数组等类型。
不能声明一个__struct__ 同时将自身__struct__ 作为成员,这个限制是基于结构体的大小必须是有限的。
但__struct__ 可以作为__mapping__ 的值类型成员。
注意在函数中,将一个__struct__ 赋值给一个局部变量(默认是__storage__ 类型),实际是拷贝的引用,所以修改局部变量值的同时,会影响到原变量。
当然,也可以直接通过访问成员修改值,而不用一定赋值给一个局部变量,如__campaigns[campaignID].amount = 0__
映射(Mappings)
映射类型,一种键值对的映射关系存储结构。定义方式为mapping(_KeyType => _KeyValue)。键类型允许除映射、变长数组、合约、枚举、结构体外的几乎所有类型()。值类型没有任何限制,可以为任何类型包括映射类型。
映射 可以被视作为一个哈希表,所有可能的键会被虚拟化的创建,映射到一个类型的默认值(二进制的全零表示)。在映射表中,并不存储键的数据,仅仅存储它的keccak256哈希值,这个哈希值在查找值时需要用到。
正因为此,映射 是没有长度的,也没有键集合或值集合的概念。
映射类型 ,仅能用来作为状态变量,或在内部函数中作为__storage__ 类型的引用。
可以通过将映射标记为public,来让Solidity创建一个访问器。通过提供一个键值做为参数来访问它,将返回对应的值。
映射的值类型也可以是映射,使用访问器访问时,要提供这个映射值所对应的键,不断重复这个过程。
来看一个例子:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
| pragma solidity ^0.4.0;
contract MappingExample { mapping(address => uint) public balances;
function update(uint newBalance) public { balances[msg.sender] = newBalance; } }
contract MappingUser { function f() public returns (uint) { MappingExample m = new MappingExample(); m.update(100); return m.balances(this); } }
|
注意:
映射并未提供迭代输出的方法,可以自行实现一个这样的数据结构。参考iterable mapping
参考文档
Solidity官方文档