Golang 语言 Web 框架 beego v2 之控制器方法和输入输出数据

简介: Golang 语言 Web 框架 beego v2 之控制器方法和输入输出数据

01

介绍


创建 beego 的控制器,首先要匿名组合 beego.Controller,beego.Controller实现了接口 beego.ControllerInterface,beego.ControllerInterface 定义了许多函数,这样我们创建的控制器就有了所有 beego.Controller 的方法,我们可以重写这些方法实现自己的业务逻辑。


type UserController struct {
    beego.Controller
}


02

控制器方法


beego.Controller 实现了所有 HTTP Method 对应的方法,例如Get(),Post(),Put(),Delete() 等。beego 默认支持 RESTful 请求方式,可以根据用户请求的 HTTP Method 执行对应的方法,用户可以重写这些方法实现自己的业务逻辑。


除了对应 HTTP Method 的方法之外,还有 Prepare() 和 Finish() 。其中,Prepare() 方法会在对应 HTTPMethod 的方法之前执行,用户可以重写 Prepare() 方法,实现一些预处理的业务逻辑;Finash() 方法会在对应 HTTP Method 的方法之后执行,用户可以重写 Finish() 方法,实现一些释放资源的业务逻辑。


Init(ct *context.Context, controllerName, actionName string, app interface{})

方法用于做初始化操作。


// Init generates default values of controller operations.
func (c *Controller) Init(ctx *context.Context, controllerName, actionName string, app interface{}) {
  c.Layout = ""
  c.TplName = ""
  c.controllerName = controllerName
  c.actionName = actionName
  c.Ctx = ctx
  c.TplExt = "tpl"
  c.AppController = app
  c.EnableRender = true
  c.EnableXSRF = true
  c.Data = ctx.Input.Data()
  c.methodMapping = make(map[string]func())
}


beego.ControllerInterface 的全部方法:


// ControllerInterface is an interface to uniform all controller handler.
type ControllerInterface interface {
  Init(ct *context.Context, controllerName, actionName string, app interface{})
  Prepare()
  Get()
  Post()
  Delete()
  Put()
  Head()
  Patch()
  Options()
  Trace()
  Finish()
  Render() error
  XSRFToken() string
  CheckXSRFCookie() bool
  HandlerFunc(fn string) bool
  URLMapping()
}


限于篇幅,其它一些方法,我们在用到时再介绍。


03

输入数据


接收请求参数:

用户通过 RESTful 请求方式接收数据,包括 Get、Post、Put、Delete 等,beego 可以自动解析这些数据。


GetString(key string, def ...string) string
GetStrings(key string, def ...[]string) []string
GetInt(key string, def ...int) (int, error)
GetInt8(key string, def ...int8) (int8, error)
GetUint8(key string, def ...uint8) (uint8, error)
GetInt16(key string, def ...int16) (int16, error)
GetUint16(key string, def ...uint16) (uint16, error)
GetInt32(key string, def ...int32) (int32, error)
GetUint32(key string, def ...uint32) (uint32, error)
GetInt64(key string, def ...int64) (int64, error)
GetUint64(key string, def ...uint64) (uint64, error)
GetBool(key string, def ...bool) (bool, error)
GetFloat(key string, def ...float64) (float64, error)


除了使用 beego 提供的方法接收请求数据,还可以使用以下方式接收。


u.Input().Get("username")


form 表单数据解析到 struct:

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


type user struct {
  Id int64 `form:"-"`
  Name string `form:"username"`
  Age uint32 `form:"age"`
  Gender string
}
func (u *UserController) Create() {
  // form 表单
  user := user{}
  err := u.ParseForm(&user)
  if err != nil {
     log.Fatalln(err.Error())
     return
  }
  // 输出
  fmt.Println(user)
  u.Redirect("/", 200)
}


获取Request Body 里的数据:

在 API 的开发中,我们经常会用到 JSON 或 XML 来作为数据交互的格式,在 beego 中获取Request Body中的JSON数据,需要在配置文件中设置:copyrequestbody=true


