73 lines
3.0 KiB
Markdown
73 lines
3.0 KiB
Markdown
|
# MessagePack encoding for Golang
|
||
|
|
|
||
|
|
[](https://travis-ci.org/vmihailenco/msgpack)
|
||
|
|
[](https://godoc.org/github.com/vmihailenco/msgpack)
|
||
|
|
|
||
|
|
Supports:
|
||
|
|
- Primitives, arrays, maps, structs, time.Time and interface{}.
|
||
|
|
- Appengine *datastore.Key and datastore.Cursor.
|
||
|
|
- [CustomEncoder](https://godoc.org/github.com/vmihailenco/msgpack#example-CustomEncoder)/CustomDecoder interfaces for custom encoding.
|
||
|
|
- [Extensions](https://godoc.org/github.com/vmihailenco/msgpack#example-RegisterExt) to encode type information.
|
||
|
|
- Renaming fields via `msgpack:"my_field_name"` and alias via `msgpack:"alias:another_name"`.
|
||
|
|
- Omitting individual empty fields via `msgpack:",omitempty"` tag or all [empty fields in a struct](https://godoc.org/github.com/vmihailenco/msgpack#example-Marshal--OmitEmpty).
|
||
|
|
- [Map keys sorting](https://godoc.org/github.com/vmihailenco/msgpack#Encoder.SortMapKeys).
|
||
|
|
- Encoding/decoding all [structs as arrays](https://godoc.org/github.com/vmihailenco/msgpack#Encoder.UseArrayForStructs) or [individual structs](https://godoc.org/github.com/vmihailenco/msgpack#example-Marshal--AsArray).
|
||
|
|
- [Encoder.UseJSONTag](https://godoc.org/github.com/vmihailenco/msgpack#Encoder.UseJSONTag) with [Decoder.UseJSONTag](https://godoc.org/github.com/vmihailenco/msgpack#Decoder.UseJSONTag) can turn msgpack into drop-in replacement for JSON.
|
||
|
|
- Simple but very fast and efficient [queries](https://godoc.org/github.com/vmihailenco/msgpack#example-Decoder-Query).
|
||
|
|
|
||
|
|
API docs: https://godoc.org/github.com/vmihailenco/msgpack.
|
||
|
|
Examples: https://godoc.org/github.com/vmihailenco/msgpack#pkg-examples.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
This project uses [Go Modules](https://github.com/golang/go/wiki/Modules) and semantic import versioning since v4:
|
||
|
|
|
||
|
|
``` shell
|
||
|
|
go mod init github.com/my/repo
|
||
|
|
go get github.com/vmihailenco/msgpack/v4
|
||
|
|
```
|
||
|
|
|
||
|
|
## Quickstart
|
||
|
|
|
||
|
|
``` go
|
||
|
|
import "github.com/vmihailenco/msgpack/v4"
|
||
|
|
|
||
|
|
func ExampleMarshal() {
|
||
|
|
type Item struct {
|
||
|
|
Foo string
|
||
|
|
}
|
||
|
|
|
||
|
|
b, err := msgpack.Marshal(&Item{Foo: "bar"})
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
|
||
|
|
var item Item
|
||
|
|
err = msgpack.Unmarshal(b, &item)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
fmt.Println(item.Foo)
|
||
|
|
// Output: bar
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Benchmark
|
||
|
|
|
||
|
|
```
|
||
|
|
BenchmarkStructVmihailencoMsgpack-4 200000 12814 ns/op 2128 B/op 26 allocs/op
|
||
|
|
BenchmarkStructUgorjiGoMsgpack-4 100000 17678 ns/op 3616 B/op 70 allocs/op
|
||
|
|
BenchmarkStructUgorjiGoCodec-4 100000 19053 ns/op 7346 B/op 23 allocs/op
|
||
|
|
BenchmarkStructJSON-4 20000 69438 ns/op 7864 B/op 26 allocs/op
|
||
|
|
BenchmarkStructGOB-4 10000 104331 ns/op 14664 B/op 278 allocs/op
|
||
|
|
```
|
||
|
|
|
||
|
|
## Howto
|
||
|
|
|
||
|
|
Please go through [examples](https://godoc.org/github.com/vmihailenco/msgpack#pkg-examples) to get an idea how to use this package.
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
- [Golang PostgreSQL ORM](https://github.com/go-pg/pg)
|
||
|
|
- [Golang message task queue](https://github.com/vmihailenco/taskq)
|