控制器实现

基本介绍

结构化约束

控制器的输入与输出使用了结构体定义进行约束，结构化维护输入输出数据结构是推荐的方式。例如：

  1. // 账号唯一性检测请求参数，用于前后端交互参数格式约定
  2. type CheckPassportRequest struct {
  3.     Passport string
  4. }

虽然仅有一个参数，但也采用了结构化定义，我们直接查看该结构体便可得知该接口的输入参数格式，而不用进入代码中去分析，从而极大提高维护效率。

结构体转换

结构体转换可以使用GetStruct或者Parse方法，其中Parse同时可以执行数据校验。结构体转换方法的参数都可以给定一个结构体的空指针，内部会自动初始化结构体对象，转换失败（例如提交参数不存在）不会执行初始化。例如：

  1. var data *SignUpRequest
  2. // 这里没有使用Parse而是仅用GetStruct获取对象，
  3. // 数据校验交给后续的service层统一处理。
  4. if err := r.GetStruct(&data); err != nil {
  5.     response.JsonExit(r, 1, err.Error())
  6. }

数据校验

可以通过给结构体绑定v的标签进行设定校验规则以及定义的错误提示。例如：

  1. // 登录请求参数，用于前后端交互参数格式约定
  2. type SignInRequest struct {
  3.     Passport string `v:"required#账号不能为空"`
  4.     Password string `v:"required#密码不能为空"`
  5. }

数据传参

控制器负责接收、转换、校验、处理请求参数后，将所需的参数传递给调用的service层一个或者多个包方法，而不是直接将Request对象传递给service。例如：

  1. // 用户登录接口
  2. func (c *Controller) SignIn(r *ghttp.Request) {
  3.     var data *SignInRequest
  4.     if err := r.Parse(&data); err != nil {
  5.         response.JsonExit(r, 1, err.Error())
  6.     }
  7.     if err := user.SignIn(data.Passport, data.Password, r.Session); err != nil {
  8.         response.JsonExit(r, 1, err.Error())
  9.     } else {
  10.         response.JsonExit(r, 0, "ok")
  11.     }
  12. }

需要注意的是，其中的Session对象也是通过控制器传递给service。

在Go的HTTP请求流程中，不存在”全局变量”获取请求参数的方式，只有根据service的需要按需传递参数。

实现代码

https://github.com/gogf/gf-demos/blob/master/app/api/user/user.go

  1. package user
  3. import (
  4.     "github.com/gogf/gf-demos/app/service/user"
  5.     "github.com/gogf/gf-demos/library/response"
  6.     "github.com/gogf/gf/net/ghttp"
  7. )
  9. // 用户API管理对象
  10. type Controller struct{}
  12. // 注册请求参数，用于前后端交互参数格式约定
  13. type SignUpRequest struct {
  14.     user.SignUpInput
  15. }
  17. // 用户注册接口
  18. func (c *Controller) SignUp(r *ghttp.Request) {
  19.     var data *SignUpRequest
  20.     // 这里没有使用Parse而是仅用GetStruct获取对象，
  21.     // 数据校验交给后续的service层统一处理。
  22.     if err := r.GetStruct(&data); err != nil {
  23.         response.JsonExit(r, 1, err.Error())
  24.     }
  25.     if err := user.SignUp(&data.SignUpInput); err != nil {
  26.         response.JsonExit(r, 1, err.Error())
  27.     } else {
  28.         response.JsonExit(r, 0, "ok")
  29.     }
  30. }
  32. // 登录请求参数，用于前后端交互参数格式约定
  33. type SignInRequest struct {
  34.     Passport string `v:"required#账号不能为空"`
  35.     Password string `v:"required#密码不能为空"`
  36. }
  38. // 用户登录接口
  39. func (c *Controller) SignIn(r *ghttp.Request) {
  40.     var data *SignInRequest
  41.     if err := r.Parse(&data); err != nil {
  42.         response.JsonExit(r, 1, err.Error())
  43.     }
  44.     if err := user.SignIn(data.Passport, data.Password, r.Session); err != nil {
  45.         response.JsonExit(r, 1, err.Error())
  46.     } else {
  47.         response.JsonExit(r, 0, "ok")
  48.     }
  49. }
  51. // 判断用户是否已经登录
  52. func (c *Controller) IsSignedIn(r *ghttp.Request) {
  53.     if user.IsSignedIn(r.Session) {
  54.         response.JsonExit(r, 0, "ok")
  55.     } else {
  56.         response.JsonExit(r, 1, "")
  57.     }
  58. }
  60. // 用户注销/退出接口
  61. func (c *Controller) SignOut(r *ghttp.Request) {
  62.     if err := user.SignOut(r.Session); err != nil {
  63.         response.JsonExit(r, 1, "")
  64.     }
  65.     response.JsonExit(r, 0, "ok")
  66. }
  68. // 账号唯一性检测请求参数，用于前后端交互参数格式约定
  69. type CheckPassportRequest struct {
  70.     Passport string
  71. }
  73. // 检测用户账号接口(唯一性校验)
  74. func (c *Controller) CheckPassport(r *ghttp.Request) {
  75.     var data *CheckPassportRequest
  76.     if err := r.Parse(&data); err != nil {
  77.         response.JsonExit(r, 1, err.Error())
  78.     }
  79.     if data.Passport != "" && !user.CheckPassport(data.Passport) {
  80.         response.JsonExit(r, 1, "账号已经存在")
  81.     }
  82.     response.JsonExit(r, 0, "ok")
  83. }
  85. // 账号唯一性检测请求参数，用于前后端交互参数格式约定
  86. type CheckNickNameRequest struct {
  87.     Nickname string
  88. }
  90. // 检测用户昵称接口(唯一性校验)
  91. func (c *Controller) CheckNickName(r *ghttp.Request) {
  92.     var data *CheckNickNameRequest
  93.     if err := r.Parse(&data); err != nil {
  94.         response.JsonExit(r, 1, err.Error())
  95.     }
  96.     if data.Nickname != "" && !user.CheckNickName(data.Nickname) {
  97.         response.JsonExit(r, 1, "昵称已经存在")
  98.     }
  99.     response.JsonExit(r, 0, "ok")
  100. }
  102. // 获取用户详情
  103. func (c *Controller) Profile(r *ghttp.Request) {
  104.     response.JsonExit(r, 0, "", user.GetProfile(r.Session))
  105. }