sproto

README

gosproto

sproto golang implement

Based on code

https://github.com/xjdrew/gosproto

Features

Similar to golang protobuf version 3

No need use sproto.Int32( ), sproto.String() wrapper to generate point field in order to implement optional field

Optional will be auto processed by comparing incoming value and type default value

bool default is false

integer default is 0

string default is ""

Fields equals to its default value will be skipped encoding and decoding automatically'

USE SPROTO LIKE NORMAL STRUCT!

Type map

sproto type	golang type
string	\string, []byte
integer	\int8, \uint8, \int16, \uint16, \int32, \uint32, \int64, \uint64, \int, \uint
boolean	\bool
object	\struct
*string	[]string
*integer	[]int8, []uint8, []int16, []uint16, []int32, []uint32, []int64, []uint64, []int, []uint
*boolean	[]bool
*struct	[]*struct
*struct(index)	[]*struct

Schema parser and meta info

https://github.com/davyxu/gosproto/tree/master/meta

Code generator

https://github.com/davyxu/gosproto/tree/master/sprotogen

Install

	go get -u -v github.com/davyxu/gosproto/sprotogen

Usage

	# Generate go source file by sproto
	sprotogen --type=go --out=addressbook.go --gopackage=example addressbook.sp
	
	# Generate c# source file by sproto
	sprotogen --type=cs --out=addressbook.cs --gopackage=example addressbook.sp

	# Convert to standard sproto file
	sprotogen --type=sproto --out=addressbook.sproto addressbook.sp
	

Protobuf Schema --> sproto Schema convertor

https://github.com/davyxu/gosproto/tree/master/pb2sproto

Features

Keep all message leading comments and field trailing comments

Install

	go get -u -v github.com/davyxu/gosproto/pb2sproto

Requires: github.com/davyxu/pbmeta

Usage

	# Use protoc and github.com/davyxu/pbmeta/protoc-gen-meta to generate protobuf meta info file(contains comments)
	# see github.com/davyxu/gosproto/pb2sproto/Make.bat
	
	# Use meta info to generate sproto file
	pb2sproto --pbmeta=meta.pb --outdir=.	
	

Remark

Due to sproto not support float field type, all float double format will convert to int32 type

Example

https://github.com/davyxu/gosproto/tree/master/example

	input := &AddressBook{
		Person: []*Person{
			&Person{
				Name: "Alice",
				Id:   10000,
				Phone: []*PhoneNumber{
					&PhoneNumber{
						Number: "123456789",
						Type:   1,
					},
					&PhoneNumber{
						Number: "87654321",
						Type:   2,
					},
				},
			},
			&Person{
				Name: "Bob",
				Id:   20000,
				Phone: []*PhoneNumber{
					&PhoneNumber{
						Number: "01234567890",
						Type:   3,
					},
				},
			},
		},
	}

	data, err := sproto.Encode(input)

	if err != nil {
		t.Log(err)		
	}

	var sample AddressBook
	_, err = sproto.Decode(data, &sample)

	if err != nil {
		t.Log(err)
	}

Test

go test github.com/davyxu/gosproto

Benchmark

$ go test -bench . github.com/davyxu/gosproto
BenchmarkEncode-8         	  500000	      2498 ns/op
BenchmarkDecode-8         	  500000	      3134 ns/op
BenchmarkEncodePacked-8   	  500000	      2894 ns/op
BenchmarkDecodePacked-8   	  500000	      3480 ns/op
PASS
ok  	github.com/davyxu/gosproto	6.162s

• xjdrew/gosproto Version

$ go test -bench . github.com/xjdrew/gosproto
BenchmarkEncode-8         	 1000000	      1931 ns/op
BenchmarkDecode-8         	  500000	      3498 ns/op
BenchmarkEncodePacked-8   	  500000	      2476 ns/op
BenchmarkDecodePacked-8   	  500000	      3896 ns/op
PASS
ok  	github.com/xjdrew/gosproto	7.024s

Feedback

Star me if you like or use, thanks

blog(Chinese): http://www.cppblog.com/sunicdavy

zhihu(Chinese): http://www.zhihu.com/people/sunicdavy

Documentation

Index

• Constants
• Variables
• func Append(dst, src []byte) []byte
• func Decode(data []byte, sp interface{}) (int, error)
• func DecodePacked(data []byte, sp interface{}) error
• func Encode(sp interface{}) ([]byte, error)
• func EncodePacked(sp interface{}) ([]byte, error)
• func EnumName(m map[int32]string, v int32) string
• func Pack(src []byte) []byte
• func Unpack(src []byte) ([]byte, error)
• type SprotoField
• type SprotoType
  • func GetSprotoType(t reflect.Type) (*SprotoType, error)
  • func (st *SprotoType) FieldByTag(tag int) *SprotoField
  • func (st *SprotoType) Len() int
  • func (st *SprotoType) Less(i, j int) bool
  • func (st *SprotoType) Swap(i, j int)
• type Tag

Constants

const (
	EncodeBufferSize = 4096
	MaxEmbeddedInt   = 0x7fff - 1
	MaxInt32         = 0x7fffffff
	MinInt32         = -0x80000000
)

const (
	WireVarintName  = "integer" // int, uint, int8, uint8, int16, uint16, int32, uint32, int64, uint64
	WireBooleanName = "boolean" // bool
	WireBytesName   = "string"  // string, []byte
	WireStructName  = "struct"  // struct
)

Variables

var (
	ErrNonPtr    = errors.New("sproto: called with Non-Ptr type")
	ErrNonStruct = errors.New("sproto: Encode called with Non-Ptr")
	ErrNil       = errors.New("sproto: Encode called with nil")
	ErrDecode    = errors.New("sproto: Decode msg failed")
	ErrUnpack    = errors.New("sproto: Unpack data failed")
)

Functions

func Append

func Append(dst, src []byte) []byte

func Decode

func Decode(data []byte, sp interface{}) (int, error)

func DecodePacked

func DecodePacked(data []byte, sp interface{}) error

unpack && decode

func Encode

func Encode(sp interface{}) ([]byte, error)

func EncodePacked

func EncodePacked(sp interface{}) ([]byte, error)

encode && pack

func EnumName

func EnumName(m map[int32]string, v int32) string

func Pack

func Pack(src []byte) []byte

func Unpack

func Unpack(src []byte) ([]byte, error)

Types

type SprotoField

type SprotoField struct {
	Name     string
	OrigName string
	Wire     string
	Tag      int
	Array    bool
	// contains filtered or unexported fields
}

type SprotoType

type SprotoType struct {
	Name   string // struct name
	Fields []*SprotoField
	// contains filtered or unexported fields
}

func GetSprotoType

func GetSprotoType(t reflect.Type) (*SprotoType, error)

func (*SprotoType) FieldByTag

func (st *SprotoType) FieldByTag(tag int) *SprotoField

func (*SprotoType) Len

func (st *SprotoType) Len() int

func (*SprotoType) Less

func (st *SprotoType) Less(i, j int) bool

func (*SprotoType) Swap

func (st *SprotoType) Swap(i, j int)

type Tag

type Tag struct {
	Tag uint16
	Val *uint16
}