type user struct {
  Id int64 `form:"-"`
  Name string `form:"username"`
  Age uint32 `form:"age"`
  Gender string
}
func (u *UserController) Create() {
  // Request Body
  user := user{}
  err := json.Unmarshal(u.Ctx.Input.RequestBody, &user)
  if err != nil {
    log.Fatalln(err.Error())
    return
  }
  // 输出
  fmt.Println(user)
  u.Data["json"] = map[string]interface{}{"code": 200, "msg": "success"}
  u.ServeJSON()
}


文件上传:

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

  • GetFile(key string) (multipart.File, *multipart.FileHeader, error)
    该方法主要用于用户读取表单中的文件名,然后返回相应的信息,用户根据这些变量来处理文件上传:过滤、保存文件等。

  • SaveToFile(fromfile, tofile string) error
    该方法是在 GetFile 的基础上实现了快速保存的功能fromfile 是提交时候的 html 表单中的 name


注意事项:

  • form 表单中增加这个属性 enctype="multipart/form-data"
  • 文件上传之后一般是放在系统的内存里面,如果文件的 size 大于设置的缓存内存大小,那么就放在临时文件中,默认的缓存内存是 64M,你可以通过如下来调整这个缓存内存大小:
    web.MaxMemory = 1<<22
    或者在配置文件中通过如下设置:
    maxmemory = 1<<22
  • beego 的另外一个参数,MaxUploadSize 来限制最大上传文件大小——如果你一次上传多个文件,那么它限制的就是这些所有文件合并在一起的大小。


示例代码:


<form method="post" action="http://localhost:8080/v1/user/add" enctype="multipart/form-data">
    用户名:<input type="text" name="username"><br>
    年龄:<input type="text" name="age"><br>
    性别:<input type="text" name="Gender"><br>
    头像:<input type="file" name="avatar"><br>
    <input type="submit" value="注册">
</form>
func (u *UserController) Create() {
  // 上传文件
  f, h, err := u.GetFile("avatar")
  if err != nil {
    log.Fatalln(err.Error())
    return
  }
  defer f.Close()
  err = u.SaveToFile("avatar", "static/img/" + h.Filename)
  if err != nil {
    log.Println(err.Error())
    return
  }
  u.Redirect("/", 200)
}


绑定请求参数到指定对象:

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


http://localhost:8080/v1/user/add?uid=100&language[]=chinese&language[]=english&user.Gender=woman


示例代码:


type user struct {
  Id     int64  `form:"-"`
  Name   string `form:"username"`
  Age    uint32 `form:"age"`
  Gender string
}
func (u *UserController) Create() {
  // 数据绑定
  // 基本类型
  var uid int64
  err := u.Ctx.Input.Bind(&uid, "uid")
  if err != nil {
    log.Fatalln(err.Error())
    return
  }
  uidStr := strconv.FormatInt(uid, 10)
  u.Ctx.WriteString(uidStr)
  // 切片
  language := make([]string, 0, 2)
  err = u.Ctx.Input.Bind(&language, "language")
  if err != nil {
    log.Fatalln(err.Error())
    return
  }
  fmt.Println(language)
  // 结构体
  user := user{}
  err = u.Ctx.Input.Bind(&user, "user")
  if err != nil {
    log.Fatalln(err.Error())
    return
  }
  fmt.Println(user)
}


04

输出数据


除了简单的字符串输出之外,我们在开发 RESTful API 接口的时候,一般会使用 JSON 数据,beego 提供了两个方法,分别是

ServeJSON(encoding ...bool) 和 ServeJSONP()


调用 ServeJSON 之后,会设置 content-type 为 application/json,然后同时把数据进行 JSON 序列化输出。


调用 ServeJSONP 之后,会设置 content-type 为 application/javascript,然后同时把数据进行 JSON 序列化,然后根据请求的 callback 参数设置 jsonp 输出。


示例代码:


func (u *UserController) Create() {
  u.Data["json"] = map[string]interface{}{"code":200, "msg":"success"}
  u.ServeJSON()
}
func (u *UserController) Update() {
  u.Data["jsonp"] = map[string]interface{}{"code":200, "msg":"success"}
  u.ServeJSON()
}


05

