GoFrame框架自建了非常强大的路由功能，提供了比任何同类框架更加出色的路由特性，支持流行的命名匹配规则、模糊匹配规则及字段匹配规则，并提供了优秀的优先级管理机制。

一个示例

在真正开启本章的核心内容之前，我们先来看一个简单的动态路由使用示例：

  1. package main
  3. import (
  4.     "github.com/gogf/gf/v2/net/ghttp"
  5.     "github.com/gogf/gf/v2/frame/g"
  6. )
  8. func main() {
  9.     s := g.Server()
  10.     s.BindHandler("/:name", func(r *ghttp.Request){
  11.        r.Response.Writeln(r.Router.Uri)
  12.     })
  13.     s.BindHandler("/:name/update", func(r *ghttp.Request){
  14.         r.Response.Writeln(r.Router.Uri)
  15.     })
  16.     s.BindHandler("/:name/:action", func(r *ghttp.Request){
  17.         r.Response.Writeln(r.Router.Uri)
  18.     })
  19.     s.BindHandler("/:name/*any", func(r *ghttp.Request){
  20.        r.Response.Writeln(r.Router.Uri)
  21.     })
  22.     s.BindHandler("/user/list/{field}.html", func(r *ghttp.Request){
  23.         r.Response.Writeln(r.Router.Uri)
  24.     })
  25.     s.SetPort(8199)
  26.     s.Run()
  27. }

以上示例中展示了goframe框架支持的三种模糊匹配路由规则，:name、*any、{field}分别表示命名匹配规则、模糊匹配规则及字段匹配规则。不同的规则中使用/符号来划分层级，路由检索采用深度优先算法，层级越深的规则优先级也会越高。我们运行以上示例，通过访问几个URL来看看效果：

  1. URL                                         结果
  2. http://127.0.0.1:8199/user/list/2.html      /user/list/{field}.html
  3. http://127.0.0.1:8199/user/update           /:name/update
  4. http://127.0.0.1:8199/user/info             /:name/:action
  5. http://127.0.0.1:8199/user                  /:name/*any

