去招摇过市Oauth2验证样本

Question

https://github.com/go-swagger/go-swagger/blob/master/examples/oauth2/restapi/configure_oauth_sample.go

有人能解释一下这段代码的用途吗？

// This demonstrates how to enrich and pass custom context keys.
// In this case, we cache the current responseWriter in context.
type customContextKey int8
const (
_ customContextKey = iota
ctxResponseWriter
)
// The middleware configuration is for the handler executors. These do not apply to the swagger.json document.
// The middleware executes after routing but before authentication, binding and validation
func setupMiddlewares(handler http.Handler) http.Handler {
ourFunc := func(w http.ResponseWriter, r *http.Request) {
rctx := context.WithValue(r.Context(), ctxResponseWriter, w)
handler.ServeHTTP(w, r.WithContext(rctx))
}
return http.HandlerFunc(ourFunc)
}

什么是丰富和传递自定义上下文键？

Answer 1

简而言之：这是将自定义中间件应用于你的go swagger应用程序提供的所有路由。该中间件在请求上下文中添加ResponseWriter作为自定义值。可以肯定的是，这与OAuth无关。

循序渐进：

context是一种特殊类型，它可以跨代码层携带请求范围的值、截止日期和取消信号。

type customContextKey int8

在这里，我们定义了一个未导出的上下文键类型。我们这样做的原因是，当我们将值添加到上下文中时，我们希望该值不会与其他可能与上下文交互的包设置的值冲突。如果我们只使用字符串"；customContextKey"；例如，某个其他包碰巧使用了相同的字符串。点击此处了解更多信息。

const (
_ customContextKey = iota
ctxResponseWriter
)

在这里，我们将创建一个名为ctxResponseWriter的customContextKey值，其值为1。请注意，我们忽略(_(iota的第一个值0，而使用下一个值1。这是用于在上下文中存储实际ResponseWriter值的类型安全密钥。

中间件是接受http.Handler并返回http.Handler的函数，它们可以组合在一起，并且是以通用方式向应用程序处理程序添加额外功能的模式。要获得更深入的理解，请查看制作和使用HTTP中间件。

func setupMiddlewares(handler http.Handler) http.Handler {
ourFunc := func(w http.ResponseWriter, r *http.Request) {
rctx := context.WithValue(r.Context(), ctxResponseWriter, w)
handler.ServeHTTP(w, r.WithContext(rctx))
}
return http.HandlerFunc(ourFunc)
}

这里的函数以这样的方式包装给定的处理程序：

• 从请求中提取上下文--r.Context()
• "富集的"；使用我们的新密钥和w ResponseWriter值——context.WithValue(..., ctxResponseWriter, w)
• 请求的上下文被更新后的上下文r.WithContext(rctx)替换
• 包装的处理程序将使用此更新的请求handler.ServeHTTP(w, ...)运行

在一些http中。处理程序，然后可以提取这样的值：

func someHandler(w http.ResponseWriter, r *http.Request) {
value, ok := r.Context().Value(ctxResponseWriter).(http.ResponseWriter)
if ok {
// we have the value!
}
}

这一定只是一个用法示例。像这样传递ResponseWriter是非常愚蠢的，因为它已经作为参数传递给了任何http。正如你在上面看到的那样，从应用程序的更深层次依赖它是糟糕的设计。例如，更好的用途可能是传递请求范围的记录器对象。