业务逻辑封装

基本介绍

职责划分

所有的业务逻辑实现均封装于service层中，不推荐实现于控制器api中。service层之间的包存在相互调用，不推荐api在代码层级相互调用。

数据校验

针对于注册逻辑，参数结构体以及校验规则的绑定并没有放置于控制器中，而是由service负责维护。因为该方法的参数复杂且复用性比较强，不仅仅在控制中需要校验，其他service调用时也需要执行该校验逻辑。

  1. // 注册输入参数
  2. type SignUpInput struct {
  3.     Passport  string `v:"required|length:6,16#账号不能为空|账号长度应当在:min到:max之间"`
  4.     Password  string `v:"required|length:6,16#请输入确认密码|密码长度应当在:min到:max之间"`
  5.     Password2 string `v:"required|length:6,16|same:Password#密码不能为空|密码长度应当在:min到:max之间|两次密码输入不相等"`
  6.     Nickname  string
  7. }

针对参数比较复杂且后续可能会变动的参数，推荐定义并使用结构体作为输入参数。

实现代码

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

  1. package user
  3. import (
  4.     "errors"
  5.     "fmt"
  6.     "github.com/gogf/gf-demos/app/model/user"
  7.     "github.com/gogf/gf/net/ghttp"
  8.     "github.com/gogf/gf/os/gtime"
  9.     "github.com/gogf/gf/util/gconv"
  10.     "github.com/gogf/gf/util/gvalid"
  11. )
  13. const (
  14.     USER_SESSION_MARK = "user_info"
  15. )
  17. // 注册输入参数
  18. type SignUpInput struct {
  19.     Passport  string `v:"required|length:6,16#账号不能为空|账号长度应当在:min到:max之间"`
  20.     Password  string `v:"required|length:6,16#请输入确认密码|密码长度应当在:min到:max之间"`
  21.     Password2 string `v:"required|length:6,16|same:Password#密码不能为空|密码长度应当在:min到:max之间|两次密码输入不相等"`
  22.     Nickname  string
  23. }
  25. // 用户注册
  26. func SignUp(data *SignUpInput) error {
  27.     // 输入参数检查
  28.     if e := gvalid.CheckStruct(data, nil); e != nil {
  29.         return errors.New(e.String())
  30.     }
  31.     // 昵称为非必需参数，默认使用账号名称
  32.     if data.Nickname == "" {
  33.         data.Nickname = data.Passport
  34.     }
  35.     // 账号唯一性数据检查
  36.     if !CheckPassport(data.Passport) {
  37.         return errors.New(fmt.Sprintf("账号 %s 已经存在", data.Passport))
  38.     }
  39.     // 昵称唯一性数据检查
  40.     if !CheckNickName(data.Nickname) {
  41.         return errors.New(fmt.Sprintf("昵称 %s 已经存在", data.Nickname))
  42.     }
  43.     // 将输入参数赋值到数据库实体对象上
  44.     var entity *user.Entity
  45.     if err := gconv.Struct(data, &entity); err != nil {
  46.         return err
  47.     }
  48.     // 记录账号创建/注册时间
  49.     entity.CreateTime = gtime.Now()
  50.     if _, err := user.Save(entity); err != nil {
  51.         return err
  52.     }
  53.     return nil
  54. }
  56. // 判断用户是否已经登录
  57. func IsSignedIn(session *ghttp.Session) bool {
  58.     return session.Contains(USER_SESSION_MARK)
  59. }
  61. // 用户登录，成功返回用户信息，否则返回nil; passport应当会md5值字符串
  62. func SignIn(passport, password string, session *ghttp.Session) error {
  63.     one, err := user.FindOne("passport=? and password=?", passport, password)
  64.     if err != nil {
  65.         return err
  66.     }
  67.     if one == nil {
  68.         return errors.New("账号或密码错误")
  69.     }
  70.     return session.Set(USER_SESSION_MARK, one)
  71. }
  73. // 用户注销
  74. func SignOut(session *ghttp.Session) error {
  75.     return session.Remove(USER_SESSION_MARK)
  76. }
  78. // 检查账号是否符合规范(目前仅检查唯一性),存在返回false,否则true
  79. func CheckPassport(passport string) bool {
  80.     if i, err := user.FindCount("passport", passport); err != nil {
  81.         return false
  82.     } else {
  83.         return i == 0
  84.     }
  85. }
  87. // 检查昵称是否符合规范(目前仅检查唯一性),存在返回false,否则true
  88. func CheckNickName(nickname string) bool {
  89.     if i, err := user.FindCount("nickname", nickname); err != nil {
  90.         return false
  91.     } else {
  92.         return i == 0
  93.     }
  94. }
  96. // 获得用户信息详情
  97. func GetProfile(session *ghttp.Session) (u *user.Entity) {
  98.     _ = session.GetStruct(USER_SESSION_MARK, &u)
  99.     return
  100. }