name: 请求数据处理

sort: 4

获取参数

我们经常需要获取用户传递的数据,包括 Get、POST 等方式的请求,beego 里面会自动解析这些数据,你可以通过如下方式获取数据:

  • GetString(key string) string
  • GetStrings(key string) []string
  • GetInt(key string) (int64, error)
  • GetBool(key string) (bool, error)
  • GetFloat(key string) (float64, error)

使用例子如下:

  1. func (this *MainController) Post() {
  2. jsoninfo := this.GetString("jsoninfo")
  3. if jsoninfo == "" {
  4. this.Ctx.WriteString("jsoninfo is empty")
  5. return
  6. }
  7. }

如果你需要的数据可能是其他类型的,例如是 int 类型而不是 int64,那么你需要这样处理:

  1. func (this *MainController) Post() {
  2. id := this.Input().Get("id")
  3. intid, err := strconv.Atoi(id)
  4. }

更多其他的 request 的信息,用户可以通过 this.Ctx.Request 获取信息,关于该对象的属性和方法参考手册 Request

直接解析到 struct

如果要把表单里的内容赋值到一个 struct 里,除了用上面的方法一个一个获取再赋值外,beego 提供了通过另外一个更便捷的方式,就是通过 struct 的字段名或 tag 与表单字段对应直接解析到 struct。

定义 struct:

  1. type user struct {
  2. Id int `form:"-"`
  3. Name interface{} `form:"username"`
  4. Age int `form:"age"`
  5. Email string
  6. }

表单:

  1. <form id="user">
  2. 名字:<input name="username" type="text" />
  3. 年龄:<input name="age" type="text" />
  4. 邮箱:<input name="Email" type="text" />
  5. <input type="submit" value="提交" />
  6. </form>

Controller 里解析:

  1. func (this *MainController) Post() {
  2. u := user{}
  3. if err := this.ParseForm(&u); err != nil {
  4. //handle error
  5. }
  6. }

注意:

  • StructTag form 的定义和 renderform方法 共用一个标签
  • 定义 struct 时,字段名后如果有 form 这个 tag,则会以把 form 表单里的 name 和 tag 的名称一样的字段赋值给这个字段,否则就会把 form 表单里与字段名一样的表单内容赋值给这个字段。如上面例子中,会把表单中的 username 和 age 分别赋值给 user 里的 Name 和 Age 字段,而 Email 里的内容则会赋给 Email 这个字段。
  • 调用 Controller ParseForm 这个方法的时候,传入的参数必须为一个 struct 的指针,否则对 struct 的赋值不会成功并返回 xx must be a struct pointer 的错误。
  • 如果要忽略一个字段,有两种办法,一是:字段名小写开头,二是:form 标签的值设置为 -

获取 Request Body 里的内容

在 API 的开发中,我们经常会用到 JSONXML 来作为数据交互的格式,如何在 beego 中获取 Request Body 里的 JSON 或 XML 的数据呢?

  1. 在配置文件里设置 copyrequestbody = true
  2. 在 Controller 中
  1. func (this *ObjectController) Post() {
  2. var ob models.Object
  3. var err error
  4. if err = json.Unmarshal(this.Ctx.Input.RequestBody, &ob); err == nil {
  5. objectid := models.AddOne(ob)
  6. this.Data["json"] = "{\"ObjectId\":\"" + objectid + "\"}"
  7. } else {
  8. this.Data["json"] = err.Error()
  9. }
  10. this.ServeJSON()
  11. }

文件上传

在 beego 中你可以很容易的处理文件上传,就是别忘记在你的 form 表单中增加这个属性 enctype="multipart/form-data",否则你的浏览器不会传输你的上传文件。

文件上传之后一般是放在系统的内存里面,如果文件的 size 大于设置的缓存内存大小,那么就放在临时文件中,默认的缓存内存是 64M,你可以通过如下来调整这个缓存内存大小:

  1. beego.MaxMemory = 1<<22

或者在配置文件中通过如下设置:

  1. maxmemory = 1<<22

Beego 提供了两个很方便的方法来处理文件上传:

  • GetFile(key string) (multipart.File, *multipart.FileHeader, error)

    该方法主要用于用户读取表单中的文件名 the_file,然后返回相应的信息,用户根据这些变量来处理文件上传:过滤、保存文件等。

  • SaveToFile(fromfile, tofile string) error

    该方法是在 GetFile 的基础上实现了快速保存的功能 fromfile 是提交时候的 html 表单中的 name

  1. <form enctype="multipart/form-data" method="post">
  2. <input type="file" name="uploadname" />
  3. <input type="submit">
  4. </form>

保存的代码例子如下:

  1. func (c *FormController) Post() {
  2. f, h, err := c.GetFile("uploadname")
  3. if err != nil {
  4. log.Fatal("getfile err ", err)
  5. }
  6. defer f.Close()
  7. c.SaveToFile("uploadname", "static/upload/" + h.Filename) // 保存位置在 static/upload, 没有文件夹要先创建
  8. }

数据绑定

支持从用户请求中直接数据 bind 到指定的对象,例如请求地址如下

  1. ?id=123&isok=true&ft=1.2&ol[0]=1&ol[1]=2&ul[]=str&ul[]=array&user.Name=astaxie
  1. var id int
  2. this.Ctx.Input.Bind(&id, "id") //id ==123
  3. var isok bool
  4. this.Ctx.Input.Bind(&isok, "isok") //isok ==true
  5. var ft float64
  6. this.Ctx.Input.Bind(&ft, "ft") //ft ==1.2
  7. ol := make([]int, 0, 2)
  8. this.Ctx.Input.Bind(&ol, "ol") //ol ==[1 2]
  9. ul := make([]string, 0, 2)
  10. this.Ctx.Input.Bind(&ul, "ul") //ul ==[str array]
  11. user struct{Name}
  12. this.Ctx.Input.Bind(&user, "user") //user =={Name:"astaxie"}