在这个示例中我们也可以看到，由于优先级的限制，路由规则/:name会被/:name/*any规则覆盖，将会无法被匹配到，所以在分配路由规则的时候，需要进行统一规划和管理，避免类似情况的产生。

注册规则

路由注册参数

最基础的路由绑定方法是BindHandler方法，我们来看一下之前一直使用的BindHandler的原型：

  1. func (s *Server) BindHandler(pattern string, handler interface{})

pattern参数

其中的pattern为路由注册规则字符串，在其他路由注册方法中也会使用到，参数格式如下：

  1. [HTTPMethod:]路由规则[@域名]

其中HTTPMethod（GET/PUT/POST/DELETE/PATCH/HEAD/CONNECT/OPTIONS/TRACE）和@域名为非必需参数，大部分场景下直接给定路由规则参数即可，BindHandler会自动绑定所有的请求方式，如果给定HTTPMethod，那么路由规则仅会在该请求方式下有效。@域名可以指定生效的域名名称，那么该路由规则仅会在该域名下生效。

BindHandler是最原生的路由注册方法，在大部分场景中，我们通常使用 分组路由 方式来管理理由，后续章节将会介绍：路由注册-分组路由。

handler参数

其中的handler参数通常用于指定路由函数，我们最基础的示例都是使用函数来注册路由，一个路由函数需要满足以下定义，即只要能接收请求对象ghttp.Request即可：

  1. func(r *ghttp.Request) {
  2.     // ...
  3. }

我们来看一个例子：

  1. package main
  3. import (
  4.     "github.com/gogf/gf/v2/net/ghttp"
  5.     "github.com/gogf/gf/v2/frame/g"
  6. )
  8. func main() {
  9.     s := g.Server()
  10.     // 该路由规则仅会在GET请求下有效
  11.     s.BindHandler("GET:/{table}/list/{page}.html", func(r *ghttp.Request){
  12.         r.Response.WriteJson(r.Router)
  13.     })
  14.     // 该路由规则仅会在GET请求及localhost域名下有效
  15.     s.BindHandler("GET:/order/info/{order_id}@localhost", func(r *ghttp.Request){
  16.         r.Response.WriteJson(r.Router)
  17.     })
  18.     // 该路由规则仅会在DELETE请求下有效
  19.     s.BindHandler("DELETE:/comment/{id}", func(r *ghttp.Request){
  20.         r.Response.WriteJson(r.Router)
  21.     })
  22.     s.SetPort(8199)
  23.     s.Run()
  24. }

其中返回的参数r.Router是当前匹配的路由规则信息，访问当该方法的时候，服务端会输出当前匹配的路由规则信息。执行后，我们在终端使用curl命令进行测试：

  1. $ curl -XGET http://127.0.0.1:8199/order/list/1.html
  2. {"Domain":"default","Method":"GET","Priority":3,"Uri":"/{table}/list/{page}.html"}
  4. $ curl -XGET http://127.0.0.1:8199/order/info/1
  5. Not Found
  7. $ curl -XGET http://localhost:8199/order/info/1
  8. {"Domain":"localhost","Method":"GET","Priority":3,"Uri":"/order/info/{order_id}"}
  10. $ curl -XDELETE http://127.0.0.1:8199/comment/1000
  11. {"Domain":"default","Method":"DELETE","Priority":2,"Uri":"/comment/{id}"}
  13. $ curl -XGET http://127.0.0.1:8199/comment/1000
  14. Not Found

精准匹配规则

精准匹配规则即未使用任何动态规则的规则，如：user、order、info等等这种确定名称的规则。在大多数场景下，精准匹配规则会和动态规则一起使用来进行路由注册(例如：/:name/list，其中层级1:name为命名匹配规则，层级2list是精准匹配规则)。

动态路由规则

动态路由规则分为三种：命名匹配规则、模糊匹配规则和字段匹配规则。动态路由的底层数据结构是由层级哈希表和双向链表构建的路由树，层级哈希表便于高效率地层级匹配URI；数据链表用于优先级控制，同一层级的路由规则按照优先级进行排序，优先级高的规则排在链表头。底层的路由规则与请求URI的匹配计算采用的是正则表达式，并充分使用了缓存机制，执行效率十分高效。

所有匹配到的参数都将会以Router参数的形式传递给业务层，可以通过ghttp.Request对象的以下方法获取匹配到的路由参数：

  1. func (r *Request) GetRouter(key string, def ...interface{}) *gvar.Var

也可以使用ghttp.Request.Get方法获取匹配到的路由参数。

命名匹配规则

使用:name方式进行匹配(name为自定义的匹配名称)，对URI指定层级的参数进行命名匹配（类似正则([^/]+)，该URI层级必须有值），对应匹配参数会被解析为Router参数并传递给注册的服务接口使用。

匹配示例1：

  1. rule: /user/:user
  3. /user/john                match
  4. /user/you                 match
  5. /user/john/profile        no match
  6. /user/                    no match

匹配示例2：

  1. rule: /:name/action
  3. /john/name                no match
  4. /john/action              match
  5. /smith/info               no match
  6. /smith/info/age           no match
  7. /smith/action             match

匹配示例3：

  1. rule: /:name/:action
  3. /john/name                match
  4. /john/info                match
  5. /smith/info               match
  6. /smith/info/age           no match
  7. /smith/action/del         no match

模糊匹配规则

使用*any方式进行匹配(any为自定义的匹配名称)，对URI指定位置之后的参数进行模糊匹配（类似正则(.*)，该URI层级可以为空），并将匹配参数解析为Router参数并传递给注册的服务接口使用。

匹配示例1：

  1. rule: /src/*path
  3. /src/                     match
  4. /src/somefile.go          match
  5. /src/subdir/somefile.go   match
  6. /user/                    no match
  7. /user/john                no match

匹配示例2：

  1. rule: /src/*path/:action
  3. /src/                     no match
  4. /src/somefile.go          match
  5. /src/somefile.go/del      match
  6. /src/subdir/file.go/del   match

匹配示例3：

  1. rule: /src/*path/show
  3. /src/                     no match
  4. /src/somefile.go          no match
  5. /src/somefile.go/del      no match
  6. /src/somefile.go/show     match
  7. /src/subdir/file.go/show  match
  8. /src/show                 match

字段匹配规则

使用{field}方式进行匹配(field为自定义的匹配名称)，可对URI任意位置的参数进行截取匹配（类似正则([\w\.\-]+)，该URI层级必须有值，并且可以在同一层级进行多个字段匹配），并将匹配参数解析为Router参数并传递给注册的服务接口使用。

匹配示例1：

  1. rule: /order/list/{page}.php
  3. /order/list/1.php          match
  4. /order/list/666.php        match
  5. /order/list/2.php5         no match
  6. /order/list/1              no match
  7. /order/list                no match

匹配示例2：

  1. rule: /db-{table}/{id}
  3. /db-user/1                     match
  4. /db-user/2                     match
  5. /db/user/1                     no match
  6. /db-order/100                  match
  7. /database-order/100            no match

匹配示例3：

  1. rule: /{obj}-{act}/*param
  3. /user-delete/10                match
  4. /order-update/20               match
  5. /log-list                      match
  6. /log/list/1                    no match
  7. /comment/delete/10             no match

动态路由示例

  1. package main
  3. import (
  4.     "github.com/gogf/gf/v2/net/ghttp"
  5.     "github.com/gogf/gf/v2/frame/g"
  6. )
  8. func main() {
  9.     s := g.Server()
  10.     // 一个简单的分页路由示例
  11.     s.BindHandler("/user/list/{page}.html", func(r *ghttp.Request){
  12.         r.Response.Writeln(r.Get("page"))
  13.     })
  14.     // {xxx} 规则与 :xxx 规则混合使用
  15.     s.BindHandler("/{object}/:attr/{act}.php", func(r *ghttp.Request){
  16.         r.Response.Writeln(r.Get("object"))
  17.         r.Response.Writeln(r.Get("attr"))
  18.         r.Response.Writeln(r.Get("act"))
  19.     })
  20.     // 多种模糊匹配规则混合使用
  21.     s.BindHandler("/{class}-{course}/:name/*act", func(r *ghttp.Request){
  22.         r.Response.Writeln(r.Get("class"))
  23.         r.Response.Writeln(r.Get("course"))
  24.         r.Response.Writeln(r.Get("name"))
  25.         r.Response.Writeln(r.Get("act"))
  26.     })
  27.     s.SetPort(8199)
  28.     s.Run()
  29. }

执行后，我们可以通过curl命令或者浏览器访问的方式进行测试，以下为测试结果：

  1. $ curl -XGET http://127.0.0.1:8199/user/list/1.html
  2. 1
  4. $ curl -XGET http://127.0.0.1:8199/user/info/save.php
  5. user
  6. info
  7. save
  9. $ curl -XGET http://127.0.0.1:8199/class3-math/john/score
  10. class3
  11. math
  12. john
  13. score

优先级控制

优先级控制按照深度优先策略，简要计算策略：

  1. 层级越深的规则优先级越高；
  2. 同一层级下，精准匹配优先级高于模糊匹配；
  3. 同一层级下，模糊匹配优先级：字段匹配 > 命名匹配 > 模糊匹配；

我们来看示例（左边的规则优先级比右边高）：

  1. /:name                   >            /*any
  2. /user/name               >            /user/:action
  3. /:name/info              >            /:name/:action
  4. /:name/:action           >            /:name/*action
  5. /:name/{action}          >            /:name/:action
  6. /src/path/del            >            /src/path
  7. /src/path/del            >            /src/path/:action
  8. /src/path/*any           >            /src/path