在 Laravel 中 “规范” 的开发短信验证码发送功能


Posted in PHP onOctober 26, 2017

Laravel简介

Laravel是一套简洁、优雅的PHP Web开发框架(PHP Web Framework)。它可以让你从面条一样杂乱的代码中解脱出来;它可以帮你构建一个完美的网络APP,而且每行代码都可以简洁、富于表达力。

在Laravel中已经具有了一套高级的PHP ActiveRecord实现 -- Eloquent ORM。它能方便的将“约束(constraints)”应用到关系的双方,这样你就具有了对数据的完全控制,而且享受到ActiveRecord的所有便利。Eloquent原生支持Fluent中查询构造器(query-builder)的所有方法。

 Laravel 中 “规范” 的开发短信验证码发送功能需求场景

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

完成

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

创建通知场景

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

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

ThinkSNS+的迁移如下:

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

加入工厂模式,快捷发送

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

这样,我们就可以通过 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 中实现的:

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

完成邮件验证码发送

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

完成短信验证码发送

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

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

开发 sms 发送频道

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

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

这样基于 easy-sms 的 短信通知发送频道已经完成。

开发场景发送消息

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

场景配置,例如验证码不同频道的 template 等,这样消息器就可以根据发送网关来判断使用场景的配置是什么。

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

好了我们的开发完成了。

发送验证码

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

在 Laravel 中 “规范” 的开发短信验证码发送功能

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

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

GitHub: https://github.com/slimkit/thinksns-plus

总结

以上所述是小编给大家介绍的在 Laravel 中 “规范” 的开发短信验证码发送功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!

PHP 相关文章推荐
5.PHP的其他功能
Oct 09 PHP
解决MySQL中文输出变成问号的问题
Jun 05 PHP
php设计模式 Proxy (代理模式)
Jun 26 PHP
PHP无限分类(树形类)的深入分析
Jun 02 PHP
PHP 线程安全与非线程安全版本的区别深入解析
Aug 06 PHP
PHP关于IE下的iframe跨域导致session丢失问题解决方法
Oct 10 PHP
ThinkPHP页面跳转success与error方法概述
Jun 25 PHP
Laravel 5框架学习之模型、控制器、视图基础流程
Apr 08 PHP
php获取指定范围内最接近数的方法
Jun 02 PHP
Laravel实现autoload方法详解
May 07 PHP
PHP基于ORM方式操作MySQL数据库实例
Jun 21 PHP
Laravel中Kafka的使用详解
Mar 24 PHP
详解php 使用Callable Closure强制指定回调类型
Oct 26 #PHP
php静态成员方法和静态的成员属性的使用方法
Oct 26 #PHP
PHP中类型转换 ,常量,系统常量,魔术常量的详解
Oct 26 #PHP
利用php获得flv视频长度的实例代码
Oct 26 #PHP
PHP 中魔术常量的实例详解
Oct 26 #PHP
yii框架redis结合php实现秒杀效果(实例代码)
Oct 26 #PHP
PHP对象的浅复制与深复制的实例详解
Oct 26 #PHP
You might like
计算2000年01月01日起到指定日的天数
2006/10/09 PHP
PHP header函数分析详解
2011/08/06 PHP
PHP中如何判断AJAX提交的数据
2012/02/05 PHP
php PDO异常处理详解
2016/11/20 PHP
laravel 数据验证规则详解
2019/10/23 PHP
php7 图形用户界面GUI 开发示例
2020/02/22 PHP
Javascript 解疑
2009/11/11 Javascript
Jquery命名冲突解决的五种方案分享
2012/03/16 Javascript
javascript 获取图片尺寸及放大图片
2013/09/04 Javascript
变量声明时命名与变量作为对象属性时命名的区别解析
2013/12/06 Javascript
用js格式化金额可设置保留的小数位数
2014/05/09 Javascript
JavaScript实现上下浮动的窗口效果代码
2015/10/12 Javascript
详解webpack + react + react-router 如何实现懒加载
2017/11/20 Javascript
Python中Django框架下的staticfiles使用简介
2015/05/30 Python
Python的Django框架中消息通知的计数器实现教程
2016/06/13 Python
不同版本中Python matplotlib.pyplot.draw()界面绘制异常问题的解决
2017/09/24 Python
numpy判断数值类型、过滤出数值型数据的方法
2018/06/09 Python
浅谈pycharm出现卡顿的解决方法
2018/12/03 Python
python函数与方法的区别总结
2019/06/23 Python
Python的形参和实参使用方式
2019/12/24 Python
Keras 使用 Lambda层详解
2020/06/10 Python
Django DRF APIView源码运行流程详解
2020/08/17 Python
通过案例解析python鸭子类型相关原理
2020/10/10 Python
python 调整图片亮度的示例
2020/12/03 Python
中英文自我评价常用句型
2013/12/19 职场文书
运动会广播稿200字
2014/01/15 职场文书
四年大学自我鉴定
2014/02/17 职场文书
支部鉴定材料
2014/06/02 职场文书
关爱老人标语
2014/06/21 职场文书
入党积极分子自我批评思想汇报
2014/10/10 职场文书
赔偿协议书怎么写
2015/01/28 职场文书
离婚答辩状范文
2015/05/22 职场文书
MySQL查询学习之基础查询操作
2021/05/08 MySQL
Golang 并发下的问题定位及解决方案
2022/03/16 Golang
Python开发五子棋小游戏
2022/04/28 Python
PyCharm 配置SSH和SFTP连接远程服务器
2022/05/11 Python