EOS的数据持久性(上)

本教程假定你已经完成了EOS开发从智能合约开始

要了解数据持久性,请编写一个简单的智能合约,作为地址记录。虽然这个用例由于各种原因而不太适合作为生产智能合约,但开始学习数据持久性如何在EOSIO上运行而不被与eosio的multi_index功能无关的业务逻辑分心,这也算的上一个很好的合约。

第1步:创建一个新目录

之前,你创建了一个合约目录,现在就在那里开始。

1
2
//shell
cd CONTRACTS_DIR

为我们的合约创建一个新目录并进入目录:

1
2
3
//c++
mkdir addressbook
cd addressbook

第2步:创建并打开一个新文件

1
2
//c++
touch addressbook.cpp

在你喜欢的编辑器中打开文件。

第3步:编写扩展标准类并包含EOSIO

在之前的教程中,你创建了一个hello world合约,并学习了基础知识。你将熟悉下面的结构,该类已分别命名为addressbook

1
2
3
4
5
6
7
8
9
10
11
12
//c++

#include <eosiolib/eosio.hpp>
#include <eosiolib/print.hpp>
using namespace eosio;

class addressbook : public eosio::contract {
public:

private:

};

第4步:为表创建数据结构

在配置和实例化表之前,需要编写表示地址簿数据结构的结构。 将此视为“schema”。 由于它是一个地址簿,该表将包含人,因此创建一个名为“person”的struct

1
2
//c++
struct person {};

定义multi_index表的模式时,需要使用唯一值作为主键。

对于此合约,请使用类型为account_name的名为“key”的字段。此合约将为每个用户提供一个唯一条目,因此该密钥将是基于用户的account_name保证一致性且有唯一值。

1
2
3
4
//c++
struct person {
account_name key;
};

由于该合约是地址簿,因此可能应该为每个条目或人员存储一些相关的详细信息。

1
2
3
4
5
6
7
8
9
//c++
struct person {
account_name key;
string first_name;
string last_name;
string street;
string city;
string state;
};

ok。基本schema架构现已完成。接下来,定义一个primary_key方法,该方法将由multi_index迭代器使用。每个multi_index架构都需要一个主键。要实现此目的,只需创建一个名为primary_key()的方法,并返回一个值,在本例中为结构中定义的成员key

1
2
3
4
5
6
7
8
9
10
11
//c++
struct person {
account_name key;
string first_name;
string last_name;
string street;
string city;
string state;

uint64_t primary_key() const { return key; }
};

步骤5:配置多索引表

现在已经使用结构定义了表的模式,我们需要配置表。需要对eosio::multi_index构造函数进行命名和配置,以使用我们之前定义的结构。

1
2
//c++
typedef eosio::multi_index<N(people), person> address_index;
  • 我们把N(N(base32 X),用于从X的base32编码的字符串解释生成编译时uint64_t)命名为表。该表包含许多不同的个体“persons”,因此将表命名为“people”。
  • 传入上一步中定义的单person结构
  • 声明此表的类型。此类型将用于稍后实例化此表。
1
2
3
//c++
//configure the table
typedef eosio::multi_index<N(people), person> address_index;

使用上述multi_index配置,有一个名为peoplemulti_index表,该表基于使用struct person的该表的单个行的模式或数据结构。

到目前为止,我们的文件应该是这样的。

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
//c++

#include <eosiolib/eosio.hpp>
#include <eosiolib/print.hpp>

using namespace eosio;

class addressbook : public eosio::contract {

public:

private:
struct [[eosio::table]] person {
account_name key;
std::string first_name;
std::string last_name;
std::string street;
std::string city;
std::string state;

uint64_t primary_key() const { return key; }
};

typedef eosio::multi_index<N(people), person> address_index;

};

第6步:构造函数

使用C++类时,你应该创建的第一个公共方法是构造函数。

我们的构造函数将负责最初设置合约。

EOSIO合约扩展了合约类。使用合约范围初始化我们的父合约类。我们的构造函数传递的范围参数是正在部署合约的区块链上的帐户。

1
2
//c++
addressbook(account_name self): contract(self){}

第7步:向表中添加记录

以前,多索引表的主键被定义为强制执行此合约将仅为每个用户存储一条记录。为了使其全部工作,需要建立一些关于设计的假设。

  • 授权修改通讯簿的唯一帐户是用户。
  • 我们表的primary_key是唯一的,基于用户名。
  • 对于可用性,合约应该能够通过单个操作创建和修改表行。

在eosio中,区块链具有唯一的帐户,因此在此特定用例中,account_name是作为primary_key的理想候选者。account_name类型是uint64_t

接下来,为用户定义添加或更新记录的操作。此操作需要接受此操作需要能够放置(创建)或修改的任何值。

格式化定义以使其更容易阅读。为了简化用户体验和界面,有一个方法负责创建和修改行。因此,将其命名为“upsert”,即“update”和“insert”的组合。

1
2
3
4
5
6
7
8
9
10
//c++

void upsert(
account_name user,
std::string first_name,
std::string last_name,
std::string street,
std::string city,
std::string state
) {}

早些时候,有人提到只有用户才能控制自己的记录,因为这个合约是选择加入的。为此,请使用eosio.cdt提供的require_auth方法。此方法接受一个参数,即account_name类型,并断言执行交易的帐户等于提供的值。

1
2
3
4
//c++
void upsert(account_name user, std::string first_name, std::string last_name, std::string street, std::string city, std::string state) {
require_auth( user );
}