总结


本文我们介绍了 beego 的控制器函数,其中包括对应 HTTP Method 的方法和 Init()、Prepare()、Finish() 等。还介绍了 beego 输入和输出数据的使用方法,并列举了相应的示例代码。如果想了解更多关于 beego 输入和输出数据的用法,请参阅官方文档。





目录
相关文章
|
5天前
|
设计模式 开发框架 数据库
Python Web开发主要常用的框架
【5月更文挑战第12天】Python Web开发框架包括Django、Flask、Tornado和Pyramid。Django适用于复杂应用,提供ORM、模板引擎等全套功能;Flask轻量级,易于扩展,适合小型至中型项目;Tornado擅长处理高并发,支持异步和WebSockets;Pyramid灵活强大,可适配多种数据库和模板引擎,适用于各种规模项目。选择框架需依据项目需求和技术栈。
122 2
|
1天前
|
缓存 监控 安全
Django框架在大型Web应用中的架构设计与实战
【5月更文挑战第18天】Django框架在构建大型Web应用中扮演重要角色,采用分层架构(数据、业务逻辑、表示层)和多应用组织模式,结合缓存策略(如Memcached、Redis)提升性能。通过异步处理、分布式部署提高响应速度和扩展性。关注数据分区、安全设计及监控日志,确保系统高效、稳定。Django为复杂业务提供坚实基础,助力打造卓越Web系统。
18 7
|
1天前
|
开发框架 中间件 数据库
Django 框架入门全攻略:轻松构建 Web 应用
【5月更文挑战第18天】本文是 Django 入门教程,介绍了如何使用 Django 构建 Web 应用。内容包括安装、项目与应用创建、模型定义、数据库迁移、视图编写、路由配置、模板系统、表单处理和中间件的使用。通过实例展示了 Django 基本流程,帮助初学者快速上手。Django 提供高效工具,便于开发者聚焦业务逻辑,轻松构建功能丰富的 Web 应用。
18 5
|
1天前
|
存储 缓存 API
Flask 框架在大型 Web 应用中的使用与挑战
【5月更文挑战第18天】Flask框架适用于快速开发轻量级Web应用,但用于大型应用时需应对性能、代码管理和团队协作的挑战。通过集成扩展处理复杂需求,使用蓝图组织代码,以及引入缓存优化性能,结合明确的代码规范和开发流程,可有效应对挑战,构建高效稳定的应用。
18 5
|
1天前
|
数据库连接 Python
Flask 框架入门与实践:构建你的第一个 Web 应用
【5月更文挑战第18天】本文介绍了使用 Flask 框架构建第一个 Web 应用的步骤。首先通过 `pip install Flask` 安装框架,然后编写基本的 Python 代码创建应用,包括定义路由和响应。示例展示如何显示 &quot;Hello, World!&quot;,并扩展到显示用户信息的功能。利用模板(如 `index.html`)可使页面更丰富。随着学习深入,可以利用 Flask 的更多特性,如表单处理和数据库连接,来构建更复杂的 Web 应用。本文旨在激发读者对 Flask 和 Web 开发的兴趣,鼓励不断探索和实践。
15 7
|
5天前
|
JavaScript 前端开发 数据可视化
Svelte Web 框架介绍
Svelte Web 框架介绍
8 0
|
5天前
|
前端开发 Java Spring
Java Web ——MVC基础框架讲解及代码演示(下)
Java Web ——MVC基础框架讲解及代码演示
13 1
|
5天前
|
设计模式 前端开发 网络协议
Java Web ——MVC基础框架讲解及代码演示(上)
Java Web ——MVC基础框架讲解及代码演示
8 0
|
5天前
|
机器学习/深度学习 JSON 编译器
C++ 资源大全:标准库、Web框架、人工智能等 | 最全整理
C++ 资源列表,内容包括: 标准库、Web应用框架、人工智能、数据库、图片处理、机器学习、日志、代码分析等
39 1
|
5天前
|
JSON Go 数据格式
golang学习7,glang的web的restful接口结构体传参
golang学习7,glang的web的restful接口结构体传参
http://www.vxiaotou.com