Go 1.22中r.PathValue()在子路由无法获取参数的问题排查

原生http.ServeMux的路径参数是路由局部生效的：当eventRouter匹配到/{eventId}/photos/并转发请求给photoSubRouter时，子路由只能看到自己匹配的路径部分（比如/或/{photoId}），父路由解析到的eventId不会自动传递到子路由的请求对象中，因此r.PathValue("eventId")返回空字符串是正常的，这是原生ServeMux的设计限制，而非你的实现错误。

以下是三种可行的解决方式，可根据API规模选择：

方案一：通过上下文传递参数（推荐，保持路由职责分离） #

在父路由中添加中间件，提取eventId并存入请求上下文，再转发给子路由：

修改eventHandler.RegisterRoutes：

func (h *Handler) RegisterRoutes(router *http.ServeMux, subRouter *http.ServeMux) {
    router.HandleFunc("GET /{$}", h.handleEventsGet)
    router.HandleFunc("GET /{eventId}", h.handleEventGetByID)
    
    // 包装子路由，传递eventId到上下文
    router.Handle("GET /{eventId}/photos/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        eventId := r.PathValue("eventId")
        ctx := context.WithValue(r.Context(), "eventId", eventId)
        subRouter.ServeHTTP(w, r.WithContext(ctx))
    }))
    
    // 处理单张照片的路由同理
    router.Handle("GET /{eventId}/photos/{photoId}", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        eventId := r.PathValue("eventId")
        ctx := context.WithValue(r.Context(), "eventId", eventId)
        subRouter.ServeHTTP(w, r.WithContext(ctx))
    }))
}

修改照片处理函数从上下文取参数：

func (h *Handler) handlePhotosGetByEventID(w http.ResponseWriter, r *http.Request) {
    log.Println("Hello! You've requested the photos associated with this event")
    log.Println(r.URL.Path)
    
    eventId, ok := r.Context().Value("eventId").(string)
    if !ok {
        utils.WriteError(w, http.StatusBadRequest, errors.New("missing event ID"))
        return
    }
    
    id, err := strconv.Atoi(eventId)
    if err != nil {
        utils.WriteError(w, http.StatusBadRequest, err)
        return
    }
    
    log.Println("Event ID: ", id, " But also I'm photos")
    if err := utils.Encode(w, 200, map[string]string{"event": strconv.Itoa(id), "photos": "many"}); err != nil {
        utils.WriteError(w, http.StatusInternalServerError, err)
        return
    }
}

方案二：直接在父路由注册子资源路由（简单直接，适合小规模API） #

跳过嵌套ServeMux，直接在eventRouter中注册子资源路由，调用照片处理逻辑时手动传递eventId：

修改eventHandler.RegisterRoutes（注意参数改为接收photoHandler而非子路由）：

func (h *Handler) RegisterRoutes(router *http.ServeMux, photoHandler *photos.Handler) {
    router.HandleFunc("GET /{$}", h.handleEventsGet)
    router.HandleFunc("GET /{eventId}", h.handleEventGetByID)
    
    // 直接注册子资源路由
    router.HandleFunc("GET /{eventId}/photos/", func(w http.ResponseWriter, r *http.Request) {
        eventId := r.PathValue("eventId")
        id, err := strconv.Atoi(eventId)
        if err != nil {
            utils.WriteError(w, http.StatusBadRequest, err)
            return
        }
        photoHandler.HandlePhotosByEventID(w, r, id)
    })
    
    router.HandleFunc("GET /{eventId}/photos/{photoId}", func(w http.ResponseWriter, r *http.Request) {
        eventId := r.PathValue("eventId")
        photoId := r.PathValue("photoId")
        photoHandler.HandlePhotoByEventAndID(w, r, eventId, photoId)
    })
}

在photos.Handler中添加对应方法：

func (h *Handler) HandlePhotosByEventID(w http.ResponseWriter, r *http.Request, eventId int) {
    log.Println("Hello! You've requested the photos associated with this event")
    log.Println("Event ID: ", eventId)
    if err := utils.Encode(w, 200, map[string]string{"event": strconv.Itoa(eventId), "photos": "many"}); err != nil {
        utils.WriteError(w, http.StatusInternalServerError, err)
        return
    }
}

方案三：使用第三方路由库（适合大规模复杂API） #

如果你的API有大量嵌套路由需求，可以使用支持参数跨路由传递的第三方库，比如gorilla/mux或chi，这类库原生支持嵌套路由的参数继承：

以gorilla/mux为例：

import "github.com/gorilla/mux"

// 初始化根路由
rootRouter := mux.NewRouter()

// 独立photos路由
photoRouter := rootRouter.PathPrefix("/photos").Subrouter()
photoRouter.HandleFunc("/", photoHandler.handlePhotosGet).Methods("GET")
photoRouter.HandleFunc("/{photoId}", photoHandler.handlePhotoGetByID).Methods("GET")

// events路由及嵌套photos子路由
eventRouter := rootRouter.PathPrefix("/events").Subrouter()
eventRouter.HandleFunc("/", eventHandler.handleEventsGet).Methods("GET")
eventRouter.HandleFunc("/{eventId}", eventHandler.handleEventGetByID).Methods("GET")

// 嵌套子路由自动继承eventId参数
eventPhotoRouter := eventRouter.PathPrefix("/{eventId}/photos").Subrouter()
eventPhotoRouter.HandleFunc("/", photoHandler.handlePhotosGetByEventID).Methods("GET")
eventPhotoRouter.HandleFunc("/{photoId}", photoHandler.handlePhotoGetByID).Methods("GET")

在照片处理函数中直接获取参数：

func (h *Handler) handlePhotosGetByEventID(w http.ResponseWriter, r *http.Request) {
    vars := mux.Vars(r)
    eventId := vars["eventId"]
    id, err := strconv.Atoi(eventId)
    // ...后续逻辑不变
}

内容的提问来源于stack exchange，提问作者Recaptchow