query

提供了将 web 请求中的查询参数解析到结构体的操作。

type State int8

const (
    StateLocked State = iota+1
    StateDelete
)

// 实现 query.UnmarshalQueryer 接口
func (s *State) UnmarshalQuery(data string) error {
    switch data {
    case "locked":
        *s = StateLocked
    case "delete":
        *s = StateDelete
    default:
        return errors.New("无效的值")
    }
}

type struct Query {
    Page int `query:"page,1"`
    Size int `query:"size,20"`
    States []State `query:"state,normal"`
}

func handle(w http.ResponseWriter, r *http.Request) {
    q := &Query{}
    errors := query.Parse(r.URL.Query(), q)
    if len(errors) > 0 {
        // TODO
        return
    }

    // 请求参数为 /?page=1&size=2&state=normal,delete
    // 则 q 的值为
    // page = 1
    // size = 2
    // states = []State{StateLocked, StateDelete}
    //
    // 参数 state 也可使用以下方式
    // /?page=1&size=2&state=normal&normal=delete
}

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。

ParseWithLog 将查询参数解析至 v 中如果 queries 中的元素，实现了 [Unmarshaler] 或是 [encoding.TextUnmarshaler]，则会调用相应的接口解码。如果有错误，则调用 log 方法进行处理，log 原型如下： func(name string, err error) 其中的 name 表示查询参数名称，err 表示解析该参数时的错误信息。 v 只能是指针，如果是指针的批针，请注意接口的实现是否符合你的预期。 NOTE: ParseWithLog 适合在已经有错误处理方式的代码中使用，比如库的作者。一般情况下 [Parse] 会更佳合适。.

# Constants

Tag

Tag 在 struct tag 的标签名称.

# Interfaces

Unmarshaler

Unmarshaler 该接口实现在了将一些特定的查询参数格式转换成其它类型的接口比如一个查询参数格式如下： /path?state=locked 而实际上后端将 state 表示为一个数值： type State int8 const StateLocked State = 1 那么只要 State 实现 Unmarshaler 接口，就可以实现将 locked 转换成 1 的能力。 func (s *State) UnmarshalQuery(data string) error { if data == "locked" { *s = StateLocked } } 如果找不到 Unmarshaler 接口，会尝试去查找是否也实现了 encoding.TextUnmarshaler，所以如果对象有已经实现了 encoding.TextUnmarshaler，则不需要再去实现 Unmarshaler，除非两者的解码方式是不同的。 NOTE: 空值不会调用该接口。.

# README

query

版权

# Functions

# Constants

# Interfaces