EOS 數(shù)據(jù)庫結(jié)構(gòu)詳解
在 EOS 中娜睛,智能合約執(zhí)行完畢后,所占用的內(nèi)存會(huì)釋放卦睹。程序中的所有變量都會(huì)丟失畦戒。如果智能合約里要持久地記錄信息,比如游戲智能合約要記錄每位用戶游戲記錄结序,本次合約執(zhí)行完畢后數(shù)據(jù)不能丟失障斋,就需要將數(shù)據(jù)存儲(chǔ)到 EOS 數(shù)據(jù)庫中。與數(shù)據(jù)庫交互的 API 被官方成為 Persistence API笼痹,中文可以叫做持久化 API。下圖說明了 EOS 智能合約在執(zhí)行 Action 時(shí)酪穿,與數(shù)據(jù)庫的交互過程凳干。
為了方便智能合約與 EOS 數(shù)據(jù)庫的交互,EOS 仿造了 Boost 庫中的 Multi-Index Containers
被济,開發(fā)了 C++ 類:1eosio::multi_index(以下簡稱
multi_index`)救赐,中文可以叫做多索引列表類。
multi_index
頭文件地址:
https://github.com/EOSIO/eos/blob/master/contracts/eosiolib/multi_index.hpp
在 EOS 見證人硬盤中只磷,為每個(gè)賬戶都預(yù)留了數(shù)據(jù)庫空間(大小與代幣持有量有關(guān))经磅,每個(gè)賬戶名下可以建立多個(gè)數(shù)據(jù)表。智能合約無法直接操作存儲(chǔ)在見證人硬盤中的數(shù)據(jù)表钮追,需要使用multi_index
作為中間工具(或者叫容器)预厌,每個(gè)multi_index
實(shí)例都與一個(gè)特定賬戶的特定數(shù)據(jù)表進(jìn)行交互(取決于實(shí)例化時(shí)的參數(shù))。EOS智能合約與EOS數(shù)據(jù)庫的數(shù)據(jù)交互如下圖所示元媚。
數(shù)據(jù)表
multi_index
是一個(gè)非常方便的數(shù)據(jù)庫交互容器轧叽,可以存儲(chǔ)任何 C++ 數(shù)據(jù)類型。每一個(gè)multi_index
都相當(dāng)于傳統(tǒng)數(shù)據(jù)庫的一個(gè)數(shù)據(jù)表(table)刊棕,但將傳統(tǒng)數(shù)據(jù)庫的行與列的形式改為了單純的列炭晒。也就是說multi_index
是一個(gè)線性排列的表,只有一列甥角,每一行都只存儲(chǔ)一個(gè)對象网严。但是一般來說multi_index
存儲(chǔ)的對象都是結(jié)構(gòu)體或者類,里面含有多個(gè)成員變量嗤无,所以multi_index
存儲(chǔ)數(shù)據(jù)的靈活性也是不亞于傳統(tǒng)數(shù)據(jù)庫的震束。
我們使用官方的“汽車維修店”示例怜庸,我們建立一個(gè)數(shù)據(jù)表,儲(chǔ)存每個(gè)汽車維修店客戶的賬戶名驴一、保養(yǎng)時(shí)間休雌、車輛里程。那么multi_index
數(shù)據(jù)表儲(chǔ)存的項(xiàng)目中肝断,每個(gè)都是如下的結(jié)構(gòu)體:
struct service_rec {
uint64_t pkey; // 主鍵
account_name customer; // 車主用戶名
uint32_t service_date; // 維修保養(yǎng)時(shí)間
uint32_t odometer; // 車輛里程
};
在傳統(tǒng)數(shù)據(jù)庫中杈曲,需要建立一個(gè) 4 列的數(shù)據(jù)表,用來儲(chǔ)存每個(gè)用戶的這個(gè) 4 個(gè)數(shù)據(jù)胸懈,而multi_index
的每個(gè)數(shù)據(jù)表只有一列担扑,只存儲(chǔ)每個(gè)用戶的 service_rec
整個(gè)結(jié)構(gòu)體即可。下圖為multi_index
數(shù)據(jù)結(jié)構(gòu)趣钱。
多索引
首先涌献,每個(gè)數(shù)據(jù)表要有一組主鍵,主鍵必須是無符號 64 位整數(shù)類型(64-bit integer)首有,這就是上面的service_rec
結(jié)構(gòu)體中第一個(gè)變量為uint64_t
類型的原因燕垃。在數(shù)據(jù)表中,所有的對象就是按照主鍵升序排列的井联,小的在前卜壕,大的在后。主鍵可以是有意義的烙常,也可以是沒有意義的轴捎,讓系統(tǒng)產(chǎn)生一個(gè)在這個(gè)數(shù)據(jù)表中沒有被使用的主鍵即可。為了設(shè)置主鍵蚕脏,我們需要在之前的service_rec
結(jié)構(gòu)體添加一個(gè)叫做primary_key()
的成員函數(shù)函數(shù)的返回值為主鍵侦副。
auto primary_key()const { return pkey; }
這樣就將pkey
這個(gè)變量設(shè)置成了主鍵。
multi_index
從字面上看就是能使用多個(gè)索引的數(shù)據(jù)表驼鞭。EOS 中秦驯,每個(gè)multi_index
或者說每個(gè)數(shù)據(jù)表都可以設(shè)置最多16個(gè)索引。索引相當(dāng)于使用特定的方式給數(shù)據(jù)表中的對象重新排序挣棕。比如在我們經(jīng)常使用的 windows 文件管理器中汇竭,可以按照文件名排序、按照文件修改時(shí)間排序穴张、按照文件大小排序细燎,這就有了3個(gè)索引。EOS 數(shù)據(jù)庫索引更加靈活皂甘,可以單獨(dú)按照結(jié)構(gòu)體中的某個(gè)變量索引玻驻,也可以將變量之間的運(yùn)算結(jié)果(函數(shù)輸出)進(jìn)行索引。如果我們想使用車主用戶名
進(jìn)行索引,需要在結(jié)構(gòu)體中添加一個(gè)get_customer()
成員函數(shù)璧瞬,函數(shù)的返回值為索引變量户辫。
account_name get_customer()const { return customer; }
這樣就將customer
這個(gè)變量設(shè)置成了數(shù)據(jù)表的一個(gè)索引,下圖右側(cè)為customer
索引嗤锉。
迭代器
multi_index
是如何操作數(shù)據(jù)表中的每個(gè)對象的呢渔欢?答案是 Iterators(迭代器)。大家可以搜索 “C++ 迭代器”或者設(shè)計(jì)模式中的“迭代器模式”來了解迭代器的設(shè)計(jì)思路瘟忱。在 EOS 數(shù)據(jù)庫中奥额,我更愿意將迭代器比喻為一個(gè)“電梯”,在整個(gè)數(shù)據(jù)表中上下穿梭访诱。所有對數(shù)據(jù)的操作必須通過迭代器完成垫挨。典型的數(shù)據(jù)修改過程是這樣的:首先使用迭代器的find()
方法,在特定的索引中尋找需要的數(shù)據(jù)触菜,比如在車主用戶名索引中尋找某個(gè)用戶九榔。迭代器會(huì)移動(dòng)到需要的數(shù)據(jù)對象上。然后就可以使用迭代器的modify()
方法修改當(dāng)前迭代器對應(yīng)的數(shù)據(jù)涡相。下圖為迭代器指向用戶 Sue 的情況哲泊。
本篇文章介紹了 EOS 數(shù)據(jù)庫的基本結(jié)構(gòu),以后的文章會(huì)詳細(xì)介紹 EOS 數(shù)據(jù)庫使用實(shí)戰(zhàn)催蝗,敬請期待切威。
相關(guān)文章和視頻推薦
【許曉笛】EOS 數(shù)據(jù)庫與持久化 API —— 實(shí)戰(zhàn)
圓方圓學(xué)院匯集大批區(qū)塊鏈名師,打造精品的區(qū)塊鏈技術(shù)課程生逸。 在各大平臺(tái)都長期有優(yōu)質(zhì)免費(fèi)公開課牢屋,歡迎報(bào)名收看且预。
公開課地址:https://ke.qq.com/course/345101