Beego的路由配置

路由设置

什么是路由设置呢?前面介绍的 MVC 结构执行时,介绍过 beego 存在三种方式的路由:固定路由、正则路由、自动路由,接下来详细的讲解如何使用这三种路由。
基础路由

从beego1.2版本开始支持了基本的RESTful函数式路由,应用中的大多数路由都会定义在 routers/router.go 文件中。最简单的beego路由由URI和闭包函数组成。
基本 GET 路由

beego.Get("/",func(ctx *context.Context){
         ctx.Output.Body([]byte("hello world"))
    })

基本 POST 路由

beego.Post("/alice",func(ctx *context.Context){
         ctx.Output.Body([]byte("bob"))
    })

注册一个可以响应任何HTTP的路由

beego.Any("/foo",func(ctx *context.Context){
         ctx.Output.Body([]byte("bar"))
    })

所有的支持的基础函数如下所示

 beego.Get(router, beego.FilterFunc)
    beego.Post(router, beego.FilterFunc)
    beego.Put(router, beego.FilterFunc)
    beego.Head(router, beego.FilterFunc)
    beego.Options(router, beego.FilterFunc)
    beego.Delete(router, beego.FilterFunc)
    beego.Any(router, beego.FilterFunc)

支持自定义的handler实现

有些时候我们已经实现了一些rpc的应用,但是想要集成到beego中,或者其他的httpserver应用,集成到beego中来.现在可以很方便的集成:

s := rpc.NewServer()
    s.RegisterCodec(json.NewCodec(), "application/json")
    s.RegisterService(new(HelloService), "")
    beego.Handler("/rpc", s)

beego.Handler(router, http.Handler)这个函数是关键,第一个参数表示路由URI,第二个就是你自己实现的http.Handler,注册之后就会把所有rpc作为前缀的请求分发到http.Handler中进行处理.

这个函数其实还有第三个参数就是是否是前缀匹配,默认是false, 如果设置了true,那么就会在路由匹配的时候前缀匹配,即/rpc/user这样的也会匹配去运行路由参数

后面会讲到固定路由,正则路由,这些参数一样适用于上面的这些函数
RESTful Controller 路由

在介绍这三种 beego 的路由实现之前先介绍 RESTful,我们知道 RESTful 是一种目前 API 开发中广泛采用的形式,beego 默认就是支持这样的请求方法,也就是用户 Get 请求就执行 Get 方法,Post 请求就执行 Post 方法。因此默认的路由是这样 RESTful 的请求方式。
固定路由

固定路由也就是全匹配的路由,如下所示:

    beego.Router("/", &controllers.MainController{})
    beego.Router("/admin", &admin.UserController{})
    beego.Router("/admin/index", &admin.ArticleController{})
    beego.Router("/admin/addpkg", &admin.AddController{})

如上所示的路由就是我们最常用的路由方式,一个固定的路由,一个控制器,然后根据用户请求方法不同请求控制器中对应的方法,典型的 RESTful 方式。
正则路由

为了用户更加方便的路由设置,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”) 获取后缀名。
注解路由

从beego1.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

    GET /v1/notallowed
    GET /v1/version
    GET /v1/changepassword
    POST /v1/changepassword
    GET /v1/shop/123
    GET /v1/cms/ 对应MainController、CMSController、BlockController中得注解路由

而且还支持前置过滤,条件判断,无限嵌套namespace

namespace的接口如下:

NewNamespace(prefix string, funcs …interface{})

**初始化namespace对象,下面这些函数都是namespace对象的方法,但是强烈推荐使用NS开头的相应函数注册,因为这样更容易通过gofmt工具看的更清楚路由的级别关系**
    NSCond(cond namespaceCond)
支持满足条件的就执行该namespace,不满足就不执行
    NSBefore(filiterList …FilterFunc)

    NSAfter(filiterList …FilterFunc)
**上面分别对应beforeRouter和FinishRouter两个过滤器,可以同时注册多个过滤器**
 NSInclude(cList …ControllerInterface)

    NSRouter(rootpath string, c ControllerInterface, mappingMethods …string)

    NSGet(rootpath string, f FilterFunc)

    NSPost(rootpath string, f FilterFunc)

    NSDelete(rootpath string, f FilterFunc)

    NSPut(rootpath string, f FilterFunc)

    NSHead(rootpath string, f FilterFunc)

    NSOptions(rootpath string, f FilterFunc)

    NSPatch(rootpath string, f FilterFunc)

    NSAny(rootpath string, f FilterFunc)

    NSHandler(rootpath string, h http.Handler)

    NSAutoRouter(c ControllerInterface)

    NSAutoPrefix(prefix string, c ControllerInterface)

    上面这些都是设置路由的函数,详细的使用和上面beego的对应函数是一样的

    NSNamespace(prefix string, params …innnerNamespace)

    **嵌套其他namespace**

    ns := 
    beego.NewNamespace("/v1",
        beego.NSNamespace("/shop",
            beego.NSGet("/:id", func(ctx *context.Context) {
                ctx.Output.Body([]byte("shopinfo"))
            }),
        ),
        beego.NSNamespace("/order",
            beego.NSGet("/:id", func(ctx *context.Context) {
                ctx.Output.Body([]byte("orderinfo"))
            }),
        ),
        beego.NSNamespace("/crm",
            beego.NSGet("/:id", func(ctx *context.Context) {
                ctx.Output.Body([]byte("crminfo"))
            }),
        ),
    )

