Go-ethereum 源码解析之 go-ethereum/ethdb/memory_database.go

Source code

// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package ethdb

import (
    "errors"
    "sync"

    "github.com/ethereum/go-ethereum/common"
)

/*
 * This is a test memory database. Do not use for any production it does not get persisted
 */
type MemDatabase struct {
    db   map[string][]byte
    lock sync.RWMutex
}

func NewMemDatabase() *MemDatabase {
    return &MemDatabase{
        db: make(map[string][]byte),
    }
}

func NewMemDatabaseWithCap(size int) *MemDatabase {
    return &MemDatabase{
        db: make(map[string][]byte, size),
    }
}

func (db *MemDatabase) Put(key []byte, value []byte) error {
    db.lock.Lock()
    defer db.lock.Unlock()

    db.db[string(key)] = common.CopyBytes(value)
    return nil
}

func (db *MemDatabase) Has(key []byte) (bool, error) {
    db.lock.RLock()
    defer db.lock.RUnlock()

    _, ok := db.db[string(key)]
    return ok, nil
}

func (db *MemDatabase) Get(key []byte) ([]byte, error) {
    db.lock.RLock()
    defer db.lock.RUnlock()

    if entry, ok := db.db[string(key)]; ok {
        return common.CopyBytes(entry), nil
    }
    return nil, errors.New("not found")
}

func (db *MemDatabase) Keys() [][]byte {
    db.lock.RLock()
    defer db.lock.RUnlock()

    keys := [][]byte{}
    for key := range db.db {
        keys = append(keys, []byte(key))
    }
    return keys
}

func (db *MemDatabase) Delete(key []byte) error {
    db.lock.Lock()
    defer db.lock.Unlock()

    delete(db.db, string(key))
    return nil
}

func (db *MemDatabase) Close() {}

func (db *MemDatabase) NewBatch() Batch {
    return &memBatch{db: db}
}

func (db *MemDatabase) Len() int { return len(db.db) }

type kv struct {
    k, v []byte
    del  bool
}

type memBatch struct {
    db     *MemDatabase
    writes []kv
    size   int
}

func (b *memBatch) Put(key, value []byte) error {
    b.writes = append(b.writes, kv{common.CopyBytes(key), common.CopyBytes(value), false})
    b.size += len(value)
    return nil
}

func (b *memBatch) Delete(key []byte) error {
    b.writes = append(b.writes, kv{common.CopyBytes(key), nil, true})
    b.size += 1
    return nil
}

func (b *memBatch) Write() error {
    b.db.lock.Lock()
    defer b.db.lock.Unlock()

    for _, kv := range b.writes {
        if kv.del {
            delete(b.db.db, string(kv.k))
            continue
        }
        b.db.db[string(kv.k)] = kv.v
    }
    return nil
}

func (b *memBatch) ValueSize() int {
    return b.size
}

func (b *memBatch) Reset() {
    b.writes = b.writes[:0]
    b.size = 0
}

Appendix A. 总体批注

实现了一个内存数据库 MemDatabase 用于测试环境，但不能将其用于生产环境。

ethdb.MemDatabase 实现了接口 ethdb.Database。

ethdb.memBatch 在 ethdb.MemDatabase 的基础上提供了批处理能力。

这里将基于接口编程的思想展现的淋漓尽致。

Appendix B. 详细批注

1. type MemDatabase struct

数据结构 MemDatabase 是一个测试内存数据库。不要将其用于任何生产环境，因为它不会被持久化。

db map[string][]byte： key-value 对？
lock sync.RWMutex：锁

1.1 func NewMemDatabase() *MemDatabase

构造函数 NewMemDatabase() 创建对象 MemDatabase，并使用默认值初始化。

1.2 func NewMemDatabaseWithCap(size int) *MemDatabase

构造函数 NewMemDatabaseWithCap() 创建对象 MemDatabase，并设定 db 的大小。

1.3 func (db *MemDatabase) Put(key []byte, value []byte) error

方法 Put() 实现了接口 ethdb.Putter 和接口 ethdb.Database。

参数：

key []byte： key
value []byte： value

返回值：

出错返回错误消息 error，否则返回 nil

主要实现：

加锁。代码为： db.lock.Lock()
defer 解锁。代码为：defer db.lock.Unlock()
将 (key, value) 对存储数据库 db。db.db[string(key)] = common.CopyBytes(value)

1.4 func (db *MemDatabase) Has(key []byte) (bool, error)

方法 Has() 实现了接口 ethdb.Database。

参数：

key []byte： key

返回值：

存在返回 true，否则返回 false
出错返回错误消息 error，否则返回 nil

主要实现：

加锁。代码为： db.lock.RLock()
defer 解锁。代码为：defer db.lock.RUnlock()
是否存在。_, ok := db.db[string(key)]

1.5 func (db *MemDatabase) Get(key []byte) ([]byte, error)

方法 Get() 实现了接口 ethdb.Database。

参数：

key []byte： key

返回值：

存在返回 key 对应的 value
出错返回错误消息 error，否则返回 nil

主要实现：

加锁。代码为：db.lock.RLock()
defer 解锁。代码为：defer db.lock.RUnlock()
获取 key 对应的值 entry。代码为：entry, ok := db.db[string(key)]
将 entry 的副本返回。代码为：return common.CopyBytes(entry)

1.6 func (db *MemDatabase) Keys() [][]byte

