欢迎您来到腾讯云!积分商城

腾讯云腾讯云论坛

 找回密码
 立即注册
忘了密码?

扫一扫,访问微社区

快捷导航
搜索
查看: 293|回复: 0

[代码交流] 如何在 Laravel 中 “规范” 的开发验证码发送功能

[复制链接]

13

主题

0

好友

800

积分

程序猿[LV2]

Rank: 2Rank: 2

云币
2050
威望
800
发表于 2017-10-25 14:46:18 |显示全部楼层
需求场景
发送「验证码」或者「消息通知」,可发送到手机或邮箱中。
完成
首先,在 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 the Illuminate\\Notifications\\Notifiable trait on any of your models. You are not limited to only including it on your User model.
这是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研发日记“规范”的开发验证码发送功能程序.png

5-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

场景配置,例如验证码不同频道的 template 等,这样消息器就可以根据发送网关来判断使用场景的配置是什么。
再次吐槽,easy-sms 的契约设计也应该是这个思想,但是 getContent/getTemplate/getData 在实际网关调用的时候根本没有传递网关过来。。。
好了我们的开发完成了。
发送验证码
在创建验证码数据模型的时候就已经添加到「工厂」中,所以我们可以直接使用 factory 函数了,发送演示:
10ThinkSNS研发日记“规范”的开发验证码发送功能程序.png

大功告成,easy-sms 是一个很不错的包哟。
上面代码都是来自于 ThinkSNS Plus ,看完整的开发代码可以看仓库:
GitHub: https://github.com/slimkit/thinksns-plus

您需要登录后才可以回帖 登录 | 立即注册
您需要登录后才可以发帖 QQ登录

联系我们|腾讯云平台|积分商城|腾讯云官方论坛    

GMT+8, 2018-2-20 13:35 , Processed in 1.185128 second(s), 31 queries .

Powered by Discuz! X2.5

© 2001-2012 Comsenz Inc.

回顶部