如何正确配置 Gorilla/mux 实现静态文件与 API 路由共存

本文详解 gorilla/mux 中路由匹配顺序的关键影响,通过调整注册顺序使 `/api/*` 接口与根路径下静态资源(如 `./frontend/`)协同工作,避免因通配前缀 `/` 过早拦截导致 api 404。

Gorilla/mux 的路由匹配机制是严格按注册顺序进行最长前缀匹配的:一旦某条路由规则匹配成功(即使只是部分匹配),后续路由将不再被检查。在原始代码中,router.PathPrefix("/").Handle

r(...) 被最先注册,它会匹配所有请求(包括 /api/xxx),随后尝试在 ./frontend/ 目录中查找名为 api 或 api/abc 的文件——显然不存在,因此返回 404,API 处理函数根本不会被执行。

✅ 正确做法是:*将更具体的路由(如 `/api/)放在通配性更强的路由(如/`)之前**。以下是修复后的完整可运行示例:

package main

import (
    "fmt"
    "log"
    "net/http"
    "strconv"
    "github.com/gorilla/mux"
)

func main() {
    router := mux.NewRouter().StrictSlash(true)

    // ✅ 优先注册精确/高特异性 API 路由
    router.HandleFunc("/api", Abc).Methods("GET")
    router.HandleFunc("/api/abc", AbcIndex).Methods("GET")
    router.HandleFunc("/api/abc/{id}", AbcShow).Methods("GET")

    // ✅ 最后注册静态文件服务(通配最低优先级)
    router.PathPrefix("/").Handler(http.FileServer(http.Dir("./frontend/")))

    // 使用 http.ListenAndServe 直接传入 router(无需再套 http.Handle)
    log.Printf("Server starting on :3000...")
    log.Fatal(http.ListenAndServe(":3000", router))
}

func Abc(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "API Root!")
}

func AbcIndex(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Todo Index!")
}

func AbcShow(w http.ResponseWriter, r *http.Request) {
    vars := mux.Vars(r)
    id := vars["id"] // 注意:原代码中写的是 "todoId",但路径是 {id},应保持一致
    fmt.Fprintln(w, "Todo show:", id)
}

? 关键注意事项:

  • router.PathPrefix("/") 是最宽泛的匹配,必须置于最后
  • 建议为 API 路由显式添加 .Methods("GET") 等限制,提升安全性与语义清晰度;
  • 静态文件服务器默认不支持目录索引(如自动加载 index.html),若需该行为,可包装为 http.StripPrefix("/", http.FileServer(...)) 并确保 ./frontend/index.html 存在;
  • 路径变量名需与 {name} 完全一致(如 {id} → vars["id"]),原代码中 AbcShow 函数误用 "todoId",已修正;
  • http.Handle("/", router) 是冗余的(ListenAndServe 已直接使用 router),移除可避免潜在中间件干扰。

遵循此顺序原则,即可实现 / 下静态前端资源与 /api/* 后端接口的无缝共存。