Golang表单数据解码到结构体的高效插件库formam的使用

formam是一个用于解码HTTP表单和查询参数的Go包，最低要求Go 1.12或更高版本。

安装

go get github.com/monoculum/formam/v3

特性

• 支持maps、structs和slices的无限嵌套
• 支持在值和map键中使用UnmarshalText()接口
• 支持的map键类型包括：string、int及其变体、uint及其变体、uintptr、float32、float64、bool、struct、custom types等
• 可以访问值为map、struct或slice的interface{}字段
• 通过UnmarshalText()方法解码格式为2006-01-02的time.Time
• 解码url.URL
• 无需显式指定索引即可追加到slice和array类型
• 为自定义类型注册函数

基本使用示例

在HTML表单中

• 使用.访问结构体字段（如struct.field1）
• 使用[<index>]访问特定的slice/array索引（如struct.array[0]），追加数据时不需要添加索引
• 使用[<key>]访问map键（如struct.map[es-ES]）

<form method="POST">
  <input type="text" name="Name" value="Sony" />
  <input type="text" name="Location.Country" value="Japan" />
  <input type="text" name="Location.City" value="Tokyo" />
  <input type="text" name="Products[0].Name" value="Playstation 4" />
  <input type="text" name="Products[0].Type" value="Video games" />
  <input type="text" name="Products[1].Name" value="TV Bravia 32" />
  <input type="text" name="Products[1].Type" value="TVs" />
  <input type="text" name="Founders[0]" value="Masaru Ibuka" />
  <input type="text" name="Founders[0]" value="Akio Morita" />
  <input type="text" name="Employees" value="90000" />
  <input type="text" name="public" value="true" />
  <input type="url" name="website" value="http://www.sony.net" />
  <input type="date" name="foundation" value="1946-05-07" />
  <input type="text" name="Interface.ID" value="12" />
  <input type="text" name="Interface.Name" value="Go Programming Language" />
  <input type="submit" />
</form>

在Go中

可以使用formam结构体标签确保表单值正确解组到结构体字段中。

type InterfaceStruct struct {
    ID   int
    Name string
}

type Company struct {
  Public     bool      `formam:"public"`
  Website    url.URL   `formam:"website"`
  Foundation time.Time `formam:"foundation"`
  Name       string
  Location   struct {
    Country  string
    City     string
  }
  Products   []struct {
    Name string
    Type string
  }
  Founders   []string
  Employees  int64

  Interface interface{}
}

func MyHandler(w http.ResponseWriter, r *http.Request) error {
  r.ParseForm()

  m := Company{
      // 尽管是接口字段，也可以访问其字段！
      Interface: &InterfaceStruct{},
  }
  dec := formam.NewDecoder(&formam.DecoderOptions{TagName: "formam"})
  return dec.Decode(r.Form, &m)
}

支持的类型

目标结构体中支持的类型包括：

• string
• bool
• int, int8, int16, int32, int64
• uint, uint8, uint16, uint32, uint64
• float32, float64
• slice, array
• struct 和 struct anonymous
• map
• interface{}
• time.Time
• url.URL
• custom types 到上述类型之一
• 上述类型的pointer

自定义解组

可以通过实现encoding.TextUnmarshaler接口来解组数据和map键。

如果表单发送多个值，则只有第一个值传递给UnmarshalText()，但如果名称以[]结尾，则会为所有值调用它。

自定义类型

可以使用RegisterCustomType()方法为自定义类型注册函数。这将适用于给定数量的字段或具有给定类型的所有字段。

除非使用PrefUnmarshalText选项，否则注册类型优先于UnmarshalText方法。

所有字段

decoder.RegisterCustomType(func(vals []string) (interface{}, error) {
        return time.Parse("2006-01-02", vals[0])
}, []interface{}{time.Time{}}, nil)

特定字段

package main

type Times struct {
    Timestamp   time.Time
    Time        time.Time
    TimeDefault time.Time
}

func main() {
    var t Timestamp

    dec := NewDecoder(nil)

    // for Timestamp field
    dec.RegisterCustomType(func(vals []string) (interface{}, error) {
            return time.Parse("2006-01-02T15:04:05Z07:00", vals[0])
    }, []interface{}{time.Time{}}, []interface{}{&t.Timestamp{}})

    // for Time field
    dec.RegisterCustomType(func(vals []string) (interface{}, error) {
                return time.Parse("Mon, 02 Jan 2006 15:04:05 MST", vals[0])
    }, []interface{}{time.Time{}}, []interface{}{&t.Time{}})

    // for field that not be Time or Timestamp, e.g. in this example, TimeDefault.
    dec.RegisterCustomType(func(vals []string) (interface{}, error) {
                return time.Parse("2006-01-02", vals[0])
    }, []interface{}{time.Time{}}, nil)

    dec.Decode(url.Values{}, &t)
}

注意事项

版本2兼容旧的map访问语法（map.key），但括号是访问map的首选方式（map[key]）。