name: URL Building

sort: 7

URL Building

If it can match URLs, can Beego also generate them? Of course it can. To build a URL to a specific function you can use the URLFor() function. It accepts the name of the function of Controller as first argument and a number of keyword arguments, each corresponding to the variable part of the URL rule. Unknown variable parts are appended to the URL as query parameters. Here are some examples:

Here is the controller definition:

  1. type TestController struct {
  2.     web.Controller
  3. }
  5. func (this *TestController) Get() {
  6.     this.Data["Username"] = "astaxie"
  7.     this.Ctx.Output.Body([]byte("ok"))
  8. }
  10. func (this *TestController) List() {
  11.     this.Ctx.Output.Body([]byte("i am list"))
  12. }
  14. func (this *TestController) Params() {
  15.     this.Ctx.Output.Body([]byte(this.Ctx.Input.Params["0"] + this.Ctx.Input.Params["1"] + this.Ctx.Input.Params["2"]))
  16. }
  18. func (this *TestController) Myext() {
  19.     this.Ctx.Output.Body([]byte(this.Ctx.Input.Param(":ext")))
  20. }
  22. func (this *TestController) GetUrl() {
  23.     this.Ctx.Output.Body([]byte(this.URLFor(".Myext")))
  24. }

This is how you register the router:

  1. web.Router("/api/list", &TestController{}, "*:List")
  2. web.Router("/person/:last/:first", &TestController{})
  3. web.AutoRouter(&TestController{})

This is how you generate the url:

  1. web.URLFor("TestController.List")
  2. // Output /api/list
  4. web.URLFor("TestController.Get", ":last", "xie", ":first", "asta")
  5. // Output /person/xie/asta
  7. web.URLFor("TestController.Myext")
  8. // Output /Test/Myext
  10. web.URLFor("TestController.GetUrl")
  11. // Output /Test/GetUrl

This is how you use it in a template

beego has already registered the template function urlfor. You can use it like this:

  1. {{urlfor "TestController.List"}}
  2. // Output /api/list
  4. {{urlfor "TestController.Get" ":last" "xie" ":first" "asta"}}
  5. // Output /person/xie/asta

Why would you want to build URLs instead of hard-coding them into your templates? There are three good reasons for this:

  1. Reversing is often more descriptive than hard-coding the URLs. More importantly, it allows you to change URLs in one go, without having to remember to change URLs all over the place.
  2. URL building will handle escaping of special characters and Unicode data transparently for you, so you don’t have to deal with them.