实例化表。之前,配置了multi_index表,并将其声明为address_index。要实例化一个表,请考虑这两个必需参数:

  • “code”,代表合约的帐户。可以通过作用域_self变量访问此值。
  • 定义合约付款人的范围“scope”,该用例中的合约负责支付ram费用。
1
2
3
4
5
//c++
void upsert(account_name user, std::string first_name, std::string last_name, std::string street, std::string city, std::string state) {
require_auth( user );
address_index addresses(_self, _self );
}

接下来,查询迭代器,将其设置为变量,因为此迭代器将被多次使用。

1
2
3
4
5
6
//c++
void upsert(account_name user, std::string first_name, std::string last_name, std::string street, std::string city, std::string state) {
require_auth( user );
address_index addresses(_self, _self );
auto iterator = addresses.find(user);
}

安全性已经建立并且表格实例化了,太棒了!

接下来,编写用于创建或修改表的逻辑。检测特定用户是否已存在。

为此,请通过传递user参数来使用表的find方法。find方法将返回一个迭代器。使用该迭代器对end方法进行测试。end方法是“null”的别名。

1
2
3
4
5
6
7
8
9
10
11
12
13
//c++
void upsert(account_name user, std::string first_name, std::string last_name, std::string street, std::string city, std::string state) {
require_auth( user );
auto iterator = addresses.find( user );
address_index addresses(_self, _self );
if( addresses.find( user ) == addresses.end() )
{
//The user isn't in the table
}
else {
//The user is in the table
}
}

使用multi_index方法emplace在表中创建记录。此方法接受两个参数,即此记录的范围“scope”和回调函数。

emplace方法的回调函数必须使用lamba来创建接口。在body中分配行的值和提供给upsert的值。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
//c++
void upsert(account_name user, std::string first_name, std::string last_name, std::string street, std::string city, std::string state) {
require_auth( user );
address_index addresses(_self, _self );
auto iterator = addresses.find( user );
if( iterator == addresses.end() )
{
addresses.emplace(user, [&]( auto& row ) {
row.key = user;
row.first_name = first_name;
row.last_name = last_name;
row.street = street;
row.city = city;
row.state = state;
});
}
else {
//The user is in the table
}
}

接下来,处理“upsert”函数的修改或更新。使用modify方法,传递一些参数

  • 前面定义的迭代器,在调用此操作时设置为声明的用户。
  • 范围“scope”或“ram payer”ram消费者,在这种情况下是用户,如先前在提出该合约的设计时所决定的那样。
  • 回调函数用于处理表的修改。
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
//c++
void upsert(account_name user, std::string first_name, std::string last_name, std::string street, std::string city, std::string state) {
require_auth( user );
address_index addresses(_self, _self );
auto iterator = addresses.find( user );
if( iterator == addresses.end() )
{
addresses.emplace(user, [&]( auto& row ) {
row.key = user;
row.first_name = first_name;
row.last_name = last_name;
row.street = street;
row.city = city;
row.state = state;
});
}
else {
addresses.modify(iterator, user, [&]( auto& row ) {
row.first_name = first_name;
row.last_name = last_name;
row.street = street;
row.city = city;
row.state = state;
});
}
}

地址簿合约现在具有一个功能操作,如果该记录尚不存在,将允许用户在表中创建一行,如果已存在则修改它。

但是如果用户想要完全删除记录呢?请看EOS的数据持久性(下)

对了,文中调用的各种eos方法可以参考EOS.IO C语言API手册

======================================================================

分享一个交互式的在线编程实战,EOS智能合约与DApp开发入门

EOS教程

本课程帮助你快速入门EOS区块链去中心化应用的开发,内容涵盖EOS工具链、账户与钱包、发行代币、智能合约开发与部署、使用代码与智能合约交互等核心知识点,最后综合运用各知识点完成一个便签DApp的开发。

  • java比特币开发教程,本课程面向初学者,内容即涵盖比特币的核心概念,例如区块链存储、去中心化共识机制、密钥与脚本、交易与UTXO等,同时也详细讲解如何在Java代码中集成比特币支持功能,例如创建地址、管理钱包、构造裸交易等,是Java工程师不可多得的比特币开发学习课程。
  • java以太坊开发教程,主要是针对java和android程序员进行区块链以太坊开发的web3j详解。
  • php比特币开发教程,本课程面向初学者,内容即涵盖比特币的核心概念,例如区块链存储、去中心化共识机制、密钥与脚本、交易与UTXO等,同时也详细讲解如何在Php代码中集成比特币支持功能,例如创建地址、管理钱包、构造裸交易等,是Php工程师不可多得的比特币开发学习课程。
  • php以太坊,主要是介绍使用php进行智能合约开发交互,进行账号创建、交易、转账、代币开发以及过滤器和交易等内容。
  • 以太坊入门教程,主要介绍智能合约与dapp应用开发,适合入门。
  • 以太坊开发进阶教程,主要是介绍使用node.js、mongodb、区块链、ipfs实现去中心化电商DApp实战,适合进阶。
  • python以太坊,主要是针对python工程师使用web3.py进行区块链以太坊开发的详解。
  • C#以太坊,主要讲解如何使用C#开发基于.Net的以太坊应用,包括账户管理、状态与交易、智能合约开发与交互、过滤器和交易等。

汇智网原创翻译,转载请标明出处。这里是原文