Fabric 1.0原始碼分析(23)LevelDB（KV資料庫）

# Fabric 1.0原始碼筆記 之 LevelDB（KV資料庫）

## 1、LevelDB概述

LevelDB是Google開源的持久化KV單機資料庫，具有很高的隨機寫，順序讀/寫效能，但是隨機讀的效能很一般，也就是說，LevelDB很適合應用在查詢較少，而寫很多的場景。

LevelDB的特點：
* key和value都是任意長度的位元組陣列；
* entry（即一條K-V記錄）預設是按照key的字典順序儲存的，當然開發者也可以過載這個排序函式；
* 提供的基本操作介面：Put()、Delete()、Get()、Batch()；
* 支援批量操作以原子操作進行；
* 可以建立資料全景的snapshot(快照)，並允許在快照中查詢資料；
* 可以通過前向（或後向）迭代器遍歷資料（迭代器會隱含的建立一個snapshot）；
* 自動使用Snappy壓縮資料；
* 可移植性；

Fabric中使用了goleveldb包，即https://github.com/syndtr/goleveldb/。

goleveldb的基本操作：

* 開啟資料庫，db, err:=leveldb.OpenFile("./db", nil)。作用就是在當前目錄下建立一個db資料夾作為資料庫的目錄。
* 儲存鍵值，db.Put([]byte("key1"),[]byte("value1"),nil)。作用就是在資料庫中儲存鍵值對 key1-value1。leveldb資料庫中對鍵值的操作都是byte格式化的資料。
* 獲取鍵值對，data,_ := db.Get([]byte("key1"),nil)，獲取key1對應的值。
* 遍歷資料庫，iter := db.NewIterator(nil, nil)，for iter.Next(){ fmt.Printf("key=%s,value=%s\n",iter.Key(),iter.Value()) }，iter.Release()。作用就是建立迭代器iter，然後依次遍歷資料庫中所有的資料並列印鍵和值，最後釋放迭代器iter。
* 關閉資料庫，db.Close()。

Fabric中LevelDB程式碼，分佈在common/ledger/util/leveldbhelper目錄，目錄結構如下：

* leveldb_provider.go，定義了結構體Provider、Provider、UpdateBatch、Iterator及其方法。
* leveldb_helper.go，定義了DB結構體及方法。

## 2、DB結構體及方法

DB結構體定義：對實際資料儲存的包裝。

```go
type Conf struct {
    DBPath string //路徑
}

type DB struct {
    conf *Conf //配置
    db *leveldb.DB //leveldb.DB物件
    dbState dbState //type dbState int32
    mux sync.Mutex //鎖

    readOpts *opt.ReadOptions
    writeOptsNoSync *opt.WriteOptions
    writeOptsSync *opt.WriteOptions
}
//程式碼在common/ledger/util/leveldbhelper/leveldb_helper.go
```

涉及如下方法：對goleveldb包做了封裝。

```go
func CreateDB(conf *Conf) *DB //建立DB例項
func (dbInst *DB) Open() //leveldb.OpenFile，建立並開啟leveldb資料庫（如目錄不存在則建立）
func (dbInst *DB) Close() //db.Close()
func (dbInst *DB) Get(key []byte) ([]byte, error) //db.Get
func (dbInst *DB) Put(key []byte, value []byte, sync bool) error //db.Put
func (dbInst *DB) Delete(key []byte, sync bool) error //db.Delete
func (dbInst *DB) GetIterator(startKey []byte, endKey []byte) iterator.Iterator //db.NewIterator，建立迭代器
func (dbInst *DB) WriteBatch(batch *leveldb.Batch, sync bool) error //db.Write，批量寫入
//程式碼在common/ledger/util/leveldbhelper/leveldb_helper.go
```

## 3、DBHandle結構體及方法

DBHandle結構體定義：封裝DB，目的為給key新增dbName字首，新增和拆除字首通過constructLevelKey(h.dbName, key)和retrieveAppKey()實現。

```go
type DBHandle struct {
    dbName string //DB名稱
    db *DB //type DB struct
}
//程式碼在common/ledger/util/leveldbhelper/leveldb_provider.go
```

涉及如下方法：

```go
func (h *DBHandle) Get(key []byte) ([]byte, error) //h.db.Get
func (h *DBHandle) Put(key []byte, value []byte, sync bool) error //h.db.Put
func (h *DBHandle) Delete(key []byte, sync bool) error //h.db.Delete
func (h *DBHandle) WriteBatch(batch *UpdateBatch, sync bool) error //h.db.WriteBatch
func (h *DBHandle) GetIterator(startKey []byte, endKey []byte) *Iterator //h.db.GetIterator
//程式碼在common/ledger/util/leveldbhelper/leveldb_provider.go
```

補充UpdateBatch結構體及方法：

```go
type UpdateBatch struct {
    KVs map[string][]byte
}
func NewUpdateBatch() *UpdateBatch //構造UpdateBatch
func (batch *UpdateBatch) Put(key []byte, value []byte) //batch.KVs[string(key)] = value
func (batch *UpdateBatch) Delete(key []byte) //batch.KVs[string(key)] = nil
//程式碼在common/ledger/util/leveldbhelper/leveldb_provider.go
```

補充Iterator結構體及方法：封裝github.com/syndtr/goleveldb/leveldb/iterator。

```go
type Iterator struct {
    iterator.Iterator
}
func (itr *Iterator) Key() []byte //itr.Iterator.Key()拆除dbName
func constructLevelKey(dbName string, key []byte) []byte //為key新增dbName
func retrieveAppKey(levelKey []byte) []byte //為key拆除dbName
//程式碼在common/ledger/util/leveldbhelper/leveldb_provider.go
```

## 4、Provider結構體及方法

Provider結構體定義：將單個物理LevelDB，虛擬為多個邏輯LevelDB

```go
type Provider struct {
    db *DB
    dbHandles map[string]*DBHandle
    mux sync.Mutex
}
//程式碼在common/ledger/util/leveldbhelper/leveldb_provider.go
```

涉及方法如下：

```go
func NewProvider(conf *Conf) *Provider {//建立並開啟db，構造Provider
    db := CreateDB(conf)
    db.Open()
    return &Provider{db, make(map[string]*DBHandle), sync.Mutex{}}
}

//獲取名稱為dbName的leveldb控制程式碼
func (p *Provider) GetDBHandle(dbName string) *DBHandle {
    p.mux.Lock()
    defer p.mux.Unlock()
    dbHandle := p.dbHandles[dbName]
    if dbHandle == nil {
        dbHandle = &DBHandle{dbName, p.db}
        p.dbHandles[dbName] = dbHandle
    }
    return dbHandle
}

//關閉leveldb
func (p *Provider) Close() {
    p.db.Close()
}
//程式碼在common/ledger/util/leveldbhelper/leveldb_provider.go
```





網址：http://www.qukuailianxueyuan.io/


欲領取造幣技術與全套虛擬機器資料
區塊鏈技術交流QQ群：756146052  備註：CSDN
尹成學院微信：備註：CSDN
網址：http://www.qukuailianxueyuan.io/
欲領取造幣技術與全套虛擬機器資料
區塊鏈技術交流QQ群：756146052 備註：CSDN
尹成學院微信：備註：CSDN
Fabric 1.0原始碼分析(23)LevelDB（KV資料庫）

相關文章
