golang数据绑定与验证插件库gbind的使用

gbind是一个封装通用参数解析和参数验证逻辑的Go库，可以最小化日常开发中的重复代码，用几行代码解决参数绑定和验证问题。

特性

• 基于tag信息将数据绑定到指定结构体

  • 内置HTTP请求路径、查询参数、表单、header、cookie绑定能力
  • 内置json绑定能力，使用encoding/json实现
  • 支持设置绑定字段的默认值
  • 支持自定义绑定解析逻辑

• 根据tag信息验证字段值

  • 依赖github.com/go-playground/validator实现验证
  • 支持自定义验证逻辑
  • 支持验证失败的自定义错误消息

使用示例

HTTP API请求参数绑定与验证

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"net/http/httptest"
	"net/url"
	"github.com/bdjimmy/gbind"
)

type Params struct {
	API    string `gbind:"http.path,default=/api/test"`
	Appkey string `gbind:"http.query.appkey,default=appkey-default"`
	Page   int    `gbind:"http.query.page,default=1"`
	Size   int    `gbind:"http.query.size,default=10"`
	Token  string `gbind:"http.cookie.Token" validate:"required" err_msg:"please login"`
	Host   string `gbind:"http.header.host,default=www.baidu.com"`
	Uids   []int  `gbind:"http.form.uids"`
}

func Controller(w http.ResponseWriter, r *http.Request) {
	var requestParams = &Params{}
	if _, err := gbind.BindWithValidate(context.Background(), requestParams, r); err != nil {
		w.WriteHeader(http.StatusBadRequest)
		return
	}
	bs, _ := json.MarshalIndent(requestParams, "", "\t")
	w.Write(bs)
}

func main() {
	w := httptest.NewRecorder()
	u, _ := url.Parse("http://gbind.baidu.com/api/test?appkey=abc&page=2")
	r := &http.Request{
		Method: http.MethodPost,
		Header: map[string][]string{
			"Host": {"gbind.baidu.com"},
		},
		PostForm: url.Values{
			"uids": {"1", "2", "3"},
		},
		URL: u,
	}
	r.AddCookie(&http.Cookie{
		Name:  "Token",
		Value: "foo-bar-andsoon",
	})

	Controller(w, r)

	fmt.Println(w.Result().Status)
	fmt.Println(w.Body.String())
}

自定义绑定逻辑

package main

import (
	"bytes"
	"context"
	"errors"
	"fmt"
	"reflect"
	"testing"
	"github.com/bdjimmy/gbind"
)

func TestRegisterBindFunc(t *testing.T) {
	g := gbind.NewGbind()
	g.RegisterBindFunc("simple", NewSimpleExecer)

	type Foo struct {
		Key string `gbind:"simple.key"`
	}
	f := &Foo{}
	_, err := g.Bind(context.WithValue(context.Background(), exprKey{}, "simple-k-d"), f, nil)
	if err != nil {
		t.Fatal(err)
	}
	fmt.Println(f.Key) // 输出: simple-k-d
}

type exprKey struct{}

func NewSimpleExecer(values [][]byte) (gbind.Execer, error) {
	n := len(values)
	if n != 2 {
		return nil, errors.New("syntax error: simple error")
	}
	switch {
	case bytes.Equal(values[1], []byte("key")):
		return &simpleKeyExecer{}, nil
	}
	return nil, fmt.Errorf("syntax error: not support simple %s", values[1])
}

type simpleKeyExecer struct{}

func (s *simpleKeyExecer) Exec(ctx context.Context, value reflect.Value, data interface{}, opt *gbind.DefaultOption) (context.Context, error) {
	err := gbind.TrySet(value, []string{ctx.Value(exprKey{}).(string)}, opt)
	return ctx, err
}

func (s *simpleKeyExecer) Name() string {
	return "simple.key"
}

自定义验证逻辑

package main

import (
	"testing"
	"github.com/bdjimmy/gbind"
	"github.com/go-playground/validator/v10"
)

func TestRegisterCustomValidation(t *testing.T) {
	g := gbind.NewGbind()

	g.RegisterCustomValidation("is-awesome", func(fl validator.FieldLevel) bool {
		return fl.Field().String() == "awesome"
	})

	type Foo struct {
		Appkey string `gbind:"http.query.appkey" validate:"is-awesome"`
	}
	f := &Foo{}
	req := NewReq().AddQueryParam("appkey", "awesome").R()
	_, err := g.BindWithValidate(context.Background(), f, req)
	if err != nil {
		t.Fatal(err)
	}
}

性能基准测试

• HTTP query+form参数绑定性能比较：

BenchmarkBind/gin-query-form-8         612357      1937 ns/op     304 B/op      20 allocs/op
BenchmarkBind/gbind-query-form-8       6981271     171.3 ns/op    200 B/op      5 allocs/op

• HTTP query+form+header参数绑定性能比较：

BenchmarkBind/gin-query-form-header-8   232152      5143 ns/op     736 B/op     53 allocs/op
BenchmarkBind/gbind-query-form-header-8 6673236    180.0 ns/op    232 B/op     5 allocs/op

支持的底层数据类型

• 基本数据类型：

  • int、int8、int16、int32、int64
  • uint、uint8、uint16、uint32、uint64
  • float32、float64
  • bool
  • string

• 其他数据类型：

  • 指针类型（包括多级指针）
  • 切片类型
  • 数组类型
  • time.Duration