gob(Go binary)是Goland包自帶的一個數據結構序列化的編碼/解碼工具。編碼使用Encoder,解碼使用Decoder。一種典型的應用場景就是RPC(remote procedure calls)。
gob和json的pack之類的方法一樣,由發送端使用encoder對數據結構進行編碼。在接收端使用decoder將序列化的數據轉成本地變量。
Go語言可以通過JSON或Gob來序列化struct對象,雖然JSON的序列化更為通用,但利用Gob編碼可以實現JSON所不能支持的struct的方法序列化,利用Gob包序列化struct保存到本地也十分簡單。
Gob編解碼規則
對於Gob而言,發送方和接收方的數據結構並不需要完全一致,官方示例為例:
上述struct{A,B int}
結構編碼的數據可以被后面九種結構類型接受解碼,具體來說,接受數據結構只要滿足與發送數據結構簽名一致(與順序無關,類型之間不能相互編解碼,整型還要細分有符號和無符號)、或者是發送數據類型的子集(但不能為空)或超集,即正常接收並解碼
具體到不同的數據類型,規則如下:
struct{A,B int}
、array
、slice
是可以被編碼的,但是function
和channel
是不能被編碼的- 整型分為有符號和無符號,無符號和有符號整型是不能互相編解碼的
- 布爾類型是被當做
uint
來編碼的,0
是false
,1
是true
; - 浮點型的值都是被當做
float64
類型的值來編碼的,浮點型和整型也是不能相互編碼的 - 字符串類型(包括
string
和[]byte
)是無符號字節個數+每個字節編碼的形式編解碼的 - 數組類型(包括
slice
和array
)是按照無符號元素個數+每個數組元素編碼的形式進行編解碼的 - 字典類型(
map
)是按照無符號元素個數+鍵值對的形式進行編解碼的 - 結構體類型(
struct
)是按照序列化的屬性名+屬性值來進行編解碼的,其中屬性值是其自己對應類型的Gob編碼,如果有一個屬性值為0
或空,則這個屬性直接被忽略,每個屬性的序號是編碼時的順序決定的,從0
開始順序遞增。struct
在序列化前會以-1
代表序列化的開始,以0
代表序列化的結束,即struct
的序列化是按照"-1(0屬性1的名字 屬性1的值)(1 屬性2的名字 屬性2的值)"來進行編碼的
注:struct
類型的屬性名都應該是大寫字母開頭,以便可以在包外被訪問
gob包提供的API
結構體
type GobDecoder interface
type GobEncoder interface
type Decoder struct
type Encoder struct
函數列表:
func Register(value interface{})
func RegisterName(name string, value interface{})
func NewDecoder(r io.Reader) *Decoder
func (dec *Decoder) Decode(e interface{}) error
func (dec *Decoder) DecoderValue(v reflect.Value) error
func NewEncoder(w io.Writer) *Encoder
func (enc *Encoder) Encode(e interface{}) error
func (enc *Encoder) EncodeValue(value reflect.Value) error
詳解:
1)GobDecoder
type GobDecoder interface {
GobEecode([]byte) error
}
GobDecoder是一個描述數據的結構,提供自己的方案來解碼GobE內從der發送的數據
2)GobEncoder
type GobEncoder interface {
GobEncode() ([]byte, error)
}
GobEncoder是一個描述數據的接口,提供自己的方案來將數據編碼提供GobDecoder接受並編碼。一個實現了GobEnoder接口和GobDecoder接口的類型可以完全控制自身數據的表示,因此可以包含非導出子段、通道、函數等數據,這些數據gob流正常使用不能傳輸的
// A Decoder manages the receipt of type and data information read from the
// remote side of a connection.
type Decoder struct {
mutex sync.Mutex // each item must be received atomically
r io.Reader // source of the data
buf bytes.Buffer // buffer for more efficient i/o from r
wireType map[typeId]*wireType // map from remote ID to local description
decoderCache map[reflect.Type]map[typeId]**decEngine // cache of compiled engines
ignorerCache map[typeId]**decEngine // ditto for ignored objects
freeList *decoderState // list of free decoderStates; avoids reallocation
countBuf []byte // used for decoding integers while parsing messages
tmp []byte // temporary storage for i/o; saves reallocating
err error
}
// An Encoder manages the transmission of type and data information to the
// other side of a connection.
type Encoder struct {
mutex sync.Mutex // each item must be sent atomically
w []io.Writer // where to send the data
sent map[reflect.Type]typeId // which types we've already sent
countState *encoderState // stage for writing counts
freeList *encoderState // list of free encoderStates; avoids reallocation
byteBuf bytes.Buffer // buffer for top-level encoderState
err error
}
1)func Register(value interface{})
Register
記錄value
下層具體值得類型和其名稱。該名稱將用來識別發送或接收接口類型值下層的具體類型。本函數只應在初始化調用,如果類型和名字的映射不是一一對應的,會panic。
2)func RegisterName(name string, value interface{})
RegisterName
,使用自定義的名稱替代類型的默認名稱。
3)func NewDecoder(r io.Reader) *Decoder
參數列表:
r Reader
對象
返回值:*Decoder
指向Decoder
的指針
功能說明:這個函數主要是給r創建一個decoder
實例
4)func (des *Decoder) Decode(e interface{}) error
參數列表:
e
空接口類型,可以處理任何類型的數據
返回值:error
功能說明:此函數是Decoder
的方法即(method),需要使用NewDcoder
()創建*Decoder對象后,才可以使用
5)func (dec *Decoder) DecodeValue(v refletc.Value) error
6)func NewEncoder(w io.Writer) *Encoder
7)func (enc *Encoder) Encode(e interface{}) error
參數列表:
v
序列化gob對象
返回值:error錯誤
功能說明:這個函數主要是講encode
編碼的gob數據寫入到相關聯的對象
8)func (enc *Encoder) EncodeValue(value reflect.Value) error
demo1:自定義gob規則
1)實現GobDecoder、GobEncoder這兩個接口
2)編寫代碼
一篇講解重新gob的博客,鏈接
demo2:創建一個編碼器,傳輸一些值,用解碼器接收它們。
示例:
package main
import (
"bytes"
"encoding/gob"
"fmt"
"log"
)
type P struct {
X, Y, Z int
Name string
}
type Q struct {
X, Y *int32
Name string
}
// 此示例顯示了包的基本用法:創建編碼器,
// 傳輸一些值,用解碼器接收。
func main() {
// 初始化編碼器和解碼器。 通常是enc和dec
// 綁定到網絡連接和編碼器和解碼器會
// 在不同的進程中運行。
var network bytes.Buffer // 替代網絡連接
enc := gob.NewEncoder(&network) // 將寫入網絡。
dec := gob.NewDecoder(&network) // 將從網絡上讀取。
// Encoding(發送)一些值。
err := enc.Encode(P{3, 4, 5, "Pythagoras"})
if err != nil {
log.Fatal("encode error:", err)
}
err = enc.Encode(P{1782, 1841, 1922, "Treehouse"})
if err != nil {
log.Fatal("encode error:", err)
}
// Decode(接收)並打印值。
var q Q
err = dec.Decode(&q)
if err != nil {
log.Fatal("decode error 1:", err)
}
fmt.Printf("%q: {%d, %d}\n", q.Name, *q.X, *q.Y)
err = dec.Decode(&q)
if err != nil {
log.Fatal("decode error 2:", err)
}
fmt.Printf("%q: {%d, %d}\n", q.Name, *q.X, *q.Y)
}
參考:https://cloud.tencent.com/developer/section/1141539
https://developer.aliyun.com/article/676396