- 分组路由
- 基本使用
- 批量注册
分组路由
gf
框架当然也支持分组路由的注册方式,可以给分组路由指定一个prefix
前缀(可选),在该分组下的所有路由注册都将注册在该路由前缀下。
接口文档:
func (s *Server) Group(prefix...string) *RouterGroup
func (d *Domain) Group(prefix...string) *RouterGroup
func (g *RouterGroup) ALL(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) GET(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) PUT(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) POST(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) DELETE(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) PATCH(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) HEAD(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) CONNECT(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) OPTIONS(pattern string, object interface{}, params...interface{})
func (g *RouterGroup) TRACE(pattern string, object interface{}, params...interface{})
// REST路由注册
func (g *RouterGroup) REST(pattern string, object interface{})
// 执行分组路由批量绑定
func (g *RouterGroup) Bind(items []GroupItem)
其中:
Group
方法用户创建一个分组路由对象,并且支持在指定域名对象上创建;Bind
方法用于批量路由注册,每一个路由注册项为Slice
类型的参数,且参数数量应该>=3,具体使用请见后续示例;REST
方法用户注册RESTful
风格的路由,需给定一个执行对象或者控制器对象;ALL
方法用于注册所有的HTTP Method
到指定的函数/对象/控制器上;- 其他以
HTTP Method
命名的方法用以绑定指定的HTTP Method
路由;
基本使用
package main
import (
"github.com/gogf/gf/g"
"github.com/gogf/gf/g/net/ghttp"
)
type Object struct {}
func (o *Object) Show(r *ghttp.Request) {
r.Response.Writeln("Object Show")
}
func (o *Object) Delete(r *ghttp.Request) {
r.Response.Writeln("Object REST Delete")
}
func Handler(r *ghttp.Request) {
r.Response.Writeln("Handler")
}
func HookHandler(r *ghttp.Request) {
r.Response.Writeln("Hook Handler")
}
func main() {
s := g.Server()
obj := new(Object)
group := s.Group("/api")
group.ALL ("*", HookHandler, ghttp.HOOK_BEFORE_SERVE)
group.ALL ("/handler", Handler)
group.ALL ("/obj", obj)
group.GET ("/obj/showit", obj, "Show")
group.REST("/obj/rest", obj)
s.SetPort(8199)
s.Run()
}
执行后,注册的路由表如下:
SERVER | ADDRESS | DOMAIN | METHOD | P | ROUTE | HANDLER | HOOK
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
default | :8199 | default | ALL | 2 | /api/* | main.HookHandler | BeforeServe
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
default | :8199 | default | GET | 3 | /api/obj/showit | main.(*Object).Show |
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
default | :8199 | default | ALL | 3 | /api/obj/delete | main.(*Object).Delete |
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
default | :8199 | default | DELETE | 3 | /api/obj/rest | main.(*Object).Delete |
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
default | :8199 | default | ALL | 3 | /api/obj/show | main.(*Object).Show |
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
default | :8199 | default | ALL | 2 | /api/handler | main.Handler |
|---------|---------|---------|--------|---|------------------|-------------------------|-------------|
批量注册
gf
框架的分组路由同时也支持批量的路由注册方式。
package main
import (
"github.com/gogf/gf/g"
"github.com/gogf/gf/g/net/ghttp"
)
type Object struct {}
func (o *Object) Show(r *ghttp.Request) {
r.Response.Writeln("Object Show")
}
func (o *Object) Delete(r *ghttp.Request) {
r.Response.Writeln("Object REST Delete")
}
func Handler(r *ghttp.Request) {
r.Response.Writeln("Handler")
}
func HookHandler(r *ghttp.Request) {
r.Response.Writeln("Hook Handler")
}
func main() {
s := g.Server()
obj := new(Object)
s.Group("/api").Bind([]ghttp.GroupItem{
{"ALL", "*", HookHandler, ghttp.HOOK_BEFORE_SERVE},
{"ALL", "/handler", Handler},
{"ALL", "/obj", obj},
{"GET", "/obj/showit", obj, "Show"},
{"REST", "/obj/rest", obj},
})
s.SetPort(8199)
s.Run()
}
执行后,注册的路由表和前一个示例一致。