在 Laravel 中 “規范” 的開發短信驗證碼發送功能

更新:2017-10-27    編輯:夢春    來源:原創投稿    人氣:加載中...    字號:|

標簽:功能  規范  Laravel  開發  驗證  短信  百度搜索

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 中實現的:

我們選擇方式就是直接返回 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 法子,我的代碼如下:

場景配置,例如驗證碼不同頻道的 template 等,這樣消息器就可以根據發送網關來判斷應用處景的配置是什么。

再次吐槽,easy-sms 的契約設計也應該是這個思想,但是 getContent/getTemplate/getData 在實際網關調用的時候根本沒有傳遞網關過來。。。

好了我們的開發完成了。

發送驗證碼

在創建驗證碼數據模型的時候就已經添加到「工廠」中,所以我們可以直接應用 factory 函數了,發送演示:

在 Laravel 中 “規范” 的開發短信驗證碼發送功能

大功告成,easy-sms 是一個很不錯的包喲。

上面代碼都是來自于 ThinkSNS Plus ,看完整的開發代碼可以看倉庫:

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

總結


評論列表(網友評論僅供網友表達個人看法,并不表明本站同意其觀點或證實其描述)

站點導航

您可能在找這些
四川快乐12电视软件 三连码肖 湖北体彩11选五走势图 宝博棋牌下载安装 捕鱼游戏怎么玩能捕到鱼 韩国快乐8开奖直播 36选7大神推荐 云南11选5专家杀号 四川金7乐开奖号码及走势 西部黄金股票股吧 54国际棋牌下载