go-swagger 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”而其他一些包恰好使用相同的字符串，则可能会发生这种情况。更多信息 here.

const (
    _ customContextKey = iota
    ctxResponseWriter
)

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

中间件是采用 http.Handler 和 return http.Handler 的函数，它们可以组合在一起，是一种向应用程序添加额外功能的模式 handler/s以一种通用的方式。如需更深入的了解，请检查 Making and Using HTTP Middleware.

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.Handler 中，您可能会像这样提取值：

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

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

go-swagger Oauth2 身份验证示例

go-swagger Oauth2 Authentication sample

go

oauth-2.0

swagger

go-swagger