本文主要針對 Fabric 1.0 并使用 LevelDB為數(shù)據(jù)庫的情況下進(jìn)行的復(fù)合主鍵與區(qū)間查詢的golang語言實(shí)現(xiàn)英融。
在Hyper Ledge的官方指南中有基礎(chǔ)的Chaincode demo剪个，通過該教程痊项，我們可以完整的完成Chaincode的開發(fā)工作初婆。但是由于篇幅限制殖蚕，該文檔中僅包括了簡單的單主鍵查詢锐膜。而這往往不能滿足我們的實(shí)際需要溪王。
在實(shí)際的環(huán)境中腮鞍，對于查詢功能除了簡單的鍵值對查詢值骇，我們往往還有如下兩個(gè)需求：
- 富查詢 ：對數(shù)據(jù)的某一個(gè)屬性進(jìn)行查詢獲取所有滿足條件的數(shù)據(jù)，例如所有顏色為紅色的汽車信息缕减。
- 區(qū)間查詢：對一個(gè)范圍內(nèi)的鍵值進(jìn)行查詢獲取數(shù)據(jù)雷客，例如獲取單號在005至008之間的訂單信息。
下面我們將具體針對這兩個(gè)需求來說一說如何用golang 實(shí)現(xiàn)對應(yīng)的功能桥狡。
富查詢
不少文章在提到Chaincode 富查詢時(shí)就會提到CouchDB搅裙，誠然使用CouchDB可以很方便的實(shí)現(xiàn)富查詢的功能而不需要我們自己做額外的工作。但其實(shí)使用LevelDB同樣可以實(shí)現(xiàn)富查詢裹芝。
那首先我們先來看看如何在CouchDB的情況下實(shí)現(xiàn)富查詢：
使用CouchDB 實(shí)現(xiàn)富查詢
CouchDB通過對Value的內(nèi)容進(jìn)行查詢來實(shí)現(xiàn)富查詢的需求部逮。更具體的內(nèi)容我們可以查閱官方文檔。
CouchDB 使用MangoDB API Layer 來實(shí)現(xiàn)Query語法嫂易，需要傳入一個(gè)queryString查詢字符串,其語法可以在Github查看兄朋。
我們首先定義一下數(shù)據(jù)結(jié)構(gòu)
type Car struct {
Color string `json:"Color"`
ID string `json:"ID"` // key
Price string `json:"Price"`
LaunchDate string `json:"LaunchDate"`
}
現(xiàn)在我們就來看一下如何實(shí)現(xiàn)使用CouchDB當(dāng)Key為ID的情況下對Value中的Color字段進(jìn)行查詢：
\\使用CouchDB數(shù)據(jù)庫
func (t *CarchainCode) queryByColor(stub shim.ChaincodeStubInterface, args []string) Car.Response {
if len(args) != 1 {
return shim.Error("Incorrect number of arguments. Expecting 1")
}
color := args[0]
queryString := fmt.Sprintf(`{"selector":{"Color":"%s"}}`, color) //Mongo Query string 語法見上文鏈接
resultsIterator, err := stub.GetQueryResult(queryString) // 富查詢的返回結(jié)果可能為多條 所以這里返回的是一個(gè)迭代器 需要我們進(jìn)一步的處理來獲取需要的結(jié)果
if err != nil {
return shim.Error("Rich query failed")
}
defer resultsIterator.Close() //釋放迭代器
var buffer bytes.Buffer
bArrayMemberAlreadyWritten := false
buffer.WriteString(`{"result":[`)
for resultsIterator.HasNext() {
queryResponse, err := resultsIterator.Next() //獲取迭代器中的每一個(gè)值
if err != nil {
return shim.Error("Fail")
}
if bArrayMemberAlreadyWritten == true {
buffer.WriteString(",")
}
buffer.WriteString(string(queryResponse.Value)) //將查詢結(jié)果放入Buffer中
bArrayMemberAlreadyWritten = true
}
buffer.WriteString(`]}`)
fmt.Print("Query result: %s", buffer.String())
return shim.Success(buffer.Bytes())
}
使用LevelDB 實(shí)現(xiàn)富查詢
在剛剛的實(shí)現(xiàn)過程中，可以看到的是我們使用了CouchDB等狀態(tài)數(shù)據(jù)庫特有的對Value內(nèi)容進(jìn)行查詢的功能怜械。那么是不是我們就不能用LevelDB實(shí)現(xiàn)了呢颅和？答案顯然是否定的，只是需要我們做一些額外的工作缕允。
我們繼續(xù)上面的里峡扩，要想在使用LevelDB的情況下按顏色查詢Car的需求，需要按如下建立索引：
indexName := "color~id"
colorNameIndexKey, err := stub.CreateCompositeKey(indexName, []string{car.Color, car.ID}) //創(chuàng)建Color與ID的組合鍵
if err != nil {
return shim.Error("Fail to create Composite key")
}
value := []byte{0x00}
stub.PutState(colorNameIndexKey, value) // 將索引信息保保存在Key中
有了上面這個(gè)索引之后我們就可以通過它來實(shí)現(xiàn)富查詢了
colorIdResultsIterator, err := stub.GetStateByPartialCompositeKey ("color~id", []string{color}) //返回包含給出顏色的組合鍵的迭代器
if err != nil {
return shim.Error(err.Error())
}
defer colorIdResultsIterator.Close()
for resultsIterator.HasNext() {
colorIdKey, err := resultsIterator.Next()
if err != nil {
return shim.Error(err.Error())
}
objectType, compisiteKeys, err := stub.SplitCompositeKey(string(colorIdKey.Key)) //通過SplitCompositeKey 解析出Car的主鍵 ID
returnColor := compisiteKeys[0]
returnId := compisiteKeys[1]
fmt.Print("found a car from index %s color: %s id %s\n",objectType,returnColor,returnId)
carBytes, err := stub.GetState(returnId) // 根據(jù)解析出的ID獲取數(shù)據(jù)
//之后的步驟與上一個(gè)例子想類似這里就不贅述了
}
一些補(bǔ)充
上面我們主要運(yùn)用了shim包中關(guān)于組合鍵的方法這里放上他們的官方文檔
// GetStateByPartialCompositeKey queries the state in the ledger based on
// a given partial composite key. This function returns an iterator
// which can be used to iterate over all composite keys whose prefix matches
// the given partial composite key. The `objectType` and attributes are
// expected to have only valid utf8 strings and should not contain
// U+0000 (nil byte) and U+10FFFF (biggest and unallocated code point).
// See related functions SplitCompositeKey and CreateCompositeKey.
// Call Close() on the returned StateQueryIteratorInterface object when done.
// The query is re-executed during validation phase to ensure result set
// has not changed since transaction endorsement (phantom reads detected).
GetStateByPartialCompositeKey(objectType string, keys []string) (StateQueryIteratorInterface, error)
// CreateCompositeKey combines the given `attributes` to form a composite
// key. The objectType and attributes are expected to have only valid utf8
// strings and should not contain U+0000 (nil byte) and U+10FFFF
// (biggest and unallocated code point).
// The resulting composite key can be used as the key in PutState().
CreateCompositeKey(objectType string, attributes []string) (string, error)
// SplitCompositeKey splits the specified key into attributes on which the
// composite key was formed. Composite keys found during range queries
// or partial composite key queries can therefore be split into their
// composite parts.
SplitCompositeKey(compositeKey string) (string, []string, error)
這里我們需要注意到一點(diǎn)GetStateByPartialCompositeKey方法是采用一種前綴匹配的方法來進(jìn)行鍵的匹配返回的障本。也就是說教届，我們雖然是部分復(fù)合鍵的查詢，但是只能拿前面的復(fù)合鍵進(jìn)行匹配驾霜，而不是后面部分案训。具體來說當(dāng)你有一個(gè) 出場年份～顏色～車號的索引時(shí)只能使用 年份、年份與顏色來進(jìn)行查詢粪糙，而不能用顏色來進(jìn)行查詢强霎。因此當(dāng)我們有多鍵的復(fù)合主鍵時(shí)，各個(gè)鍵的順序可能需要我們仔細(xì)思考一下蓉冈。
區(qū)間查詢
除了上文所說的富查詢外區(qū)間查詢也是一個(gè)常用的功能脆栋。下面我們就來掩飾一下如何在chaincode中實(shí)現(xiàn)區(qū)間查詢。
通過查詢官方的文檔我們可以發(fā)現(xiàn)下面這個(gè)方法洒擦。
// GetStateByRange returns a range iterator over a set of keys in the
// ledger. The iterator can be used to iterate over all keys
// between the startKey (inclusive) and endKey (exclusive).
// The keys are returned by the iterator in lexical order. Note
// that startKey and endKey can be empty string, which implies unbounded range
// query on start or end.
// Call Close() on the returned StateQueryIteratorInterface object when done.
// The query is re-executed during validation phase to ensure result set
// has not changed since transaction endorsement (phantom reads detected).
GetStateByRange(startKey, endKey string) (StateQueryIteratorInterface, error)
通過給出需要查詢區(qū)間的開始鍵與結(jié)束鍵（開始鍵與結(jié)束鍵按字典順序排序）獲得區(qū)間查詢的結(jié)果。（包含開始鍵怕膛、不包括結(jié)束鍵的半閉半開區(qū)間）我們依舊用上面的數(shù)據(jù)結(jié)構(gòu)來舉例：
func (t *SimpleChaincode) rangeQuery(stub shim.ChaincodeStubInterface, args []string) pb.Response {
resultsIterator, err := stub.GetStateByRange("Car:1", "Car:3") //這里應(yīng)為傳入?yún)?shù)熟嫩，但為了簡化這里直接Hard code 為 car1 、 car3
if err != nil {
return shim.Error("Query by Range failed")
}
defer resultsIterator.Close() //釋放迭代器
var buffer bytes.Buffer
bArrayMemberAlreadyWritten := false
buffer.WriteString(`{"result":[`)
for resultsIterator.HasNext() {
queryResponse, err := resultsIterator.Next() //獲取迭代器中的每一個(gè)值
if err != nil {
return shim.Error("Fail")
}
if bArrayMemberAlreadyWritten == true {
buffer.WriteString(",")
}
buffer.WriteString(string(queryResponse.Value)) //將查詢結(jié)果放入Buffer中
bArrayMemberAlreadyWritten = true
}
buffer.WriteString(`]}`)
fmt.Print("Query result: %s", buffer.String())
return shim.Success(buffer.Bytes())
}
有一點(diǎn)需要補(bǔ)充的是當(dāng)你有一條鍵為Car:12的記錄時(shí)它也將出現(xiàn)在上面這個(gè)函數(shù)的返回值里褐捻。有經(jīng)驗(yàn)的朋友肯定一下子就知道了這里發(fā)生了什么問題掸茅，沒錯(cuò)GetStateByRange是按字典順序來決定返回的椅邓，所以我們將 Key設(shè)置為 Car:000001 就可以解決這個(gè)問題。
思考一下
通過上面兩部分的介紹相信大家已經(jīng)掌握了fabric chaincode 區(qū)間查詢與富查詢的方法昧狮。這里我們再來思考這樣一個(gè)需求：
- 查詢所有生產(chǎn)年份在 2016～2018年之間的汽車景馁。
猛地一看好像無從下手，但只要仔細(xì)想一下就不能發(fā)現(xiàn)這只是一個(gè)區(qū)間查詢套一個(gè)富查詢而已逗鸣。下面我們具體來設(shè)計(jì)一下如何滿足這個(gè)需求合住。
首先因?yàn)橐獙⑸a(chǎn)年份作為查詢條件所以我們需要創(chuàng)建一個(gè) 生產(chǎn)年份～車號的索引。到這一步我們已經(jīng)可以解決在2016/2017/2018生產(chǎn)的汽車了撒璧，
那么怎么把他們合起來呢透葛？其實(shí)非常簡單我們只需要把年份單獨(dú)作為一個(gè)Key存入數(shù)據(jù)庫中。這樣實(shí)現(xiàn)這個(gè)功能的步驟就是：
- 首先通過
GetStateByRange獲取年份區(qū)間的迭代器 - 遍歷每個(gè)年份通過
stub.GetStateByPartialCompositeKey對每個(gè)年份再根據(jù)索引獲得一個(gè)該年份車號的迭代器卿樱。 - 根據(jù)車號迭代器（在這個(gè)例子中一共會有3個(gè)）獲取最終的結(jié)果僚害。
