深入理解gorilla/mux：Go语言强大的HTTP路由库-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01199/article/details/148362406

深入理解gorilla/mux：Go语言强大的HTTP路由库

mux Package gorilla/mux is a powerful HTTP router and URL matcher for building Go web servers with 🦍 项目地址: https://gitcode.com/gh_mirrors/mu/mux

什么是gorilla/mux？

gorilla/mux是一个功能强大的HTTP请求路由器和调度器，用于Go语言的标准net/http包。它的名称"mux"代表"HTTP请求多路复用器"，与标准库中的http.ServeMux类似，但提供了更多高级功能和灵活性。

核心特性

gorilla/mux提供了许多超越标准库路由器的强大功能：

灵活的请求匹配：支持基于URL主机、路径、路径前缀、协议、头部、查询值、HTTP方法等多种匹配方式
URL变量支持：路径中可以包含变量，并支持正则表达式验证
URL反向生成：可以根据路由名称和参数生成URL
子路由器：支持嵌套路由，优化请求匹配
标准兼容：完全实现了http.Handler接口，与标准库无缝集成

基础使用

基本路由注册

func main() {
    r := mux.NewRouter()
    r.HandleFunc("/", HomeHandler)
    r.HandleFunc("/products", ProductsHandler)
    r.HandleFunc("/articles", ArticlesHandler)
    http.Handle("/", r)
}

这种用法与标准库的http.HandleFunc()类似，当请求URL匹配路径时，对应的处理函数会被调用。

路径变量

路径中可以定义变量，格式为{name}或{name:pattern}：

r := mux.NewRouter()
r.HandleFunc("/products/{key}", ProductHandler)
r.HandleFunc("/articles/{category}/", ArticlesCategoryHandler)
r.HandleFunc("/articles/{category}/{id:[0-9]+}", ArticleHandler)

变量值可以通过mux.Vars()获取：

vars := mux.Vars(request)
category := vars["category"]

高级路由匹配

gorilla/mux支持多种匹配条件：

主机匹配

r.Host("www.example.com")  // 精确匹配
r.Host("{subdomain:[a-z]+}.domain.com")  // 带变量的匹配

其他匹配器

r.PathPrefix("/products/")  // 路径前缀
r.Methods("GET", "POST")    // HTTP方法
r.Schemes("https")          // 协议
r.Headers("X-Requested-With", "XMLHttpRequest")  // 头部
r.Queries("key", "value")   // 查询参数

自定义匹配函数

r.MatcherFunc(func(r *http.Request, rm *RouteMatch) bool {
    return r.ProtoMajor == 0
})

子路由器

子路由器可以共享相同的匹配条件，优化路由匹配：

r := mux.NewRouter()
s := r.Host("www.example.com").Subrouter()

s.HandleFunc("/products/", ProductsHandler)
s.HandleFunc("/products/{key}", ProductHandler)

子路由器也支持路径前缀：

r := mux.NewRouter()
s := r.PathPrefix("/products").Subrouter()
s.HandleFunc("/", ProductsHandler)          // 匹配/products/
s.HandleFunc("/{key}/", ProductHandler)     // 匹配/products/{key}/

URL反向生成

路由可以命名并反向生成URL：

r.HandleFunc("/articles/{category}/{id:[0-9]+}", ArticleHandler).Name("article")

url, err := r.Get("article").URL("category", "technology", "id", "42")
// 生成URL: "/articles/technology/42"

也支持生成主机或路径部分：

host, err := r.Get("article").URLHost("subdomain", "news")
path, err := r.Get("article").URLPath("category", "technology", "id", "42")

中间件支持

gorilla/mux支持中间件，中间件按添加顺序执行：

func simpleMw(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        log.Println(r.RequestURI)
        next.ServeHTTP(w, r)
    })
}

r := mux.NewRouter()
r.HandleFunc("/", handler)
r.Use(simpleMw)

更复杂的认证中间件示例：

type authenticationMiddleware struct {
    tokenUsers map[string]string
}

func (amw *authenticationMiddleware) Middleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        token := r.Header.Get("X-Session-Token")
        if user, found := amw.tokenUsers[token]; found {
            next.ServeHTTP(w, r)
        } else {
            http.Error(w, "Forbidden", http.StatusForbidden)
        }
    })
}

r := mux.NewRouter()
r.HandleFunc("/", handler)
r.Use(amw.Middleware)