-
Notifications
You must be signed in to change notification settings - Fork 5
/
riveter.go
413 lines (344 loc) · 9.47 KB
/
riveter.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
package rivet
import (
"io"
"net/http"
"reflect"
)
var (
id_httpRequest = TypeIdOf((*http.Request)(nil))
id_HttpResponseWriter = TypeIdOf((*ResponseWriter)(nil))
id_ResponseWriter = TypeIdOf((*http.ResponseWriter)(nil))
id_Context = TypeIdOf((*Context)(nil))
id_Params = TypeIdOf(Params(nil))
id_MapStringInterface = TypeIdOf(map[string]interface{}(nil))
id_PathParams = TypeIdOf(PathParams(nil))
id_MapStringString = TypeIdOf(map[string]string(nil))
)
/**
TypeIdOf 返回 v 的类型签名地址, 转换为 uint 类型.
内部使用 reflect 获取类型地址.
示例:
获取 fmt.Stringer 接口类型签名:
var v *fmt.Stringer
_ = TypeIdOf(v)
// 或者
_ = TypeIdOf((*fmt.Stringer)(nil))
获取 reflect.Type 本身的类型签名:
var rt *reflect.Type
_ = TypeIdOf(rt) // reflect.Type 也是接口类型
// 或者
t := reflect.TypeOf(nil)
_ = TypeIdOf(&t)
获取函数的参数类型签名:
t := reflect.TypeOf(fmt.Println)
_ = TypeIdOf(t.In(0))
非接口类型:
var s string
_ = TypeIdOf(s) // 等同 TypeIdOf("")
var v AnyNotInterfaceType
_ = TypeIdOf(v)
*/
func TypeIdOf(v interface{}) uint {
t, ok := v.(reflect.Type)
if !ok {
t = reflect.TypeOf(v)
}
if t.Kind() == reflect.Ptr && t.Elem().Kind() == reflect.Interface {
t = t.Elem()
}
return uint(reflect.ValueOf(t).Pointer())
}
/**
Rivet 符合 Context 接口. 请使用 NewContext 生成实例.
*/
type Rivet struct {
Params
PathParams
val map[uint]interface{}
res ResponseWriter
req *http.Request
handler []interface{}
}
// NewContext 新建 *Rivet 实例实现的 Context.
func NewContext(res http.ResponseWriter, req *http.Request) Context {
c := new(Rivet)
c.res = NewResponseWriterFakeFlusher(res)
c.req = req
return c
}
// Request 返回生成 Context 的 *http.Request
func (c *Rivet) Request() *http.Request {
return c.req
}
// Response 返回生成 Context 的 http.ResponseWriter
func (c *Rivet) Response() http.ResponseWriter {
return c.res
}
// WriteString 向 http.ResponseWriter 写入 data.
func (c *Rivet) WriteString(data string) (int, error) {
return io.WriteString(c.res, data)
}
// GetParams 返回路由匹配时从 URL.Path 中提取的参数
func (c *Rivet) GetParams() Params {
c.copyParams(id_Params)
return c.Params
}
/**
PathParams 返回路由匹配时从 URL.Path 中提取的参数
此方法与 Scene/NewScene 配套使用.
*/
func (c *Rivet) GetPathParams() PathParams {
c.copyParams(id_PathParams)
return c.PathParams
}
/**
ParamsReceiver 逐个接收从 URL.Path 中提取的参数.
此方法把参数值 val 保存在 Params 字段中.
把原始参数值 text 保存在 PathParams 字段中.
*/
func (c *Rivet) ParamsReceiver(name, text string, val interface{}) {
if c.Params == nil {
c.Params = make(Params, 1)
//c.PathParams = make(PathParams, 1)
}
c.Params[name] = val
//c.PathParams[name] = text
}
// Handlers 设置 handler, 首次使用有效.
func (c *Rivet) Handlers(handler ...interface{}) {
if c.handler == nil {
c.handler = handler
}
}
/**
Get 以类型标识 t 为 key, 获取关联到 context 的变量.
如果未找到, 通常返回 nil, 特别的:
如果 t 代表 map[string]interface{}, 用 Params 标识再试一次.
如果 t 代表 map[string]string, 用 PathParams 标识再试一次.
这样做, 如果不用 Map 功能, 所写的 Handler 就不需要 import rivet.
*/
func (r *Rivet) Get(t uint) (v interface{}) {
v, _ = r.get(t)
return
}
func (r *Rivet) get(t uint) (interface{}, bool) {
// 优化预置类型
switch t {
case id_MapStringInterface, id_Params:
r.copyParams(id_Params)
return r.Params, true
case id_MapStringString, id_PathParams:
r.copyParams(id_PathParams)
return r.PathParams, true
case id_Context:
return r, true
case id_httpRequest:
return r.req, true
case id_ResponseWriter, id_HttpResponseWriter:
return r.res, true
}
i, ok := r.val[t]
if ok {
return i, true
}
return nil, false
}
/**
Map 等同 MapTo(v, TypeIdOf(v)). 以 v 的类型标识为 key.
Rivet 自动 Map 的变量类型有:
Context
Params
PathParams
ResponseWriter
http.ResponseWriter
*http.Request
*/
func (r *Rivet) Map(v interface{}) {
r.MapTo(v, TypeIdOf(v))
}
/**
MapTo 以 t 为 key 把变量 v 关联到 context. 相同 t 值只保留一个.
调用者也许会自己定义一个值, 注意不要和真实类型标识冲突.
否则会导致不可预计的错误.
*/
func (r *Rivet) MapTo(v interface{}, t uint) {
if r.val == nil {
r.val = make(map[uint]interface{}, 6)
}
r.val[t] = v
}
/**
Next 遍历 Handlers 保存的 handler, 通过 Invoke 调用.
如果 ResponseWriter.Written() 为 true, 终止遍历.
Next 最后会调用 ResponseWriter.Flush(), 清空 handler.
*/
func (c *Rivet) Next() {
var h interface{}
for {
if len(c.handler) == 0 || c.res.Written() {
break
}
h = c.handler[0]
c.handler = c.handler[1:]
c.Invoke(h)
}
c.res.Flush()
c.handler = nil
}
/**
Invoke 处理 handler.
参数:
handler 可以是任意值
如果 handler 可被调用, 准备相应参数, 并调用 handler.
否则 使用 Map 关联到 context.
返回:
如果 handler 可被调用, 但是无法获取其参数, 返回 false.
否则返回 true.
算法:
如果 handler 是函数或者是有 ServeHTTP 方法的对象, 准备参数并调用.
否则使用 Map 关联到 context.
ServeHTTP 支持泛类型, 当然包括 http.Handler 实例.
下列 handler 类型使用 switch 匹配, 参数直接传递, 未用 Get 从 context 获取:
func()
func(Context)
func(*http.Request)
func(ResponseWriter)
func(ResponseWriter, *http.Request)
func(http.ResponseWriter)
func(http.ResponseWriter, *http.Request)
func(map[string]interface{}, http.ResponseWriter, *http.Request)
func(Params, *http.Request)
func(Params, ResponseWriter)
func(Params, http.ResponseWriter)
func(Params, ResponseWriter, *http.Request)
func(Params, http.ResponseWriter, *http.Request)
func(map[string]string, http.ResponseWriter, *http.Request)
func(PathParams, *http.Request)
func(PathParams, ResponseWriter)
func(PathParams, http.ResponseWriter)
func(PathParams, ResponseWriter, *http.Request)
func(PathParams, http.ResponseWriter, *http.Request)
http.Handler
提示:
Invoke 未捕获可能产生的 panic, 需要使用者处理.
*/
func (c *Rivet) Invoke(handler interface{}) bool {
switch fn := handler.(type) {
default:
// 反射调用或者 Map 对象
fun := reflect.ValueOf(handler)
if fun.Kind() != reflect.Func {
fun = fun.MethodByName("ServeHTTP")
}
if fun.Kind() != reflect.Func {
c.Map(handler)
return true
}
t := fun.Type()
in := make([]reflect.Value, t.NumIn())
for i := 0; i < len(in); i++ {
val, ok := c.get(TypeIdOf(t.In(i)))
if !ok {
return false
}
in[i] = reflect.ValueOf(val)
}
if t.IsVariadic() {
fun.CallSlice(in)
} else {
fun.Call(in)
}
case http.Handler:
fn.ServeHTTP(c.res, c.req)
case func():
fn()
case func(Context):
fn(c)
case func(ResponseWriter):
fn(c.res)
case func(http.ResponseWriter):
fn(c.res)
case func(*http.Request):
fn(c.req)
case func(ResponseWriter, *http.Request):
fn(c.res, c.req)
case func(http.ResponseWriter, *http.Request):
fn(c.res, c.req)
case func(map[string]interface{}, http.ResponseWriter, *http.Request):
c.copyParams(id_Params)
fn(c.Params, c.res, c.req)
case func(Params, ResponseWriter, *http.Request):
c.copyParams(id_Params)
fn(c.Params, c.res, c.req)
case func(Params, http.ResponseWriter, *http.Request):
c.copyParams(id_Params)
fn(c.Params, c.res, c.req)
case func(Params, ResponseWriter):
c.copyParams(id_Params)
fn(c.Params, c.res)
case func(Params, http.ResponseWriter):
c.copyParams(id_Params)
fn(c.Params, c.res)
case func(Params, *http.Request):
c.copyParams(id_Params)
fn(c.Params, c.req)
// PathParams
case func(map[string]string, http.ResponseWriter, *http.Request):
c.copyParams(id_PathParams)
fn(c.PathParams, c.res, c.req)
case func(PathParams, ResponseWriter, *http.Request):
c.copyParams(id_PathParams)
fn(c.PathParams, c.res, c.req)
case func(PathParams, http.ResponseWriter, *http.Request):
c.copyParams(id_PathParams)
fn(c.PathParams, c.res, c.req)
case func(PathParams, ResponseWriter):
c.copyParams(id_PathParams)
fn(c.PathParams, c.res)
case func(PathParams, http.ResponseWriter):
c.copyParams(id_PathParams)
fn(c.PathParams, c.res)
case func(PathParams, *http.Request):
c.copyParams(id_PathParams)
fn(c.PathParams, c.req)
}
return true
}
// 兼容 NewContext, NewScene.
func (c *Rivet) copyParams(want uint) {
if want == id_Params && c.Params == nil {
c.Params = make(Params, len(c.PathParams))
for name, val := range c.PathParams {
c.Params[name] = val
}
return
}
if want == id_PathParams && c.PathParams == nil {
c.PathParams = make(PathParams, len(c.Params))
for name, _ := range c.Params {
c.Params[name] = c.Params.Get(name)
}
}
}
/**
Scene 支持 Handler 参数类型为 PathParams 的风格.
PathParams 省去了 URL.Path 参数转换的结果,
如果 Filter 中没有用到类型转换, 使用 Scene 是合适的.
*/
type Scene struct {
*Rivet
}
// NewScene 新建 *Scene 实例实现的 Context.
func NewScene(res http.ResponseWriter, req *http.Request) Context {
return Scene{NewContext(res, req).(*Rivet)}
}
/**
ParamsReceiver 逐个接收从 URL.Path 中提取的参数.
此方法把参数值 text 保存在 PathParams 字段中.
*/
func (c Scene) ParamsReceiver(name, text string, _ interface{}) {
if c.PathParams == nil {
c.PathParams = make(PathParams, 1)
}
c.PathParams[name] = text
}