问题陈述

Question

问题陈述

我想将HTTP请求的生存期与在Web应用程序范围之外创建的上下文相关联。因此，我编写了以下中间件（使用github.com/go-chi/chi）：

func BindContext(c context.Context) func(http.Handler) http.Handler {
    return func(h http.Handler) http.Handler {
        return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
            h.ServeHTTP(w, r.WithContext(c))
        })
    }
}

在以下最小测试用例中使用中间件：

package main

import (
    "context"
    "net/http"

    "github.com/SentimensRG/ctx"
    "github.com/SentimensRG/ctx/sigctx"

    "github.com/go-chi/chi"
)

func greet(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
}

func BindContext(c context.Context) func(http.Handler) http.Handler {
    return func(h http.Handler) http.Handler {
        return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
            h.ServeHTTP(w, r.WithContext(c))
        })
    }
}

func main() {
    r := chi.NewMux()
    r.Use(BindContext(ctx.AsContext(sigctx.New())))
    r.Get("/", greet)
    http.ListenAndServe(":8080", r)
}

处理程序出现以下错误而感到恐慌：

2018/07/25 14:58:57 http: panic serving [::1]:56527: interface conversion: interface {} is nil, not *chi.Context
goroutine 35 [running]:
net/http.(*conn).serve.func1(0xc42014a0a0)
        /usr/local/go/src/net/http/server.go:1726 +0xd0
panic(0x12749c0, 0xc42014c200)
        /usr/local/go/src/runtime/panic.go:502 +0x229
github.com/go-chi/chi.(*Mux).routeHTTP(0xc4201180c0, 0x12fcf00, 0xc420166000, 0xc420160200)
        /Users/lthibault/go/src/github.com/go-chi/chi/mux.go:400 +0x2f3
github.com/go-chi/chi.(*Mux).(github.com/go-chi/chi.routeHTTP)-fm(0x12fcf00, 0xc420166000, 0xc420160200)
        /Users/lthibault/go/src/github.com/go-chi/chi/mux.go:368 +0x48
net/http.HandlerFunc.ServeHTTP(0xc420142010, 0x12fcf00, 0xc420166000, 0xc420160200)
        /usr/local/go/src/net/http/server.go:1947 +0x44
main.fail.func1.1(0x12fcf00, 0xc420166000, 0xc420160100)
        /Users/lthibault/go/src/github.com/lthibault/mesh/cmd/scratch/main.go:22 +0x77
net/http.HandlerFunc.ServeHTTP(0xc420148000, 0x12fcf00, 0xc420166000, 0xc420160100)
        /usr/local/go/src/net/http/server.go:1947 +0x44
github.com/go-chi/chi.(*Mux).ServeHTTP(0xc4201180c0, 0x12fcf00, 0xc420166000, 0xc420160000)
        /Users/lthibault/go/src/github.com/go-chi/chi/mux.go:81 +0x221
net/http.serverHandler.ServeHTTP(0xc420150000, 0x12fcf00, 0xc420166000, 0xc420160000)
        /usr/local/go/src/net/http/server.go:2694 +0xbc
net/http.(*conn).serve(0xc42014a0a0, 0x12fd1c0, 0xc42014c080)
        /usr/local/go/src/net/http/server.go:1830 +0x651
created by net/http.(*Server).Serve
        /usr/local/go/src/net/http/server.go:2795 +0x27b

优雅的解决方案

问题似乎来自Mux.routeHTTP，在此尝试从*chi.Context恢复r.Context()。看来r.WithContext不会将存储在请求上下文中的值转移到新上下文中。

显而易见的（尽管很丑陋）修复方法是：

func BindContext(c context.Context) func(http.Handler) http.Handler {
    return func(h http.Handler) http.Handler {
        return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
            rctx := r.Context().Value(chi.RouteCtxKey).(*chi.Context)
            c = context.WithValue(c, chi.RouteCtxKey, rctx)
            h.ServeHTTP(w, r.WithContext(c))
        })
    }
}

这有效，但是让我感到不安。我真的需要手动将每个相关值从r.Context()传递到要传递给r.WithContext()的上下文中吗？

这里有几种故障情况：

要传输许多不同的值时会发生什么？
不导出上下文键时会发生什么（按照Go中的建议）？
如果原始上下文在我传递的上下文之前终止，会发生什么？

（简而言之：不好！）

我的问题如下

是否有标准的“合并”上下文和r.WithContext中的现有上下文一起传递给r.Context？

Answer 1

您不应将传入请求中的上下文替换为不相关的上下文。对于初学者：

包上下文定义了上下文类型，该类型在API边界之间以及进程之间携带截止日期，取消信号和其他请求范围的值。

sigctx.New()在任何请求发生之前被调用，因此根据定义，它不是请求作用域的。几乎所有代码都希望在a）请求完成或b）客户端中止请求（通常是因为它不再对响应感兴趣）时取消请求上下文。您通过替换上下文打破了这一假设。您还将删除其他中间件先前可能已添加到上下文中的所有值。

似乎您希望中止对SIGINT或SIGTERM的请求。您应该将该取消条件添加到请求上下文中，而不是完全替换它。也许像这样：

func BindContext(c context.Context) func(http.Handler) http.Handler {
        return func(h http.Handler) http.Handler {
                return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
                        rCtx := r.Context()
                        ctx, cancel := context.WithCancel(rCtx)

                        go func() {
                                select {
                                case <-c.Done(): // SIGINT/SIGTERM
                                case <-rCtx.Done(): // Request finished or client aborted
                                }
                                cancel()
                        }()

                        h.ServeHTTP(w, r.WithContext(ctx))
                })
        }
}

更新：

要让用户配置上下文，请接受一个从请求上下文派生新上下文的函数（尽管用户也可以提供直接执行此操作的中间件）：

func WithContext(new func(context.Context) context.Context) func(http.Handler) http.Handler {
    return func(h http.Handler) http.Handler {
        return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
            r = r.WithContext(new(r.Context()))

            h.ServeHTTP(w, r)
        })  
    }   
}

Answer 2

似乎没有针对此目的的现成解决方案，但是github.com/SentimensRG/ctx为此提供了mergectx子包。

解决方案是使用mergectx.Merge。

Answer 3

我遇到了同样的问题，并且能够通过使用chi.NewRouteContext创建新的上下文来解决此问题。

正在使用httptest发出请求。您可以使用r.WithContext更新请求的上下文。

示例

w := httptest.NewRecorder()
r := httptest.NewRequest("GET", "/", nil)

rctx := chi.NewRouteContext()
rctx.URLParams.Add("key", "value")

r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, rctx))

handler := func(w http.ResponseWriter, r *http.Request) {
    key := chi.URLParam(r, "key") // "value"
}

handler(w, r)

请参见aapolkovsky的傻瓜：https://gist.github.com/aapolkovsky/1375348cab941e36c62da24a32fbebe7

如何在保留原始请求上下文值的同时将上下文传递给r.WithContext？

问题陈述

优雅的解决方案

我的问题如下

3 个答案: