首页 > 数据库 > Redis

基于Redis验证码发送及校验方案实现

来源：脚本之家

时间：2023-02-25 10:03:19 327浏览收藏

大家好，今天本人给大家带来文章《基于Redis验证码发送及校验方案实现》，文中内容主要涉及到发送、校验、Redis验证码，如果你对数据库方面的知识点感兴趣，那就请各位朋友继续看下去吧~希望能真正帮到你们，谢谢！

在我们的业务中，经常存在需要通过发送验证码、校验验证码来完成的一些业务逻辑，比如账号注册、找回密码、用户身份确认等。

在该类业务中，发送验证码的方式可以有各种各样，比如最常见的手机验证，最古老的邮箱验证，到现在相对少见的微信公众号、钉钉通知等；而验证码服务端存储的方式也可以各式各样，比如存储在关系型数据库中，当然也可以如本文标题所示，存储在Redis中。

既然已经预见到了各式各样的发送方式，也预见到了各式各样的存储方式，所以，虽然本文标题是基于Redis，但Redis其实只是其中的一种存储方式，如果需要，我们也应该可以和方便的切换到其它存储方式。

上代码前，我们先看下设计中的接口关系

在这里插入图片描述

ICodeHelper是最终提供发送验证码和校验验证码的最终接口，其关联了ICodeSender和ICodeStorage，ICodeSender即为验证码发送方式的约定接口，ICodeStorage则为验证码服务端持久化方式的约定接口。我们可以看到ICodeSender同样关联了IContentFormatter，因为作为发送方ICodeSender其实是不知道如何将要发送的内容组织成一段完整的文本内容的，这时候就需要IContentFormatter来组织文本内容，至于继承自IContentFormatter的IComplexContentFormatter，则只是IContentFormatter一个容器封装，毕竟对于不同的业务类型，我们需要组织成不同的文本内容，通过IComplexContentFormatter，我们可以将不同业务类型文本内容的组织过程，分散到不同的IContentFormatter中。

下面我们来看下上述接口的规范约定，考虑到代码的简便性，此处我们简单的将receiver接收方定义为了string，而不是泛型；业务标志bizFlag为了方便接入时无需调整代码，所以此处也没有将该值定义为枚举，而是同样定义成了通用性最强的string。

ICodeStorage

    /// 
    /// 校验码信息存储接口
    /// 
    public interface ICodeStorage
    {
        /// 
        /// 将校验码进行持久化，如果接收方和业务标志组合已经存在，则进行覆盖
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 
        Task SetCode(string receiver, string bizFlag, string code, TimeSpan effectiveTime);
        /// 
        /// 校验码错误次数+1，如果校验码已过期，则不进行任何操作
        /// 
        /// 接收方
        /// 业务标志
        /// 
        Task IncreaseCodeErrors(string receiver, string bizFlag);
        /// 
        /// 校验码发送次数周期持久化，如果接收方和业务标志组合已经存在，则进行覆盖
        /// 
        /// 接收方
        /// 业务标志
        /// 周期时间范围
        /// 
        Task SetPeriod(string receiver, string bizFlag, TimeSpan? period);
        /// 
        /// 校验码周期内发送次数+1，如果周期已到，则不进行任何操作
        /// 
        /// 接收方
        /// 业务标志
        /// 
        Task IncreaseSendTimes(string receiver, string bizFlag);
        /// 
        /// 获取校验码及已尝试错误次数，如果校验码不存在或已过期，则返回null
        /// 
        /// 接收方
        /// 业务标志
        /// 
        Task> GetEffectiveCode(string receiver, string bizFlag);
        /// 
        /// 获取校验码周期内已发送次数，如果周期已到或未发送过任何验证码，则返回0
        /// 
        /// 
        /// 
        /// 
        Task GetAreadySendTimes(string receiver, string bizFlag);
    }

ICodeSender，请注意IsSupport方法约定。

    /// 
    /// 校验码实际发送接口
    /// 
    public interface ICodeSender
    {
        /// 
        /// 发送校验码内容模板
        /// 
        IContentFormatter Formatter { get; }
        /// 
        /// 判断接收者是否符合发送条件，例如当前发送者只支持邮箱，而接收方为手机号，则返回结果应当为false
        /// 
        /// 接收方
        /// 
        bool IsSupport(string receiver);
        /// 
        /// 发送校验码信息
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 
        Task Send(string receiver, string bizFlag, string code, TimeSpan effectiveTime);
    }

