Encoding Plugins

go-wind-plugins provides a unified codec interface for serializing/deserializing HTTP request bodies, gRPC messages, Broker messages, and more.

1. The Codec Interface

type Codec interface {
    Marshal(v interface{}) ([]byte, error)
    Unmarshal(data []byte, v interface{}) error
    Name() string
}

2. Built-in Encodings

There are 12 codec plugins in total:

EncodingImport PathEngine
JSONplugins/encoding/jsonencoding/json
Protobufplugins/encoding/protogoogle.golang.org/protobuf
YAMLplugins/encoding/yamlgopkg.in/yaml.v3
TOMLplugins/encoding/tomlpelletier/go-toml
XMLplugins/encoding/xmlencoding/xml
MessagePackplugins/encoding/msgpackvmihailenco/msgpack
Avroplugins/encoding/avrolinkedin/goavro
BSONplugins/encoding/bsongo.mongodb.org/mongo-driver
CBORplugins/encoding/cborfxamacker/cbor
FlatBuffersplugins/encoding/flatbuffersgoogle/flatbuffers
Gobplugins/encoding/gobencoding/gob
Thriftplugins/encoding/thriftApache Thrift

3. Registering Codecs

import (
    _ "github.com/tx7do/go-wind-plugins/encoding/json"
    _ "github.com/tx7do/go-wind-plugins/encoding/proto"
)

// init() registers them into the global codec registry automatically

4. Usage

4.1 Encoding and Decoding

import "github.com/tx7do/go-wind-plugins/encoding"

// Get a codec
jsonCodec := encoding.GetCodec("json")

// Encode
data, _ := jsonCodec.Marshal(user)

// Decode
var user User
jsonCodec.Unmarshal(data, &user)

4.2 HTTP Requests/Responses

// The transport layer picks the codec automatically based on Content-Type
// A client sending application/json → the JSON codec is used
// A client sending application/protobuf → the Protobuf codec is used

4.3 Broker Messages

msg := &broker.Message{
    Headers: map[string]string{
        "Content-Type": "application/json",
    },
    Body: jsonData,
}

5. Custom Codecs

package mycodec

import "github.com/tx7do/go-wind-plugins/encoding"

type Codec struct{}

func (c *Codec) Marshal(v interface{}) ([]byte, error) {
    // custom serialization logic
    return serialize(v)
}

func (c *Codec) Unmarshal(data []byte, v interface{}) error {
    // custom deserialization logic
    return deserialize(data, v)
}

func (c *Codec) Name() string { return "my-format" }

func init() {
    // the registry keys entries by Name() (case-insensitive)
    encoding.RegisterCodec(&Codec{})
}