多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
## 路由设置 ### ## 正则路由 1、正则路由 为了用户更加方便的路由设置,beego 参考了 sinatra 的路由实现,支持多种方式的路由: ~~~ beego.Router(“/api/?:id”, &controllers.RController{}) ~~~ 默认匹配 //匹配 /api/123 :id = 123 可以匹配 /api/ 这个URL ~~~ beego.Router(“/api/:id”, &controllers.RController{}) ~~~ 默认匹配 //匹配 /api/123 :id = 123 不可以匹配 /api/ 这个URL ~~~ beego.Router(“/api/:id([0-9]+)“, &controllers.RController{}) ~~~ 自定义正则匹配 //匹配 /api/123 :id = 123 ~~~ beego.Router(“/user/:username([\w]+)“, &controllers.RController{}) ~~~ 正则字符串匹配 //匹配 /user/astaxie :username = astaxie ~~~ beego.Router(“/download/.”, &controllers.RController{}) ~~~ \*匹配方式 //匹配 /download/file/api.xml :path= file/api :ext=xml ~~~ beego.Router(“/download/ceshi/*“, &controllers.RController{}) ~~~ \*全匹配方式 //匹配 /download/ceshi/file/api.json :splat=file/api.json ~~~ beego.Router(“/:id:int”, &controllers.RController{}) ~~~ int 类型设置方式,匹配 :id为int 类型,框架帮你实现了正则 (\[0-9\]+) ~~~ beego.Router(“/:hi:string”, &controllers.RController{}) ~~~ string 类型设置方式,匹配 :hi 为 string 类型。框架帮你实现了正则 (\[\\w\]+) ~~~ beego.Router(“/cms_:id([0-9]+).html”, &controllers.CmsController{}) ~~~ 带有前缀的自定义正则 //匹配 :id 为正则类型。匹配 cms\_123.html 这样的 url :id = 123 ### 可以在 Controller 中通过如下方式获取上面的变量: ~~~ this.Ctx.Input.Param(":id") this.Ctx.Input.Param(":username") this.Ctx.Input.Param(":splat") this.Ctx.Input.Param(":path") this.Ctx.Input.Param(":ext") ~~~ ## 自定义方法及 RESTful 规则 上面列举的是默认的请求方法名(请求的 method 和函数名一致,例如 `GET` 请求执行 `Get` 函数,`POST` 请求执行 `Post` 函数),如果用户期望自定义函数名,那么可以使用如下方式: ~~~ beego.Router("/",&IndexController{},"*:Index") ~~~ 使用第三个参数,第三个参数就是用来设置对应 method 到函数名,定义如下 * `*`表示任意的 method 都执行该函数 * 使用 httpmethod:funcname 格式来展示 * 多个不同的格式使用 `;` 分割 * 多个 method 对应同一个 funcname,method 之间通过 `,` 来分割 以下是一个 RESTful 的设计示例: ~~~ beego.Router("/api/list",&RestController{},"*:ListFood") beego.Router("/api/create",&RestController{},"post:CreateFood") beego.Router("/api/update",&RestController{},"put:UpdateFood") beego.Router("/api/delete",&RestController{},"delete:DeleteFood") ~~~ 以下是多个 HTTP Method 指向同一个函数的示例: ~~~ beego.Router("/api",&RestController{},"get,post:ApiFunc") ~~~ 以下是不同的 method 对应不同的函数,通过 ; 进行分割的示例: ~~~ beego.Router("/simple",&SimpleController{},"get:GetFunc;post:PostFunc") ~~~ 可用的 HTTP Method: * \*: 包含以下所有的函数 * get: GET 请求 * post: POST 请求 * put: PUT 请求 * delete: DELETE 请求 * patch: PATCH 请求 * options: OPTIONS 请求 * head: HEAD 请求 如果同时存在 \* 和对应的 HTTP Method,那么优先执行 HTTP Method 的方法,例如同时注册了如下所示的路由: ~~~ beego.Router("/simple",&SimpleController{},"*:AllFunc;post:PostFunc") ~~~ 那么执行 `POST` 请求的时候,执行 `PostFunc` 而不执行 `AllFunc`。 > > > 自定义函数的路由默认不支持 RESTful 的方法,也就是如果你设置了 `beego.Router("/api",&RestController{},"post:ApiFunc")` 这样的路由,如果请求的方法是 `POST`,那么不会默认去执行 `Post` 函数。 ## ## 自动匹配 用户首先需要把需要路由的控制器注册到自动路由中: ~~~ beego.AutoRouter(&controllers.ObjectController{}) ~~~ 那么 beego 就会通过反射获取该结构体中所有的实现方法,你就可以通过如下的方式访问到对应的方法中: ~~~ /object/login   调用 ObjectController 中的 Login 方法 /object/logout  调用 ObjectController 中的 Logout 方法 ~~~ 除了前缀两个 `/:controller/:method` 的匹配之外,剩下的 url beego 会帮你自动化解析为参数,保存在 `this.Ctx.Input.Params` 当中: ~~~ /object/blog/2013/09/12  调用 ObjectController 中的 Blog 方法,参数如下:map[0:2013 1:09 2:12] ~~~ 方法名在内部是保存了用户设置的,例如 Login,url 匹配的时候都会转化为小写,所以,`/object/LOGIN` 这样的 `url` 也一样可以路由到用户定义的 `Login` 方法中。 现在已经可以通过自动识别出来下面类似的所有 url,都会把请求分发到 `controller` 的 `simple` 方法: ~~~ /controller/simple /controller/simple.html /controller/simple.json /controller/simple.xml ~~~ 可以通过 `this.Ctx.Input.Param(":ext")` 获取后缀名。 ## 注解路由 从 beego 1.3 版本开始支持了注解路由,用户无需在 router 中注册路由,只需要 Include 相应地 controller,然后在 controller 的 method 方法上面写上 router 注释(// @router)就可以了,详细的使用请看下面的例子: ~~~ // CMS API type CMSController struct {    beego.Controller } ​ func (c *CMSController) URLMapping() {    c.Mapping("StaticBlock", c.StaticBlock)    c.Mapping("AllBlock", c.AllBlock) } ​ ​ // @router /staticblock/:key [get] func (this *CMSController) StaticBlock() { ​ } ​ // @router /all/:key [get] func (this *CMSController) AllBlock() { ​ } ~~~ 可以在 `router.go` 中通过如下方式注册路由: ~~~ beego.Include(&CMSController{}) ~~~ beego 自动会进行源码分析,注意只会在 dev 模式下进行生成,生成的路由放在 “/routers/commentsRouter.go” 文件中。 这样上面的路由就支持了如下的路由: * GET /staticblock/:key * GET /all/:key 其实效果和自己通过 Router 函数注册是一样的: ~~~ beego.Router("/staticblock/:key", &CMSController{}, "get:StaticBlock") beego.Router("/all/:key", &CMSController{}, "get:AllBlock") ~~~ 同时大家注意到新版本里面增加了 URLMapping 这个函数,这是新增加的函数,用户如果没有进行注册,那么就会通过反射来执行对应的函数,如果注册了就会通过 interface 来进行执行函数,性能上面会提升很多。 ## namespace ~~~ //初始化 namespace ns := beego.NewNamespace("/v1",    beego.NSCond(func(ctx *context.Context) bool {        if ctx.Input.Domain() == "api.beego.me" {            return true       }        return false   }),    beego.NSBefore(auth),    beego.NSGet("/notallowed", func(ctx *context.Context) {        ctx.Output.Body([]byte("notAllowed"))   }),    beego.NSRouter("/version", &AdminController{}, "get:ShowAPIVersion"),    beego.NSRouter("/changepassword", &UserController{}),    beego.NSNamespace("/shop",        beego.NSBefore(sentry),        beego.NSGet("/:id", func(ctx *context.Context) {            ctx.Output.Body([]byte("notAllowed"))       }),   ),    beego.NSNamespace("/cms",        beego.NSInclude(            &controllers.MainController{},            &controllers.CMSController{},            &controllers.BlockController{},       ),   ), ) //注册 namespace beego.AddNamespace(ns) ~~~ 上面这个代码支持了如下这样的请求 URL