IContentFormatter

    /// 
    /// 发送校验码内容模板接口
    /// 
    public interface IContentFormatter
    {
        /// 
        /// 将指定参数组织成待发送的文本内容
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 
        string GetContent(string receiver, string bizFlag, string code, TimeSpan effectiveTime);
    }

IComplexContentFormatter

    /// 
    /// 基于业务标志的多内容模板
    /// 
    public interface IComplexContentFormatter : IContentFormatter
    {
        /// 
        /// 设置指定业务对应的内容模板
        /// 
        /// 业务标志
        /// 内容模板
        void SetFormatter(string bizFlag, IContentFormatter formatter);
        /// 
        /// 移除指定业务对应的内容模板，如果没有，则返回null
        /// 
        /// 业务标志
        /// 
        IContentFormatter RemoveFormatter(string bizFlag);
    }

ICodeHelper

    /// 
    /// 业务校验码辅助接口
    /// 
    public interface ICodeHelper
    {
        /// 
        /// 校验码实际发送者
        /// 
        ICodeSender Sender { get; }
        /// 
        /// 校验码信息存储者
        /// 
        ICodeStorage Storage { get; }
        /// 
        /// 发送校验码
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 周期内最大允许发送配置，为null则表示无限制
        /// 
        Task SendCode(string receiver, string bizFlag, string code, TimeSpan effectiveTime, PeriodLimit maxSendLimit);
        /// 
        /// 验证校验码是否正确
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 最大允许错误次数
        /// 
        Task VerifyCode(string receiver, string bizFlag, string code, int maxErrorLimit);
    }

下面则是接口约定中的一些定义的类和枚举。

    /// 
    /// 校验码发送周期设置
    /// 
    public class PeriodLimit
    {
        /// 
        /// 周期内允许的最大次数
        /// 
        public int MaxLimit { get; set; }
        /// 
        /// 周期时间，如果不设置，则表示无周期，此时代表总共只允许发送多少次
        /// 
        public TimeSpan? Period { get; set; }
    }
    /// 
    /// 校验码发送结果
    /// 
    public enum SendResult
    {
        /// 
        /// 发送成功
        /// 
        [Description("成功")]
        Success = 0,
        /// 
        /// 超出最大发送次数
        /// 
        [Description("超出最大发送次数")]
        MaxSendLimit = 11,
        /// 
        /// 发送失败，指的发送结果为false
        /// 
        [Description("发送失败")]
        FailInSend = 12,
        /// 
        /// 无法发送，结果为false
        /// 
        [Description("无法发送")]
        NotSupprot = 13,
    }
    /// 
    /// 校验码校验结果
    /// 
    public enum VerificationResult
    {
        /// 
        /// 校验成功
        /// 
        [Description("成功")]
        Success = 0,
        /// 
        /// 校验码已过期
        /// 
        [Description("校验码已过期")]
        Expired = 31,
        /// 
        /// 校验码不一致，校验失败
        /// 
        [Description("校验失败")]
        VerificationFailed = 32,
        /// 
        /// 已经达到了最大错误尝试次数，需重新发送新的校验码
        /// 
        [Description("超出最大错误次数")]
        MaxErrorLimit = 33,
    }

再下来就是具体的接口实现了，当然这些实现也是通用实现

ContentFormatter

    /// 
    /// 通用的内容模板
    /// 
    public class ContentFormatter : IContentFormatter
    {
        private Func _func;
        /// 
        /// 通用实现，这样就无需每种业务类型都要实现
        /// 
        /// 传递的委托，参数顺序与一致
        public ContentFormatter(Func func)
        {
            this._func = func ?? throw new ArgumentNullException(nameof(func));
        }
        /// 
        /// 将指定参数组织成待发送的文本内容
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 
        public string GetContent(string receiver, string bizFlag, string code, TimeSpan effectiveTime)
        {
            return this._func.Invoke(receiver, bizFlag, code, effectiveTime);
        }
    }

