短信验证码登录的思路和简单实现

/*
处理使用验证码登录的请求
*/
func HandlerUserSMSLogin(ctx *gin.Context) {
    var fo *models.VerifySMSLogin
    if err := ctx.ShouldBindJSON(&fo); err != nil {
        ctx.JSON(http.StatusBadRequest, gin.H{
            "code": 400,
            "msg":  "请求参数错误",
        })
        ctx.Abort()
    }

    /*
        在redis中验证，从redis中取出验证码，此时会有两种情况：
        1. redis中没有这个key
        2. redis中key对应的value不正确
    */
    key, verify, err := cache.VerifyCodeForUserSMSLogin(fo.Phone, fo.Code)
    if err != nil {
        fmt.Println("系统化错误", err)
        ctx.JSON(http.StatusNotFound, gin.H{
            "code": http.StatusNotFound,
            "msg":  "系统错误",
        })
    }

 user, err := logic.GetUserProfileByPhone(fo.Phone)
    if err != nil {
        fmt.Println("查询Mysql数据库错误")
    }
    if user.Phone == "" {
        // 创建用户
        if err := logic.CreateUserByPhone(fo.Phone); err != nil {
            fmt.Println("创建用户失败 返回系统错误")
            ctx.JSON(http.StatusBadRequest, gin.H{
                "code": http.StatusBadRequest,
                "msg":  "系统错误",
            })
            ctx.Abort()
        }
    }
    // 如果验证码正确且用户手机不为空
    if verify == true && user.Phone != "" {
        strToken, _ := JWT.GenToken(user.Id)
        fmt.Println("SMS验证通过,清除redis中的sms cache")
        _ = cache.DeleteKey(key)
        ctx.JSON(http.StatusOK, gin.H{
            "code":  http.StatusOK,
            "msg":   "登录成功",
            "token": strToken,
        })
    } else if verify == false {
        ctx.JSON(http.StatusNotFound, gin.H{
            "code": http.StatusNotFound,
            "msg":  "登录失败,请重试",
        })
    }
}
- - - - - - - - - 分割线 - - - - - - - 
// 在redis中 用于验证短信登录，手机号和验证码是否正确
func VerifyCodeForUserSMSLogin(phone, code string) (key string, res bool, err error) {
    key = fmt.Sprintf("%s%s", KeyUserSMSLoginSet, phone)
    val, err := rdb.Get(ctx, key).Result()
    if err != nil {
     // 使用Go操作redis数据库时如果尝试获取一个不存在的key，那么会返回一个redis.Nil的错误
        if errors.Is(err, redis.Nil) {
            return key, false, nil
        }
        fmt.Println("Key不存在", err)
        return key, false, err
    }
    if val != code {
        fmt.Println("Code ERROR 验证码不正确，登录失败")
        return key, false, nil
    }
    return key, true, nil
}

使用Lua脚本优化验证流程

概述

思路

步骤
1. 编写查询redis数据库中验证码剩余次数的功能lua脚本。在lua脚本中KEYS是一个全局变量，它是一个数组，用于存储Redis键的名称，可以通过KEYS[1]这个方法来获取对应的键。ARGV也是一个全局变量，也是一个数组，用于存储传递给脚本的参数值，同样使用ARGV[1]的方式访问。

下面是查询验证码次数功能的lua脚本，以及一个执行lua脚本的函数。

 local key     = KEYS[1]  --获取传递过来的KEY
  local countkey = "CACHE/users/smscount/" .. key  -- 拼接字符串
  local existed = redis.call("get", countkey) -- 查询这个key是否存在
  local ttl     = tonumber(redis.call("ttl", countkey))  --获取过期时间
  if existed ~= false then  -- 如果key存在的情况
      local count = redis.call('decr', countkey)  -- 剩余次数-1
      if count - 1 > 0 then  -- 如果还有剩余次数
          return 1  -- 约定返回1可以发送短信验证码
      else
          redis.call("set", countkey, -1)  -- 没有剩余次数了，将剩余次数置为-1
          redis.call("expire", countkey, ttl) -- 按照之前的过期时间设置为之前的值
          return -1 -- 约定返回-1不发送验证码
      end
  else
      redis.call("set", countkey, 5)  -- 没有这个key，设置key和剩余次数5次
      redis.call("expire", countkey, 600)  -- 设置过期时间是600s
      return 1 -- 约定返回1可以发送验证码
  end

//controller中处理发送验证码请求
func HandlerUserSMSForLoginV2(ctx *gin.Context){
  ...

  // 使用lua脚本
    result, err := cache.EvalLuaScript(fo.Phone, "", luaSMS)
    if err != nil {
        log.Println("Eval Lua Script ERROR", err)
        ctx.JSON(http.StatusNotFound, gin.H{
            "code": http.StatusNotFound,
            "msg":  "系统错误",
        })
        ctx.Abort()
        return
    }

  ...
}

- - - - - - - - - - 
// 执行lua脚本的函数
func EvalLuaScript(key string, value string, luaScript string) (interface{}, error) {
    result, err := rdb.Eval(ctx, luaScript, []string{key}, value).Result()
    if err != nil {
        return nil, err
    }
    return result, nil
}

2. 编写写入redis数据库手机号和验证码的lua脚本

local key = KEYS[1]  -- 获取传过来的key
 local setKey = "CACHE/users/sms/" .. key --拼接字符串 
 local value = ARGV[1] -- 获取传过来的value
 redis.call("set", setKey, value)  -- set key value
 redis.call("expire", setKey, 600)  -- 设置验证码过期时间600秒
 return 1 -- 约定返回1表示成功

3. 编写验证redis数据库中存储的手机号对应验证码的lua脚本

 local key = KEYS[1]
   local setKey = "CACHE/users/sms/" .. key
   local expectCode = ARGV[1]
   local existed = redis.call("get", setKey)
   if existed ~= false then
       local verify = redis.call("get", setKey)
       if verify == expectCode then
           redis.call("del", setKey)
           return 1
       else
           return -1
       end
   else
       return -1
   end

4. 测试。这里使用v2路径表示使用了lua脚本。

使用阿里云SMS服务

概述