Go：主流 web 框架中路由的实现原理

一、什么是路由

路由，就是 url 地址到业务处理代码的映射。当用户输入一个 url 地址时，服务器该知道该用户返回什么内容。比如，当用户点击登录时，服务器应该做登录相关的事情，并给用户返回登录成功或失败的页面。当用户点击退出时，服务器应该做和退出相关的事情（比如清理用户登录的数据），并返回给用户退出之后的页面。

一个 url 到一个具体的处理函数之间的映射叫做一条路由。

多条路由组成路由表。路由表主要用于路由查找，根据不同的路由表的组织形式，可以有不同的查找方法。最简单的路由表就是使用 map。直接以 key-value 的形式进行匹配即可。

给定一个 url，找到对应的处理函数的过程叫做路由查找。路由器就是用来管理路由表以及进行路由查找的。

所以，在 web 系统中一个路由系统由路由、路由表、路由匹配三部分功能组成。

二、基于映射表的路由实现

go 内建标准包 net/http 中路由的实现是基于映射表实现的。也是最简单的路由实现。本节我们就来看来 http 请求的处理流程以及内建包默认的路由实现原理。

2.1 http 的处理流程

首先，我们来看下 http 包是如何处理请求的。通过以下代码我们就能启动一个 http 服务，并处理请求：

import (
  "net/http"
)

func main() {
    // 指定路由
  http.Handle("/", &HomeHandler{})

  // 启动http服务
  http.ListenAndServe(":8000", nil)
}

type HomeHandler struct {}

// 实现ServeHTTP
func (h *HomeHandler) ServeHTTP(response http.ResponseWriter, request *http.Request) {
  response.Write([]byte("Hello World"))
}

当我们输入 http://localhost:8000/的时候，就会走到 HomeHandler 的 ServeHTTP 方法，并返回 Hello World。那这里为什么要给 HomeHandler 定义 ServeHTTP 方法呢？或者说为什么会走到 ServeHTTP 方法中呢？

我们顺着 http.ListenAndServe 方法的定义：

func ListenAndServe(addr string, handler Handler) error

发现第二个参数是个 Handler 类型，而 Handler 是一个定义了 ServeHTTP 方法的接口类型：

type Handler interface {
  ServeHTTP(ResponseWriter, *Request)
}

似乎有了一点点关联，HomeHandler 类型也实现了 ServeHTTP 方法。但我们在 main 函数中调用http.ListenAndServe(“:8000”, nil)的时候第二个参数传递的是 nil，那 HomeHandler 里的 ServeHTTP 方法又是如何被找到的呢？

我们接着再顺着源码一层一层的找下去可以发现，在/src/net/http/server.go 的第 1930 行有这么一段代码：

serverHandler{c.server}.ServeHTTP(w, w.req)

有个 serverHandler 结构体，包装了 c.server。这里的 c 是建立的 http 连接，而 c.server 就是在 http.ListenAndServe(“:8000”, nil)函数中创建的 server 对象：

func ListenAndServe(addr string, handler Handler) error {
  server := &Server{Addr: addr, Handler: handler}
  return server.ListenAndServe()
}

server 中的 Handler 就是 http.ListenAndServe(“:8000”, nil)传递进来的 nil。好，我们进入 serverHandler{c.server}.ServeHTTP(w, w.req)函数中再次查看，就可以发现如下代码：

func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request) {
  handler := sh.srv.Handler
  if handler == nil {
    handler = DefaultServeMux
  }
  ...

  handler.ServeHTTP(rw, req)
}

/src/net/http/server.go 的第 2859 行到 2862 行，就是获取到 server 中的 Handler，如果是 nil，则使用默认的 DefaultServeMux，然后调用了 hander.ServeHTTP 方法。

继续再看 DefaultServeMux 中的 ServeHTTP 方法，在/src/net/http/server.go 中的第 2416 行，发现有一行 h,_ := mux.Handler®和 h.ServeHTTP 方法。这就是通过请求的路径查找到对应的 handler，然后调用该 handler 的 ServeHTTP 方法。