ComplexContentFormatter

    using System.Collections.Concurrent;
    /// 
    /// 基于业务标志的多内容模板实现
    /// 
    public class ComplexContentFormatter : IComplexContentFormatter
    {
        private ConcurrentDictionary _dic = new ConcurrentDictionary();
        /// 
        /// 设置指定业务对应的内容模板
        /// 
        /// 业务标志
        /// 内容模板
        public void SetFormatter(string bizFlag, IContentFormatter formatter)
        {
            if (!string.IsNullOrWhiteSpace(bizFlag) && formatter != null)
            {
                this._dic.AddOrUpdate(bizFlag, formatter, (k, v) => formatter);
            }
        }
        /// 
        /// 移除指定业务对应的内容模板，如果没有，则返回null
        /// 
        /// 业务标志
        /// 
        public IContentFormatter RemoveFormatter(string bizFlag)
        {
            if (!string.IsNullOrWhiteSpace(bizFlag)
                && this._dic.TryRemove(bizFlag, out IContentFormatter formatter))
            {
                return formatter;
            }
            return null;
        }
        /// 
        /// 将指定参数组织成待发送的文本内容
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 
        public string GetContent(string receiver, string bizFlag, string code, TimeSpan effectiveTime)
        {
            if (string.IsNullOrWhiteSpace(bizFlag))
            {
                throw new ArgumentNullException(nameof(bizFlag));
            }
            this._dic.TryGetValue(bizFlag, out IContentFormatter formatter);
            if (formatter == null)
            {
                throw new KeyNotFoundException(nameof(formatter));
            }
            return formatter.GetContent(receiver, bizFlag, code, effectiveTime);
        }
    }

