-
Notifications
You must be signed in to change notification settings - Fork 1
/
form.go
121 lines (105 loc) · 3.15 KB
/
form.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// SPDX-FileCopyrightText: 2018-2024 caixw
//
// SPDX-License-Identifier: MIT
// Package form 用于处理 www-form-urlencoded 编码
//
// func read(ctx *web.Context) {
// vals := urls.Values{}
// ctx.Read(vals)
// }
//
// func write(ctx *web.Context) {
// vals := urls.Values{}
// vals.Add("name", "caixw")
// return web.Object(http.StatusOK, vals, nil)
// }
//
// ## form 标签
//
// 用户可以通过定义 form 标签自定义输出的名称,比如:
//
// type Username struct {
// Name string `form:"name"`
// Age int
// }
//
// 转换成 form-data 可能是以下样式:
//
// name=jjj&age=18
//
// 该方式对数据类型有一定限制:
// - 如果是 map 类型,要求键名类型必须为 string;
// - 如果是 array 或是 slice,则要求元素类型必须是 go 的基本数据类型,不能是 struct 类型;
// - 其它基本类型或是实现了 [encoding.TextUnmarshaler] 和 [encoding.TextMarshaler] 接口的类型;
//
// # 接口
//
// 对于复杂类型,用户可以自定义实现 [Marshaler] 和 [Unmarshaler] 接口进行编解码,
// 其功能与用户与 encoding/json 中的 Marshaler 和 Unmarshaler 接口相似。
//
// 与标准库中 http.Request.ParseForm 的不同点:
// - 标准库支持从查询参数中获取数据;
// - 当前包支持非 ascii 编码;
// - 当前包支持将数据映射到一个对象;
package form
import (
"io"
"net/url"
"github.com/issue9/mux/v8/header"
"github.com/issue9/web"
)
const Mimetype = header.FormData
// Marshaler 将一个普通对象转换成 form 类型
type Marshaler interface {
MarshalForm() ([]byte, error)
}
// Unmarshaler 将 form 类型转换成一个对象
type Unmarshaler interface {
UnmarshalForm([]byte) error
}
// Marshal 针对 www-form-urlencoded 内容的解码实现
//
// 按以下顺序解析内容:
// - 如果实现 [Marshaler] 接口,则调用该接口;
// - 如果实现 [encoding.TextMarshaler] 接口,则调用该接口;
// - 如果是 [url.Values] 对象,则调用其方法 Encode 解析;
// - 否则将对象的字段与 form-data 中的数据进行对比,可以使用 form 指定字段名。
func Marshal(_ *web.Context, v any) ([]byte, error) {
if m, ok := v.(Marshaler); ok {
return m.MarshalForm()
}
if vals, ok := v.(url.Values); ok {
return []byte(vals.Encode()), nil
}
vals, err := marshal(v)
if err != nil {
return nil, err
}
return []byte(vals.Encode()), nil
}
// Unmarshal 针对 www-form-urlencoded 内容的编码实现
//
// 按以下顺序解析内容:
// - 如果实现 [Unmarshaler] 接口,则调用该接口;
// - 如果是 [url.Values] 对象,则依次赋值每个对象;
// - 否则将对象的字段与 form-data 中的数据进行对比,可以使用 form 指定字段名。
func Unmarshal(r io.Reader, v any) error {
data, err := io.ReadAll(r)
if err != nil {
return err
}
if m, ok := v.(Unmarshaler); ok {
return m.UnmarshalForm(data)
}
vals, err := url.ParseQuery(string(data))
if err != nil {
return err
}
if obj, ok := v.(url.Values); ok {
for k, v := range vals {
obj[k] = v
}
return nil
}
return unmarshal(vals, v)
}