func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request) {
  if r.RequestURI == "*" {
    if r.ProtoAtLeast(1, 1) {
      w.Header().Set("Connection", "close")
    }
    w.WriteHeader(StatusBadRequest)
    return
  }
  h, _ := mux.Handler(r)
  h.ServeHTTP(w, r)
}

在一开始的实例中，就是我们的 HomeHandler 的 ServeHTTP 方法。也就是说 ServeHTTP 方法是 net/http 包中规定好了要调用的，所以每一个页面处理函数都必须实现 ServeHTTP 方法。

同时也说明，net/http 包中的路由是在 DefaultServeMux 对象中实现的，该对象是一个 ServeMux 结构体类型，接下来我们看 ServeMux 路由的具体实现。

2.2 net/http 包中路由的实现

在 net/http 包中实现路由的机构提是 ServeMux，其结构定义如下。

type ServeMux struct {
  mu    sync.RWMutex
  m     map[string]muxEntry
  es    []muxEntry // slice of entries sorted from longest to shortest.
  hosts bool       // whether any patterns contain hostnames
}

结构体字段很简单，我们重点看 m 变量，是一个 map 类型，即 key-value 结构，就是我们所说的路由表。key 就是路由的路径，value 是一个 muxEntry 对象，muxEntry 结构如下：

type muxEntry struct {
  h       Handler
  pattern string
}

pattern 是对应的路径，h 就是对应的处理函数。当我们调用http.Handle(“/”, &HomeHandler{})�进行路由注册时候，实质上就是将路径和 HomeHandler 对象构建成一个 muxEntry 对象，然后加入到 ServeMux 的 m 中。

接下来我们再看路由的查找，既然路由表是有 map 实现的，那么路由的查找过程自然就是通过路径从 map 中查找对应的 muxEntry，然后获取对应的 handler 即可。该实现就是在/src/net/http/server.go 中的第 2416 行的 mux.Handler®进行的。

以上就是 net/http 包中自己路由的实现。非常简单，同时也意味着功能有限。比如不能对路由进行分组、不能限定路由的请求方法（GET、POST 或其他）、不能对路由加中间件等等。 这也就给第三方包提供了再次实现的机会。

三、基于正则表达式的路由实现

3.1 gorilla/mux 包简介

该包是基于正则表达式实现的路由。该路由支持分组、restful 风格路径的定义、绑定路由请求的方法（GET、POST 等）、限定路径使用 http 还是 https 协议等功能。我们看下其基本情况。

3.2 基本使用

由于该包支持的路由规则比较多，所以我们先从最简单的例子开始看一下基本使用，然后再通过分析其实现原理看各种规则是如何支持的。

package main

import (
  "fmt"
  "net/http"

  "github.com/gorilla/mux"
)
func main() {
  r := mux.NewRouter()
  r.HandleFunc("/", HomeHandler)
  r.HandleFunc("/products", ProductsHandler)
  //定义restful风格的路径，例如/product/12345
  r.HandleFunc("/product/{id:[0-9]+}", ProductHandler)

  http.ListenAndServe(":8000", r)
}

func HomeHandler(response http.ResponseWriter, request *http.Request) {
  response.Write([]byte("Hi, this is Home page"))
}

func ProductsHandler(response http.ResponseWriter, request *http.Request) {
  response.Write([]byte("Hi, this is Product page"))
}

func ProductHandler(response http.ResponseWriter, request *http.Request) {
  vars := mux.Vars(request)
    // 获取产品的ID值。
  id := vars["id"]

  response.Write([]byte("Hi, this is product:" + id))
}

3.3 实现原理分析

首先我们通过 mux.NewRouter()方法返回了一个 Router 结构体对象。该结构体对象也实现了 ServeHTTP 方法，在该方法中实现了对路由的匹配和转发。所以覆盖作为 http.ListenAndServe 的第二个参数，替代了默认的路由分发对象 DefaultServeMux。以下展示了 Router 的 ServeHTTP 方法对路由的匹配和分发部分的代码，其他代码省略。

func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request) {
    ...
  var match RouteMatch
  var handler http.Handler
    // 路由匹配
  if r.Match(req, &match) {
    handler = match.Handler
    req = requestWithVars(req, match.Vars)
    req = requestWithRoute(req, match.Route)
  }

  ...
    
  // 路由分发
  handler.ServeHTTP(w, req)
}