方法 Keys() 返回数据库中的所有 key。

返回值：

所有的 key 构成的列表

主要实现：

加锁。代码为：db.lock.RLock()
defer 解锁。代码为：defer db.lock.RUnlock()
定义所有 key 的列表 keys
遍历数据库 db.db 中的所有 key
- 将 key 添加到 keys

1.7 func (db *MemDatabase) Delete(key []byte) error

方法 Put() 实现了接口 ethdb.Deleter 和接口 ethdb.Database。

参数：

key []byte： key

返回值：

出错返回错误消息 error，否则返回 nil

主要实现：

加锁。代码为：db.lock.Lock()
defer 解锁。代码为：defer db.lock.Unlock()
通过 Go 内置函数 delete() 从数据库 db.db 中删除对应的 key。代码为：delete(db.db, string(key))

1.8 func (db *MemDatabase) Close() {}

方法 Close() 实现了接口 ethdb.Database。

主要实现：

空实现。

1.9 func (db *MemDatabase) NewBatch() Batch

方法 NewBatch() 实现了接口 ethdb.Database。

主要实现：

return &memBatch{db: db}

1.10 func (db *MemDatabase) Len() int

方法 Len() 返回数据库包含的数据量。

返回值：

数据量

主要实现：

return len(db.db)

2. type kv struct

数据结构 kv 用于描述批处理的值 k, v 和操作类型是 add 还是 del。

k, v []byte： Key & Value
del bool：操作类型是插入还是删除

3. type memBatch struct

数据结构 memBatch 是具有批处理能力的内存数据库。

db *MemDatabase：内存数据库
writes []kv：批处理数据
size int：批处理的字节数

3.1 func (b *memBatch) Put(key, value []byte) error

方法 Put() 实现了接口 ethdb.Putter，用于将给定的 key & value 插入数据库。

参数：

key []byte： key
value []byte： value

返回值：

出错返回错误消息 error，否则返回 nil

主要实现：

将 key & value & false 构建的 kv 插入批处理数据 writes
- b.writes = append(b.writes, kv{common.CopyBytes(key), common.CopyBytes(value), false})
增加批处理字节数 size
- b.size += len(value)

3.2 func (b *memBatch) Delete(key []byte) error

方法 Delete() 实现了接口 ethdb.Deleter，用于从数据库中删除给定的 key。

参数：

key []byte： key

返回值：

出错返回错误消息 error，否则返回 nil

主要实现：

将 key & nil & true 构建的 kv 插入批处理数据 writes
- b.writes = append(b.writes, kv{common.CopyBytes(key), nil, true})
更新批处理字节数 size
- b.size += 1

3.3 func (b *memBatch) Write() error

方法 Write() 一次性将批处理数据更新到数据库。

返回值：

出错返回错误消息 error，否则返回 nil

主要实现：

加锁。代码为：db.lock.Lock()
defer 解锁。代码为：defer db.lock.Unlock()
遍历批处理数据 b.writes 的每个 kv
- 如果 kv.del
  - 从数据库中删除 kv.k
    - delete(b.db.db, string(kv.k))
  - 退出本轮迭代
- 否则，将 kv.k & kv.v 插入数据库
  - b.db.db[string(kv.k)] = kv.v

3.4 func (b *memBatch) ValueSize() int

方法 ValueSize() 返回批处理字节数。

返回值：

批处理字节数。

主要实现：

return b.size

3.5 func (b *memBatch) Reset()

方法 Reset() 重置批处理操作。

主要实现：

清空批处理操作
- b.writes = b.writes[:0]
- b.size = 0

Reference

https://github.com/ethereum/go-ethereum/blob/master/ethdb/memory_database.go

Contributor

Windstamp, https://github.com/windstamp

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 212,222评论 6赞 493
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,455评论 3赞 385
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 157,720评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,568评论 1赞 284
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,696评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 49,879评论 1赞 290
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,028评论 3赞 409
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,773评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,220评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,550评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,697评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,360评论 4赞 332
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,002评论 3赞 315
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,782评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,010评论 1赞 266
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,433评论 2赞 360
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,587评论 2赞 350

Go-ethereum 源码解析之 go-ethereum/ethdb/memory_database.go

Go-ethereum 源码解析之 go-ethereum/ethdb/memory_database.go

Source code

Appendix A. 总体批注

Appendix B. 详细批注

1. type MemDatabase struct

1.1 func NewMemDatabase() *MemDatabase

1.2 func NewMemDatabaseWithCap(size int) *MemDatabase

1.3 func (db *MemDatabase) Put(key []byte, value []byte) error

1.4 func (db *MemDatabase) Has(key []byte) (bool, error)

1.5 func (db *MemDatabase) Get(key []byte) ([]byte, error)

1.6 func (db *MemDatabase) Keys() [][]byte

1.7 func (db *MemDatabase) Delete(key []byte) error

1.8 func (db *MemDatabase) Close() {}

1.9 func (db *MemDatabase) NewBatch() Batch

1.10 func (db *MemDatabase) Len() int

2. type kv struct

3. type memBatch struct

3.1 func (b *memBatch) Put(key, value []byte) error

3.2 func (b *memBatch) Delete(key []byte) error

3.3 func (b *memBatch) Write() error

3.4 func (b *memBatch) ValueSize() int

3.5 func (b *memBatch) Reset()

Reference

Contributor

推荐阅读更多精彩内容