如何在 Laravel 中 “规范” 的开发验证码发送功能【研发日记十一】

2017-08-16 (482)

顺便发个小通知:7月15日ThinkSNS+开源版发布,同时非开源的APP也走出内测阶段,体验二维码也全面发布体验。

什么是ThinkSNS ?

ThinkSNS(简称TS),一款全平台综合性社交系统,为国内外大中小企业和创业者提供社会化软件研发及技术解决方案,目前最新版本为ThinkSNS+(简称TS+)。

社交系统ThinkSNS团队拥有超过九年的移动互联网软件/网站/APP开发经验,涉及行业:粉丝社群、直播互动、移动医疗、电子商务、生活服务、在线教育、旅游出行、移动办公、电子杂志、休闲娱乐、企业信息等。

我们的服务包括

快速建站、提供技术及产品解决方案、技术支持维护、技术孵化服务,同时,我们也提供TS的二次开发服务以及网站开发、Android APP开发、iOS APP开发、H5开发、微信公众号开发、小程序开发等定制开发服务,更多TS问题请咨询QQ:3298713109。

需求场景

发送「验证码」或者「消息通知」,可发送到手机或邮箱中。

完成

首先,在Laravel中的规范就是使用Laravel的「消息通知」,这里基于场景为「验证码」。这个需求几乎所有软件系统都有使用到。

创建通知场景

第一步,使用php artisan make:notification创建一个通知类,创建成功后默认已经存在了三个方法via、toMail和toArray,因为是发送验证码,姑将这个控制类命名为VerificationCode。

然后创建一个验证码数据模型和数据表迁移,可以使用php artisan make:model "VerificationCode" -m直接快速创建数据模型和迁移。

ThinkSNS+的迁移如下:

1ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

第二步,打开数据模型类,在里面添加Illuminate\Notifications\Notifiable性状:

2ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

从代码里面,可以看到我们还添加了「软删除」,因为是基于手机号或者邮箱的验证码发送,所以不需要其他的内置花花肠子,也不需要记录到「消息通知数据表」中,所以routeNotificationFor方法我们选择直接返回需要发送的账号(手机号或邮箱)。

加入工厂模式,快捷发送#

打开database/factories/ModelFactory.php在里面添加一个关于通知数据模型的工厂定义:

3ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

这样,我们就可以通过factory(\Zhiyi\Plus\Models\VerificationCode::class)工厂函数快捷的创建验证码并发送通知。

为什么在验证码数据模型增加通知性状?

首先Illuminate\Notifications\Notifiable这份性状,Laravel默认添加到User模型中的,所以通过$user->notify()可以快速的给用户发送一个通知,但是在规范文档中有这么一句话:

Remember, you may use theIlluminate\Notifications\Notifiabletrait on any of your models. You are not limited to only including it on yourUsermodel.

这是Laravel官方文档原话,意思就是Illuminate\Notifications\Notifiable不仅仅是用在User模型上。

所以我们在验证码模型中添加Illuminate\Notifications\Notifiable是完全符合Laravel通知的正确使用的。

开发通知类

首先,在数据表迁移中存在一个字段channel也就是通知频道标识,我们可根据这个值来决定用什么方式发送验证码,而这个操作在通知类的via中实现的:

4ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

我们选择方式就是直接返回channel值,这个值可以是任何值,只要我们实现了这个通知频道,都可以发送,而Laravel已经内置和一些发送频道database、mail和nexmo

完成邮件验证码发送

其实,这个步骤我们要做的事情已经很少了,生产通知类的时候,已经完成了toMail方法,所以,我们直接修改其消息内容即可。

完成短信验证码发送

短信发送我们采用overtrue/easy-sms包,这是安正超开发的一个短信发送客户端,已经内置了很多短信平台,实现也很优秀。(吐槽:虽然有些细节有问题,例如不按照契约调用方法传递网关)

首先依赖短信发送客户端包composer require overtrue/easy-sms然后新建配置/config/sms.php,内容嘛,就按照easy-sms首页的说明增加即可,先贴出我们的配置内容(为了减少文章字数,只保留阿里大于配置):

5-1ThinkSNS研发日记“规范”的开发验证码发送功能程序.png5-2ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

我门增加了一个channel配置,用于不同场景,例如验证码场景code以方便消息器读取配置。

然后打开AppServiceProvider.php在register中增加如下:

6ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

至此EasySms在Laravel中的集成已经完成,但是还没有开发实际功能,我们接着往下看。

开发sms发送频道

为什么要开发?首先,easy-sms支持的很多,可以考虑单独为每个发送平台开发一个通知发送频道类,也可以采用只开发一个sms发送频道类,我们选择开发一个sms通知发送类,通过easy-sms的策略机制去多平台发送验证码。

首先,新建一个app/Notifications/Channels/SmsChannel.php文件,因为Laravel没有提供生成函数,这个需要自己创建哟,只要实现send方法即可。SmsChannel内容如下:

7ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

这样,基于easy-sms的短信通知发送频道就完成了。

开发场景发送消息

这部分完全属于easy-sms使用开发,我们新建一个VerificationCodeMessage.php,内容如下:

8ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

然后回到VerificationCode验证码通知类中,增加toSms方法,代码如下:

9ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

可以看到,在实例化验证码消息的时候传递了一个config进去,有什么用呢?其实在前面已经提到了:在配置文件中增加长场景配置,例如验证码不同频道的template等,这样消息器就可以根据发送网关来判断使用场景的配置是什么。

再次吐槽,easy-sms的契约设计也应该是这个思想,但是getContent/getTemplate/getData在实际网关调用的时候根本没有传递网关过来。。。

好了我们的开发完成了。

发送验证码

在创建验证码数据模型的时候就已经添加到「工厂」中,所以我们可以直接使用factory函数了,发送演示:

10ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

大功告成,easy-sms是一个很不错的包哟。

上面代码都是来自于ThinkSNS Plus,看完整的开发代码可以看仓库:

GitHub:https://github.com/slimkit/thinksns-plus(开源不易,求Star)

开源版源码官方正版获取唯一渠道:关注公众号“thinksns”,回复“开源版”即可获得最新源码压缩文件地址。

社交系统TS+安装部署:http://www.thinksns.com/reader/100.html



业务合作(授权购买、二次开发、技术孵化、定制开发、产品功能规划、技术支持、商务合作等都找她)

咨询电话:18108035545;028-82884828

市场合作邮箱:lihecong@zhishisoft.com

商务合作QQ:3298713109