本质上是和默认的路由分发器 DefaultServeMux 的实现是一样的。不同的是路由的管理以及匹配上。

接下来我们看下 Router 结构体。如下：

这里我们只列出来核心的字段，省略了一些辅助字段。这里有几个主要的字段：

• Router 中的 routes：Route 切片类型，角色是路由表，存储所有的路由。
• **Route：**一个具体的路由，handler 字段存储的是具体的处理函数，同时每个路由的路径是在最后的 routeRegexp 结构体中的。
• **matchers 字段：**切片类型，存储了该路由下的所有要匹配的规则。matchers 的类型是一个 matcher 接口，定义了 Match 方法。其中 routeRegexp 结构体实现了该方法，所以一个 routeRegexp 实例就是一个 matcher。
• **routeRegexp 结构体：**该结构体代表了路由中具体的路径的匹配规则。将路由中的路径转换成对应的正则表达式，存储与 regexp 字段中。

routeRegexp 结构体中的主要字段分别如下：

• **template：**保存的是路由的路径模版。比如r.HandleFunc(“/product/{id:[0-9]+}”, ProductHandler)中，则是"/product/{id:[0-9]+}"
• **regexpType：**正则类型，目前支持 regexpTypePath、regexpTypeHost、regexpTypePrefix、regexpTypeQuery 四种类型。比如r.HandleFunc(“/product/{id:[0-9]+}”, ProductHandler)就是路径匹配 regexpTypePath。而r.Host(“www.example.com”)就是域名匹配 regexpTypeHost。稍后我们会一一介绍。
• **regexp：**是根据路由中的模版路径构造出来的正则表达式。以"/product/{id:[0-9]+}"为例，最终构造的正则表达式是 ^/product/(?P[0-9]+)$�
• reverse：
• **varsN：**是路径模式中花括号{}中的变量个数。以"/product/{id:[0-9]+}"为例，varsN 则等于[]{“id”}。
• **varsR：**是路径模式中每个花括号{}对应的正则表达式。以"/product/{id:[0-9]+}“为例，varsR 则等于[]{”¹+$“}。如果路由中是设置 r.HandleFunc(”/product/{id}“, ProductHandler)，varsR 的元素则是[]{”^[/]+�"}的正则表达式。

根据路由表及路由的结构，具体的路由匹配查找基本过程如下：第一步，从 Router.routes 开始依次循环第二步，从每个路由中的 matchers 中循环，看请求的路径是否符合 matchers 中的每一项规则，如果都匹配，则说明找到了该路由，否则继续步骤 1。

3.4 路由支持的功能及对应的正则

3.4.1 匹配特定域名或子域名

r := mux.NewRouter()
// Only matches if domain is "www.example.com".
r.Host("www.example.com")
// Matches a dynamic subdomain.
r.Host("{subdomain:[a-z]+}.example.com")

我们先看 r.Host(“www.example.com”)的路由。在 routeRegexp 结构体中，regexp 值会是正则表达式"^www.example.com$，regexpType 字段是 regexpTypeHost。同时赋值给 routeRegexpGroup 中的 host 字段。

从路由表 Router.routes 中依次匹配本次请求的时候，发现 route.regexpType 字段是域名的正则，则从请求中获取当前的 host，然后跟 routeRegexp.regexp 正则表达式进行匹配。如果匹配成功则继续匹配后面的路由，否则直接匹配失败。

再来看匹配子域名 r.Host(“{subdomain:[a-z]+}.example.com”)的情况。在 routeRegexp 结构体中，regexp 值会是正则表达式"^(?P[a-z]+).example.com$，regexpType 字段是 regexpTypeHost。同时赋值给 routeRegexpGroup 中的 host 字段。匹配过程和上述过程一样，不再重复介绍。

3.4.2 给路径增加前缀

r.PathPrefix("/products/")

顾名思义，就是只有路径中是以/products 为前缀的才能匹配到该路由。该路由的设置最终编译成的正则表达式是^/products。这里注意该表达式中结尾并没有结尾符号 $。其匹配过程和上述一致。

3.4.3 限制路由的请求方法（GET、POST 等）

r.Methods("GET", "POST")

