Go / 系统课时

读取路径通配参数

读取路径通配参数

Go 1.22 及以上版本的 http.ServeMux 可以直接在路由模式中声明路径通配符,并通过 Request.PathValue 读取匹配结果。本节用单段资源 ID 和剩余路径两个场景,完成参数读取、类型转换以及非法输入处理。

学习目标

  • 使用 {name} 与 {name...} 声明并读取路径通配参数
  • 区分单段匹配与剩余路径匹配的适用场景
  • 对空值、格式错误和资源标识执行明确校验

用 ServeMux 声明通配路由

从 Go 1.22 开始,ServeMux 的模式可以包含命名通配符。{id} 只匹配一个路径段,适合用户 ID、订单号等单个资源标识;位于模式末尾的 {path...} 匹配后续剩余路径,适合文件路径或层级资源。

路由模式 请求路径示例 PathValue 结果
GET /users/{id} /users/42 id 为 42
GET /files/{path...} /files/docs/go/http.txt path 为 docs/go/http.txt

单段通配符不会跨越 /。因此 /users/42/detail 不属于 GET /users/{id};而剩余路径通配符可以一次取得多个路径段。

读取并验证路径参数

下面的完整程序注册两条路由,并使用 httptest 发起请求,使示例无需占用真实端口即可运行。用户 ID 会被转换成正整数;文件路径则保留其中的层级分隔符。

go
package main

import (
    "fmt"
    "net/http"
    "net/http/httptest"
    "strconv"
    "strings"
)

func main() {
    mux := http.NewServeMux()

    mux.HandleFunc("GET /users/{id}", func(w http.ResponseWriter, r *http.Request) {
        rawID := r.PathValue("id")
        // 路由正常匹配时单段通配符不会得到空段,这里仍保留防御性校验。
        if rawID == "" {
            http.Error(w, "missing user id", http.StatusBadRequest)
            return
        }

        id, err := strconv.ParseInt(rawID, 10, 64)
        if err != nil || id <= 0 {
            http.Error(w, "invalid user id", http.StatusBadRequest)
            return
        }
        fmt.Fprintf(w, "user-id=%d", id)
    })

    mux.HandleFunc("GET /files/{path...}", func(w http.ResponseWriter, r *http.Request) {
        path := strings.TrimSpace(r.PathValue("path"))
        if path == "" {
            http.Error(w, "missing file path", http.StatusBadRequest)
            return
        }
        fmt.Fprintf(w, "file-path=%s", path)
    })

    targets := []string{
        "/users/42",
        "/users/abc",
        "/files/docs/go/http.txt",
    }

    for _, target := range targets {
        req := httptest.NewRequest(http.MethodGet, target, nil)
        rec := httptest.NewRecorder()
        mux.ServeHTTP(rec, req)

        body := strings.TrimSpace(rec.Body.String())
        fmt.Printf("%s -> %d %s\n", target, rec.Code, body)
    }
}

预期输出

text
/users/42 -> 200 user-id=42
/users/abc -> 400 invalid user id
/files/docs/go/http.txt -> 200 file-path=docs/go/http.txt

路径值必须在处理器边界校验

PathValue 返回的是字符串,不会自动判断它是否满足业务约束。即使路由已经保证参数所在位置存在,处理器仍应负责类型、取值范围以及业务格式校验。例如数据库使用整数主键时,应先完成 ParseInt,不要把未经验证的路径字符串直接交给查询层。

调用不存在的通配符名称,例如在上述处理器中读取 r.PathValue("other"),得到的是空字符串。因此参数名称应与路由模式保持一致,必要的空值检查也能避免路由重构后产生隐蔽错误。

选择单段还是剩余路径

资源标识具有明确层级时,优先使用单段 {name},让路由自身约束 URL 结构。只有参数本身确实需要包含多个路径段时,才使用末尾的 {name...}。这样既能减少处理器中的字符串拆分,也能避免本应由路由拒绝的路径被业务代码误接受。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

读取路径通配参数

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通