bind

Documentation

Index

• Constants
• Variables
• type IBind
  • func Default(method, contentType string) IBind
• type IBindBody
• type IBindUri
• type IStructValidator

Constants

const (
	MiMeJSON              = "application/json"
	MiMeHTML              = "text/html"
	MiMeXML               = "application/xml"
	MiMeXML2              = "text/xml"
	MiMePlain             = "text/plain"
	MiMePOSTForm          = "application/x-www-form-urlencoded"
	MiMeMultipartPOSTForm = "multipart/form-data"
	MiMePROTOBUF          = "application/x-protobuf"
	MiMeMSGPACK           = "application/x-msgpack"
	MiMeMSGPACK2          = "application/msgpack"
	MiMeYAML              = "application/x-yaml"
)

最常见的数据格式的 Content-Type MIME。

Variables

var (
	JSON          = jsonBinding{}
	XML           = xmlBinding{}
	Form          = formBinding{}
	Query         = queryBinding{}
	FormPost      = formPostBinding{}
	FormMultipart = formMultipartBinding{}
	ProtoBuf      = protobufBinding{}
	MsgPack       = msgpackBinding{}
	YAML          = yamlBinding{}
	Uri           = uriBinding{}
	Header        = headerBinding{}
)

这些实现了 IBind 接口，可用于将请求中存在的数据绑定到struct实例。

var EnableDecoderDisallowUnknownFields = false

EnableDecoderDisallowUnknownFields 用于在JSON Decoder实例上调用DisallowUnknownFields方法。

当目标是结构并且输入包含与目标中任何未忽略的导出字段都不匹配的对象键时，DisallowUnknownFields会导致解码器返回错误。

var EnableDecoderUseNumber = false

EnableDecoderUseNumber 用于在JSON Decoder实例上调用UseNumber方法。

UseNumber使解码器将数字解组到接口{}中，作为数字而不是float64。

Types

type IBind

type IBind interface {
	Name() string
	Bind(*http.Request, interface{}) error
}

IBind 定义一个绑定接口，用于绑定请求中存在的数据（例如JSON请求正文，查询参数或POST形式)， 这个接口的实例将会被 *gin.context的 ShouldBind等方法调用。

func Default

func Default(method, contentType string) IBind

Default 根据HTTP方法和内容类型返回适当的 IBind 实例。

type IBindBody

type IBindBody interface {
	IBind
	BindBody([]byte, interface{}) error
}

IBindBody 从提供的字节而不是req.Body中读取正文。

type IBindUri

type IBindUri interface {
	Name() string
	BindUri(map[string][]string, interface{}) error
}

IBindUri 从uri中读取参数，实行绑定<params<参数>

type IStructValidator

type IStructValidator interface {
	// ValidateStruct 可以接收任何类型的数据，即使配置不正确，也永远不会panic。
	//  如果接收到的类型是切片，则应在每个元素上进行验证。
	//  如果接收到的类型不是struct或slice或array，则应跳过任何验证，并且必须返回nil。
	//  如果接收到的类型是 struct/*struct，则应执行验证。
	//  如果该结构体无效或验证本身失败，则应返回描述性错误。
	//  否则必须返回nil。
	ValidateStruct(interface{}) error
	// Engine 返回实现了 IStructValidator 接口的验证器。
	//  即返回 https://github.com/go-playground/validator/v10 这个验证器。
	Engine() interface{}
}

IStructValidator 参数验证接口，验证请求的参数。

gin的 defaultValidator 使用这个库 https://github.com/go-playground/validator/v10 实现了这个接口。

var Validator IStructValidator = &defaultValidator{}

Validator 是实现 IStructValidator 接口的默认验证器。

它内部是使用 https://github.com/go-playground/validator/v10 实现的。