对请求方法的限制 是不经过正则，而是将允许的方法（GET、POST）转换成一个 methodMatcher�类型，该类型本质上是一个字符串切片，并且实现了 Match 方法，也就是 matcher 接口。然后将其加入到该路由的 matchers 中，在路由匹配时看当前的请求是否满足该路由的这条规则。其定义如下：

type methodMatcher []string

func (m methodMatcher) Match(r *http.Request, match *RouteMatch) bool {
  return matchInArray(m, r.Method)
}

3.4.4 支持路由分组

userRouter := r.PathPrefix("/user").Subrouter()
userRouter.HandleFunc("/info", HomeHandler)

通过.Subrouter()函数就能实现一个子路由表，在该子路由表下注册的所有路由都会遵循子路由上的公共设置，比如前缀。如上述例子/info 的完整路径就是/user/info 指向 HomeHandler。

我们查看 Subrouter 函数的源码，实际上是新建了一个 Router 结构体，而 Router 结构体实现了 Match 函数，即 matcher，所以也会将该 matcher 加入到 r.PathPrefix 这个路由的 matchers 中。相当于在路由中有建了一个专属的路由表。以下是 Router 的 Match 函数实现，我们看到循环到该 matcher 时，循环子路由表的 routes，再对每个子路由依次进行匹配：

func (r *Router) Match(req *http.Request, match *RouteMatch) bool {
  for _, route := range r.routes {
    if route.Match(req, match) {
      // Build middleware chain if no error was found
      if match.MatchErr == nil {
        for i := len(r.middlewares) - 1; i >= 0; i-- {
          match.Handler = r.middlewares[i].Middleware(match.Handler)
        }
      }
      return true
    }
  }
    ...//省略代码
}

3.4.5 支持中间件

//  定义中间件
func loggingMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // Do stuff here
        log.Println(r.RequestURI)
        // Call the next handler, which can be another middleware in the chain, or the final handler.
        next.ServeHTTP(w, r)
    })
}

r := mux.NewRouter()
r.HandleFunc("/", HomeHandler)
// 使用中间件
r.Use(loggingMiddleware)

func HomeHandler(response http.ResponseWriter, request *http.Request) {
  response.Write([]byte("Hi, this is Home page"))
}

在该示例中，首先定义了一个中间件 loggingMIddleware，然后使用 Use 函数将中间件加入到了 Router 中。

中间件的实现原理实际上是将原本要执行的 handler 包装到中间件的 handler 中。先执行中间件的 handler 逻辑，然后再执行原本的 handler。以上述代码为例，会将 HomeHandler 传递给 loggingMiddleware 的 next 参数。执行的时候从第 4 行开始执行，最后才是第 7 行，即 HomeHandler 的代码逻辑。如下图：

四、基于 tries 结构的路由实现

4.1 gin 框架中的路由

大名鼎鼎的 gin 框架采用的就是前缀树结构实现的路由。我们先来看一下 gin 框架中路由是如何定义的。

package main

import (
  "github.com/gin-gonic/gin"
)
func main() {
  g := gin.New()
  
  g.POST("/abc/info", InfoHandler)
  g.POST("/abc/info/detail", InfoHandler)
  g.POST("/abc/list", HomeHandler)
  g.Run(":8000")
}

func HomeHandler(ctx *gin.Context) {
  ctx.Writer.Write([]byte("Hi, this is Home page"))
}

func InfoHandler(ctx *gin.Context) {
  ctx.Writer.Write([]byte("Hi, this is info"))
}

很简单，首先通过 gin.New()初始化一个 gin 对象 g，然后通过 g.POST 或 g.GET 等方法就可以注册路由。很明显，路由注册过程也限制了请求的方法。 当然，还有一个方法是允许任何请求方法都能访问该路径的，就是 Any：

g.Any("/", HomeHandler)

Any 方法本质上是定义了一组方法名，然后依次调用对应的方法将该路由进行注册，如下：

var  anyMethods = []string{
    http.MethodGet, http.MethodPost, http.MethodPut, http.MethodPatch,
    http.MethodHead, http.MethodOptions, http.MethodDelete, http.MethodConnect,
    http.MethodTrace,
  }

