Golang通用编解码器接口插件库encdec使用指南

encdec是一个Go语言的通用编解码器接口插件库，它提供了一种统一的方式来处理各种数据格式的编码和解码操作。下面我将详细介绍它的使用方法。

安装

go get github.com/yourusername/encdec

基本概念

encdec库定义了以下核心接口：

type Encoder interface {
    Encode(v interface{}) ([]byte, error)
}

type Decoder interface {
    Decode(data []byte, v interface{}) error
}

type Codec interface {
    Encoder
    Decoder
}

内置编解码器

encdec内置了多种常见格式的编解码器：

• JSON
• XML
• YAML
• TOML
• MessagePack
• Protocol Buffers

基本使用

1. 使用内置编解码器

package main

import (
    "fmt"
    "github.com/yourusername/encdec"
    "github.com/yourusername/encdec/json"
)

type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

func main() {
    // 创建JSON编解码器
    codec := json.NewCodec()
    
    // 编码
    p := Person{Name: "Alice", Age: 30}
    data, err := codec.Encode(p)
    if err != nil {
        panic(err)
    }
    fmt.Println("Encoded:", string(data))
    
    // 解码
    var p2 Person
    err = codec.Decode(data, &p2)
    if err != nil {
        panic(err)
    }
    fmt.Printf("Decoded: %+v\n", p2)
}

2. 使用编解码器注册表

package main

import (
    "fmt"
    "github.com/yourusername/encdec"
    "github.com/yourusername/encdec/json"
    "github.com/yourusername/encdec/xml"
)

func main() {
    // 创建注册表
    registry := encdec.NewRegistry()
    
    // 注册编解码器
    registry.Register("json", json.NewCodec())
    registry.Register("xml", xml.NewCodec())
    
    // 获取编解码器
    codec, err := registry.Get("json")
    if err != nil {
        panic(err)
    }
    
    // 使用编解码器...
}

自定义编解码器

你可以实现自己的编解码器：

package custom

import (
    "encoding/base64"
)

type Base64Codec struct{}

func (c *Base64Codec) Encode(v interface{}) ([]byte, error) {
    str, ok := v.(string)
    if !ok {
        return nil, fmt.Errorf("expected string, got %T", v)
    }
    return []byte(base64.StdEncoding.EncodeToString([]byte(str))), nil
}

func (c *Base64Codec) Decode(data []byte, v interface{}) error {
    ptr, ok := v.(*string)
    if !ok {
        return fmt.Errorf("expected *string, got %T", v)
    }
    
    decoded, err := base64.StdEncoding.DecodeString(string(data))
    if err != nil {
        return err
    }
    
    *ptr = string(decoded)
    return nil
}

// 然后可以这样注册使用
func main() {
    registry := encdec.NewRegistry()
    registry.Register("base64", &custom.Base64Codec{})
    
    // 使用base64编解码器...
}

高级特性

1. 编解码器选项

// 创建带选项的JSON编解码器
codec := json.NewCodec(
    json.WithIndent("  "),  // 缩进
    json.WithEscapeHTML(),  // 转义HTML
)

2. 中间件

// 创建一个记录日志的中间件
func loggingMiddleware(next encdec.Codec) encdec.Codec {
    return encdec.CodecFuncs{
        EncodeFunc: func(v interface{}) ([]byte, error) {
            fmt.Println("Encoding:", v)
            return next.Encode(v)
        },
        DecodeFunc: func(data []byte, v interface{}) error {
            fmt.Println("Decoding:", string(data))
            return next.Decode(data, v)
        },
    }
}

// 使用中间件
codec := loggingMiddleware(json.NewCodec())

最佳实践

1. 统一错误处理：对所有编解码操作进行统一的错误处理
2. 性能考虑：对于高性能场景，考虑复用编解码器实例
3. 内容协商：根据请求的Content-Type自动选择合适的编解码器
4. 安全考虑：解码时验证输入数据，防止恶意输入

总结

encdec库提供了一种灵活、统一的方式来处理各种数据格式的编解码操作。通过注册表机制，可以轻松扩展新的编解码器，而中间件模式则允许在不修改核心逻辑的情况下添加额外功能。

希望这个指南能帮助你快速上手使用encdec库！