路由层级注册

GF框架的层级路由注册方式灵感来源于PHP Laravel框架。

推荐使用路由层级注册方式,注册的路由代码更清晰直观。

GF框架的分组路由注册支持更加直观优雅层级的注册方式,以便于开发者更方便地管理路由列表。路由层级注册方式也是推荐的路由注册方式。

我们来看一个比较完整的示例,该示例中注册了使用到了中间件、HOOK以及不同HTTP Method绑定的路由注册:

  1. package main
  2. import (
  3. "net/http"
  4. "github.com/gogf/gf/frame/g"
  5. "github.com/gogf/gf/net/ghttp"
  6. )
  7. func MiddlewareAuth(r *ghttp.Request) {
  8. token := r.Get("token")
  9. if token == "123456" {
  10. r.Middleware.Next()
  11. } else {
  12. r.Response.WriteStatus(http.StatusForbidden)
  13. }
  14. }
  15. func MiddlewareCORS(r *ghttp.Request) {
  16. r.Response.CORSDefault()
  17. r.Middleware.Next()
  18. }
  19. func MiddlewareLog(r *ghttp.Request) {
  20. r.Middleware.Next()
  21. g.Log().Println(r.Response.Status, r.URL.Path)
  22. }
  23. func main() {
  24. s := g.Server()
  25. s.Use(MiddlewareLog)
  26. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  27. group.Middleware(MiddlewareAuth, MiddlewareCORS)
  28. group.GET("/test", func(r *ghttp.Request) {
  29. r.Response.Write("test")
  30. })
  31. group.Group("/order", func(group *ghttp.RouterGroup) {
  32. group.GET("/list", func(r *ghttp.Request) {
  33. r.Response.Write("list")
  34. })
  35. group.PUT("/update", func(r *ghttp.Request) {
  36. r.Response.Write("update")
  37. })
  38. })
  39. group.Group("/user", func(group *ghttp.RouterGroup) {
  40. group.GET("/info", func(r *ghttp.Request) {
  41. r.Response.Write("info")
  42. })
  43. group.POST("/edit", func(r *ghttp.Request) {
  44. r.Response.Write("edit")
  45. })
  46. group.DELETE("/drop", func(r *ghttp.Request) {
  47. r.Response.Write("drop")
  48. })
  49. })
  50. group.Group("/hook", func(group *ghttp.RouterGroup) {
  51. group.Hook("/*", ghttp.HOOK_BEFORE_SERVE, func(r *ghttp.Request) {
  52. r.Response.Write("hook any")
  53. })
  54. group.Hook("/:name", ghttp.HOOK_BEFORE_SERVE, func(r *ghttp.Request) {
  55. r.Response.Write("hook name")
  56. })
  57. })
  58. })
  59. s.SetPort(8199)
  60. s.Run()
  61. }

执行后,注册的路由列表如下:

  1. SERVER | DOMAIN | ADDRESS | METHOD | ROUTE | HANDLER | MIDDLEWARE
  2. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  3. default | default | :8199 | ALL | /* | main.MiddlewareLog | GLOBAL MIDDLEWARE
  4. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  5. default | default | :8199 | ALL | /api.v2/hook/* | main.main.func1.4.1 | HOOK_BEFORE_SERVE
  6. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  7. default | default | :8199 | ALL | /api.v2/hook/:name | main.main.func1.4.2 | HOOK_BEFORE_SERVE
  8. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  9. default | default | :8199 | GET | /api.v2/order/list | main.main.func1.2.1 | main.MiddlewareAuth,main.MiddlewareCORS
  10. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  11. default | default | :8199 | PUT | /api.v2/order/update | main.main.func1.2.2 | main.MiddlewareAuth,main.MiddlewareCORS
  12. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  13. default | default | :8199 | GET | /api.v2/test | main.main.func1.1 | main.MiddlewareAuth,main.MiddlewareCORS
  14. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  15. default | default | :8199 | DELETE | /api.v2/user/drop | main.main.func1.3.3 | main.MiddlewareAuth,main.MiddlewareCORS
  16. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  17. default | default | :8199 | POST | /api.v2/user/edit | main.main.func1.3.2 | main.MiddlewareAuth,main.MiddlewareCORS
  18. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|
  19. default | default | :8199 | GET | /api.v2/user/info | main.main.func1.3.1 | main.MiddlewareAuth,main.MiddlewareCORS
  20. |---------|---------|---------|--------|----------------------|---------------------|-----------------------------------------|