**下面这些函数都是属于*Namespace对象的方法:不建议直接使用,当然效果和上面的NS开头的函数是一样的,只是上面的方式更优雅,写出来的代码更容易看**   




    Cond(cond namespaceCond)

    支持满足条件的就执行该namespace,不满足就不执行,例如你可以根据域名来控制namespace

    Filter(action string, filter FilterFunc)

    action表示你需要执行的位置,beforeafter分别表示执行逻辑之前和执行逻辑之后的filter

    Router(rootpath string, c ControllerInterface, mappingMethods …string)

    AutoRouter(c ControllerInterface)

    AutoPrefix(prefix string, c ControllerInterface)

    Get(rootpath string, f FilterFunc)

    Post(rootpath string, f FilterFunc)

    Delete(rootpath string, f FilterFunc)

    Put(rootpath string, f FilterFunc)

    Head(rootpath string, f FilterFunc)

    Options(rootpath string, f FilterFunc)

    Patch(rootpath string, f FilterFunc)

    Any(rootpath string, f FilterFunc)

    Handler(rootpath string, h http.Handler)

    上面这些都是设置路由的函数,详细的使用和上面beego的对应函数是一样的

    Namespace(ns …*Namespace)多的例子代码```
//APIS
ns :=
    beego.NewNamespace("/api",
        //此处正式版时改为验证加密请求
        beego.NSCond(func(ctx *context.Context) bool {
            if ua := ctx.Input.Request.UserAgent(); ua != "" {
                return true
            }
            return false
        }),
        beego.NSNamespace("/ios",
            //CRUD Create(创建)、Read(读取)、Update(更新)和Delete(删除)
            beego.NSNamespace("/create",
                // /api/ios/create/node/
                beego.NSRouter("/node", &apis.CreateNodeHandler{}),
                // /api/ios/create/topic/
                beego.NSRouter("/topic", &apis.CreateTopicHandler{}),
            ),
            beego.NSNamespace("/read",
                beego.NSRouter("/node", &apis.ReadNodeHandler{}),
                beego.NSRouter("/topic", &apis.ReadTopicHandler{}),
            ),
            beego.NSNamespace("/update",
                beego.NSRouter("/node", &apis.UpdateNodeHandler{}),
                beego.NSRouter("/topic", &apis.UpdateTopicHandler{}),
            ),
            beego.NSNamespace("/delete",
                beego.NSRouter("/node", &apis.DeleteNodeHandler{}),
                beego.NSRouter("/topic", &apis.DeleteTopicHandler{}),
            )
        ),
    )

beego.AddNamespace(ns)

示例代码:

package routers

import (
    "fmt"
    "quickstart/controllers"
     "github.com/astaxie/beego"
         "github.com/astaxie/beego/context"
)
func init() {
    //默认路由
    beego.Router("/", &controllers.MainController{})
    //基本get路由
    beego.Get("/get", func(ctx *context.Context) {
        ctx.Output.Body([]byte("this is get"))
    })
    //基本post路由
    beego.Post("/post", func(ctx *context.Context) {
        ctx.Output.Body([]byte("this is post"))
    })
    //响应任何请求的路由
    beego.Any("/any", func(ctx *context.Context) {
        ctx.Output.Body([]byte("this is any"))
    })
    //加载命名空间的路由(推荐)
    newPath()
}

func newPath() {
    ns :=
        beego.NewNamespace("new",
            //  beego.NSCond(func(ctx *context.Context) bool {
            //      if ctx.Input.Domain() == "api.beego.me" {
            //          return true
            //      }
            //      return false
            //  }),
            beego.NSBefore(func(ctx *context.Context) {
                fmt.Println("这是前置过滤函数")
            }),
            beego.NSGet("/newget", func(ctx *context.Context) {
                ctx.Output.Body([]byte("this is new get"))
            }),
        )
    beego.AddNamespace(ns)
}
已标记关键词 清除标记
相关推荐
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页