CodeHelper，注意该类除了实现ICodeHelper外，还提供了一个用于生成随机验证码的静态方法GetRandomNumber。

    /// 
    /// 业务校验码辅助接口实现
    /// 
    public class CodeHelper : ICodeHelper
    {
        /// 
        /// 基于接口实现，可依赖注入
        /// 
        /// 
        /// 
        public CodeHelper(ICodeSender sender, ICodeStorage storage)
        {
            this.Sender = sender ?? throw new ArgumentNullException(nameof(sender));
            this.Storage = storage ?? throw new ArgumentNullException(nameof(storage));
        }
        /// 
        /// 校验码实际发送者
        /// 
        public ICodeSender Sender { get; }
        /// 
        /// 校验码信息存储者
        /// 
        public ICodeStorage Storage { get; }
        /// 
        /// 发送校验码
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 周期内最大允许发送配置，为null则表示无限制
        public async Task SendCode(string receiver, string bizFlag, string code, TimeSpan effectiveTime, PeriodLimit maxSendLimit)
        {
            var result = SendResult.NotSupprot;
            if (this.Sender.IsSupport(receiver))
            {
                result = SendResult.MaxSendLimit;
                bool canSend = maxSendLimit == null;
                int sendTimes = 0;
                if (!canSend)
                {
                    sendTimes = await this.Storage.GetAreadySendTimes(receiver, bizFlag).ConfigureAwait(false);
                    canSend = sendTimes 
        /// 验证校验码是否正确
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 最大允许错误次数
        /// 
        public async Task VerifyCode(string receiver, string bizFlag, string code, int maxErrorLimit)
        {
            var result = VerificationResult.Expired;
            var vCode = await this.Storage.GetEffectiveCode(receiver, bizFlag).ConfigureAwait(false);
            if (vCode != null && !string.IsNullOrWhiteSpace(vCode.Item1))
            {
                result = VerificationResult.MaxErrorLimit;
                if (vCode.Item2 
        /// 获取由数字组成的校验码
        /// 
        /// 校验码长度
        /// 
        public static string GetRandomNumber(int maxLength = 6)
        {
            if (maxLength = 10)
            {
                throw new ArgumentOutOfRangeException($"{nameof(maxLength)} must between {1} and {9}.");
            }
            var rd = Math.Abs(Guid.NewGuid().GetHashCode());
            var tmpX = (int)Math.Pow(10, maxLength);
            return (rd % tmpX).ToString().PadLeft(maxLength, '0');
        }
    }

除了上述标准通用实现，还有一些半通用实现，比如本文标题中的Redis，所谓半通用，就是指你可以直接拿来用，但有可能不符合你的技术场景，此时你需要自己重写一份。

CodeStorageWithRedisCache，注意该类库采用了StackExchange.Redis.Extensions.Core，你可以在nuget上下载该类库，如果你对默认的Redis键值生成方式不满意，你也可以通过重写GetKey方法来指定新的键值生成方式。当然，因为实际存储在Redis中的数据都只是一些简单数据，并不需要额外的序列化过程，实际你也可以直接使用StackExchange.Redis。

    /// 
    /// 校验码信息存储到Redis
    /// 
    public class CodeStorageWithRedisCache : ICodeStorage
    {
        private readonly IRedisCacheClient _client;
        private const string CodeValueHashKey = "Code";
        private const string CodeErrorHashKey = "Error";
        private const string PeriodHashKey = "Period";
        /// 
        /// Code缓存Key值前缀
        /// 
        public string CodeKeyPrefix { get; set; } = "CC";
        /// 
        /// Period缓存Key值前缀
        /// 
        public string PeriodKeyPrefix { get; set; } = "CCT";
        /// 
        /// 缓存写入Redis哪个库
        /// 
        public int DbNumber { get; set; } = 8;
        /// 
        /// 基于RedisCacheClient的构造函数
        /// 
        /// 
        public CodeStorageWithRedisCache(IRedisCacheClient client)
        {
            this._client = client;
        }
        /// 
        /// 获取校验码周期内已发送次数，如果周期已到或未发送过任何验证码，则返回0
        /// 
        /// 
        /// 
        /// 
        public async Task GetAreadySendTimes(string receiver, string bizFlag)
        {
            var db = this.GetDatabase();
            var key = this.GetPeriodKey(receiver, bizFlag);
            var times = await db.HashGetAsync(key, PeriodHashKey).ConfigureAwait(false);
#if DEBUG
            Console.WriteLine("Method:{0} Result:{1}", nameof(GetAreadySendTimes), times);
#endif
            return times;
        }
        /// 
        /// 获取校验码及已尝试错误次数，如果校验码不存在或已过期，则返回null
        /// 
        /// 接收方
        /// 业务标志
        /// 
        public async Task> GetEffectiveCode(string receiver, string bizFlag)
        {
            var db = this.GetDatabase();
            var key = this.GetCodeKey(receiver, bizFlag);
            if (await db.ExistsAsync(key).ConfigureAwait(false))
            {
                var code = await db.HashGetAsync(key, CodeValueHashKey).ConfigureAwait(false);
                var errors = await db.HashGetAsync(key, CodeErrorHashKey).ConfigureAwait(false);
#if DEBUG
                Console.WriteLine("Method:{0} Result:  Code {1} Errors {2} ", nameof(GetEffectiveCode), code, errors);
#endif
                return Tuple.Create(code, errors);
            }
            return null;
        }
        /// 
        /// 校验码错误次数+1，如果校验码已过期，则不进行任何操作
        /// 
        /// 接收方
        /// 业务标志
        /// 
        public async Task IncreaseCodeErrors(string receiver, string bizFlag)
        {
            var db = this.GetDatabase();
            var key = this.GetCodeKey(receiver, bizFlag);
            if (await db.ExistsAsync(key).ConfigureAwait(false))
            {
                var errors = await db.HashGetAsync(key, CodeErrorHashKey).ConfigureAwait(false);
                await db.HashSetAsync(key, CodeErrorHashKey, errors + 1).ConfigureAwait(false);
            }
        }
        /// 
        /// 校验码周期内发送次数+1，如果周期已到，则不进行任何操作
        /// 
        /// 接收方
        /// 业务标志
        /// 
        public async Task IncreaseSendTimes(string receiver, string bizFlag)
        {
            var db = this.GetDatabase();
            var key = this.GetPeriodKey(receiver, bizFlag);
            if (await db.ExistsAsync(key).ConfigureAwait(false))
            {
                var times = await db.HashGetAsync(key, PeriodHashKey).ConfigureAwait(false);
                await db.HashSetAsync(key, PeriodHashKey, times + 1).ConfigureAwait(false);
            }
        }
        /// 
        /// 将校验码进行持久化，如果接收方和业务标志组合已经存在，则进行覆盖
        /// 
        /// 接收方
        /// 业务标志
        /// 校验码
        /// 校验码有效时间范围
        /// 
        public async Task SetCode(string receiver, string bizFlag, string code, TimeSpan effectiveTime)
        {
            var db = this.GetDatabase();
            var key = this.GetCodeKey(receiver, bizFlag);
            await db.RemoveAsync(key).ConfigureAwait(false);
            var ret = await db.HashSetAsync(key, CodeValueHashKey, code).ConfigureAwait(false)
            && await db.HashSetAsync(key, CodeErrorHashKey, 0).ConfigureAwait(false)
            && await db.UpdateExpiryAsync(key, effectiveTime);
#if DEBUG
            Console.WriteLine("Method:{0} Result:{1}", nameof(SetCode), ret);
#endif
            return ret;
        }
        /// 
        /// 校验码发送次数周期持久化，如果接收方和业务标志组合已经存在，则进行覆盖
        /// 
        /// 接收方
        /// 业务标志
        /// 周期时间范围
        /// 
        public async Task SetPeriod(string receiver, string bizFlag, TimeSpan? period)
        {
            var db = this.GetDatabase();
            var key = this.GetPeriodKey(receiver, bizFlag);
            await db.RemoveAsync(key).ConfigureAwait(false);
            var ret = await db.HashSetAsync(key, PeriodHashKey, 1).ConfigureAwait(false);
            if (period.HasValue)
            {
                ret = ret && await db.UpdateExpiryAsync(key, period.Value);
            }
#if DEBUG
            Console.WriteLine("Method:{0} Result:{1}", nameof(SetPeriod), ret);
#endif
            return ret;
        }
        /// 
        /// 组织Redis键值
        /// 
        /// 
        /// 
        /// 
        /// 
        protected virtual string GetKey(string receiver, string bizFlag, string prefix)
        {
            return string.Format("{0}:{1}:{2}", prefix, bizFlag, receiver);
        }
        private string GetPeriodKey(string receiver, string bizFlag)
        {
            return this.GetKey(receiver, bizFlag, this.PeriodKeyPrefix);
        }
        private string GetCodeKey(string receiver, string bizFlag)
        {
            return this.GetKey(receiver, bizFlag, this.CodeKeyPrefix);
        }
        private IRedisDatabase GetDatabase()
        {
            return this._client.GetDb(this.DbNumber);
        }
    }

最后，就是不可能通用的实现了，对于ICodeSender而言，先不说发送方式不同，就算相同，比如都是手机，那也还有不同的短信供应商，所以此处必须要使用者按自己的实际业务来实现，为了方便举例，这里我写了一个在控制台输出验证码内容的实现。

ConsoleSender，注意IsSupport在此处输出true，代表支持任意receiver

    /// 
    /// 在控制台输出校验码
    /// 
    public class ConsoleSender : ICodeSender
    {
        public ConsoleSender(IContentFormatter formatter)
        {
            this.Formatter = formatter ?? throw new ArgumentNullException(nameof(formatter));
        }
        public IContentFormatter Formatter { get; }

        public bool IsSupport(string receiver) => true;

        public Task Send(string receiver, string bizFlag, string code, TimeSpan effectiveTime)
        {
            var content = this.Formatter.GetContent(receiver, bizFlag, code, effectiveTime);
            Console.WriteLine("发送内容：{0}", content);
            return Task.FromResult(true);
        }
    }

最后则是如何使用的代码例子，注意此处Redis序列化方式采用了StackExchange.Redis.Extensions.Newtonsoft，你可以根据实际需要采用其它序列化方式，比如StackExchange.Redis.Extensions.Protobuf等，你同样可以在nuget上下载到这些类库。

static void CheckCodeHelperDemo()
{
    var redisConfig = new RedisConfiguration
    {
        Hosts = new RedisHost[] {
            new RedisHost{
                    Host="127.0.0.1",
                    Port=6379
            }
        }
    };
    var bizFlag = "forgetPassword";
    var receiver = "Receiver";
    var effectiveTime = TimeSpan.FromMinutes(1);
    var redisManager = new RedisCacheConnectionPoolManager(redisConfig);
    var redisClient = new RedisCacheClient(redisManager,
        new NewtonsoftSerializer(), redisConfig);//new ProtobufSerializer();
    var storage = new CodeStorageWithRedisCache(redisClient);
    var simpleFormatter = new ContentFormatter(
            (r, b, c, e) => $"{r}您好，您的忘记密码验证码为{c}，有效期为{(int)e.TotalSeconds}秒.");
    var formatter = new ComplexContentFormatter();
    formatter.SetFormatter(bizFlag, simpleFormatter);
    var sender = new ConsoleSender(formatter); //如果就一个业务场景，也可以直接用simpleFormatter
    //var tmp = storage.SetPeriod(receiver, bizFlag, TimeSpan.FromMinutes(20)).Result;
    var helper = new CodeHelper(sender, storage);
    var code = CodeHelper.GetRandomNumber();
    var sendResult = helper.SendCode(receiver, bizFlag, code, effectiveTime, new PeriodLimit
    {
        MaxLimit = 5,
        Period = TimeSpan.FromMinutes(20)
    }).Result;
    Console.WriteLine("发送结果：{0}", sendResult);
    if (sendResult == SendResult.Success)
    {
        Console.WriteLine("*****************************");
        while (true)
        {
            Console.WriteLine("请输入校验码：");
            var vCode = Console.ReadLine();
            var vResult = helper.VerifyCode(receiver, bizFlag, vCode, 3).Result;
            Console.WriteLine("校验码 {0} 校验结果：{1}", vCode, vResult);
            if (vResult != VerificationResult.VerificationFailed)
            {
                break;
            }
        }
    }
    redisManager.Dispose();
}

最后则是不同测试场景的一些截图

验证码校验失败达到允许次数上限

错误上限