// Any registers a route that matches all the HTTP methods.
// GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE, CONNECT, TRACE.
func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoutes {
  for _, method := range anyMethods {
    group.handle(method, relativePath, handlers)
  }

  return group.returnObj()
}

4.2 前缀树路由的实现原理

相比较 map/hash 字典实现的优点：利用字符串公共前缀来减少查询时间，减少无谓的字符串比较

4.2.1 路由中限制请求方法的实现

我们先看 gin 框架中的路由是如何对请求方法做限制的。 在 gin 框架中，路由树的构建是基于方法的。每种方法一棵路由树。如下：

type methodTree struct {
  method string
  root   *node
}

type methodTrees []methodTree

例如，上述示例中的g.POST(“/abc/info”, InfoHandler)路由，只会注册到 POST 方法的路由树中。若通过 GET 方法请求该路径，则在搜索的时候，在 GET 方法的路由树中就找不到该路由。这样就起到了通过路由限制请求方法的作用。

而 g.Any 方法注册的路由，相当于在所有的方法路由中都注册了一遍，因此，使用任何方法都能找到对应的路由。

4.2.2 路由树节点的数据结构

前缀树中的路由都是基于这个 node 数据结构来进行构建的。其中包含了一个路由中的基本元素：路径 fullPath、对应的处理函数 handlers。其中 handlers 包含了中间件处理函数，因此这里使用一个 handlersChain 表示。另外一个关键字段是 children，具有相同路径前缀的子节点通过 children 节点来构成父、子关系。接下来我们路由树是如何基于 node 节点进行构建的。

4.2.3 路由树的构建

首先，我们看第一个路由的注册。

 g.POST("/abc/info", InfoHandler)

因为是第一个路由注册，路由树是空的。所以直接构建一个 node 节点，然后将该 node 节点作为 POST 方法路由树的根节点插入即可。如下图：

好，我们接着看接着注册第二个路由：

g.POST("/abc/info/detail", DetailHandler)

我们发现，这个路由的特点是和路由"/abc/info"有共同的前缀，所以会将该路由作为第一个路由的子节点放到 children 中。如下图：

这里主要有三个变化：一个是根节点的 priority 由 1 变成了 2；一个是 children 中多了一个子节点路由；最后一个是 indices 字段的值变成了"/“，这个是第一个子节点的 path 字段的第一个字符，用于匹配时索引使用。在子节点中，要注意的是 path 的值，因为前缀是”/abc/info"了，所以这里 path 是"/detail"。但 fullPath 依然是注册时完整的路径。

接下来，我们再注册第三个路由：

  g.POST("/abc/list", ListHandler)

这个路由的特点是和前两个路由有共同的前缀"/abc/“，所以首先会将现在的根节点进行拆分，拆分成”/abc/" 和"info"。而 info 和原来的"/abc/info/detail" 又有共同的前缀 info，所以原来的"/abc/info/detail"就变成了 info 的子节点。而"/abc/list"除去前缀"/abc/“后，剩余"list"子节点，作为”/abc/"的子节点。如下：

那么，按节点组成的路由树就如下所示：

这里，我们首先看根节点的变化：

• handlers 变为 nil。因为该节点不是一个具体的路径，只是一个前缀，所以具体的 handler 下移到了子节点 info 节点。
• path 变为了前缀"/abc/"。
• indices 字段值变为了"il"，其中 i 是第一个子节点中 path 字段的第一个字符，l 是第二个子节点中 path 字段的第一个字符。
• priority 字段变成 3：代表从自身开始及子节点共有 4 个。
• children 字段变成了两个直接子节点。
• fullPath 字段变为了"/abc/"。

其次，是从原根节点中拆分出一个 info 节点。最后是 detail 节点成为 info 节点的子节点。

以上就是路由树的构建过程。更细节的构造，有兴趣的同学可以查看源码进一步了解。

总结

本文总结了 3 中路由的实现。路由本质上就是将请求的路径和对应的处理函数一一对应。通过路径查找到处理函数的过程。不同框架基于不同的数据结构实现了路由表以及匹配过程。希望本文对大家理解 web 框架的路由有所帮助。
参考：https://xie.infoq.cn/article/0c2d65a7c72147dc457af5007

---

1. 0-9 ↩︎