如何在 Laravel 中 「規範」 的開發驗證碼發送功能【社交系統ThinkSNS研發日記十一】

順便發個小通知:7月15日ThinkSNS+開源版發佈,同時非開源的APP也走出內測階段,體驗二維碼也全面發佈體驗。php

什麼是ThinkSNS ?html

ThinkSNS(簡稱TS),一款全平臺綜合性社交系統,爲國內外大中小企業和創業者提供社會化軟件研發及技術解決方案,目前最新版本爲ThinkSNS+(簡稱TS+)。git

需求場景github

發送「驗證碼」或者「消息通知」,可發送到手機或郵箱中。併發

完成app

首先,在 Laravel 中的規範就是使用 Laravel 的「消息通知」,這裏基於場景爲「驗證碼」。這個需求幾乎全部軟件系統都有使用到。composer

建立通知場景ide

第一步,使用 php artisan make:notification 建立一個通知類,建立成功後默認已經存在了三個方法 via、toMail 和 toArray ,由於是發送驗證碼,姑將這個控制類命名爲 VerificationCode 。函數

而後建立一個驗證碼數據模型和數據表遷移,可使用 php artisan make:model "VerificationCode" -m 直接快速建立數據模型和遷移。ui

ThinkSNS+的遷移以下:

圖片描述

第二步,打開數據模型類,在裏面添加 IlluminateNotificationsNotifiable 性狀:

圖片描述

從代碼裏面,能夠看到咱們還添加了「軟刪除」,由於是基於手機號或者郵箱的驗證碼發送,因此不須要其餘的內置花花腸子,也不須要記錄到 「消息通知數據表」中,因此 routeNotificationFor 方法咱們選擇直接返回須要發送的帳號(手機號或郵箱)。

加入工廠模式,快捷發送

打開 database/factories/ModelFactory.php 在裏面添加一個關於通知數據模型的工廠定義:

圖片描述

這樣,咱們就能夠經過 factory(ZhiyiPlusModelsVerificationCode::class) 工廠函數快捷的建立驗證碼併發送通知。

爲何在驗證碼數據模型增長通知性狀?

首先 IlluminateNotificationsNotifiable 這份性狀,Laravel 默認添加到 User 模型中的,因此經過 $user->notify() 能夠快速的給用戶發送一個通知,可是在規範文檔中有這麼一句話:

Remember, you may use the IlluminateNotificationsNotifiable trait on any of your models. You are not limited to only including it on your User model.

這是Laravel官方文檔原話,意思就是IlluminateNotificationsNotifiable不單單是用在 User 模型上。

因此咱們在驗證碼模型中添加 IlluminateNotificationsNotifiable 是徹底符合Laravel通知的正確使用的。

開發通知類

首先,在數據表遷移中存在一個字段 channel 也就是通知頻道標識,咱們可根據這個值來決定用什麼方式發送驗證碼,而這個操做在通知類的 via 中實現的:

圖片描述

咱們選擇方式就是直接返回 channel 值,這個值能夠是任何值,只要咱們實現了這個通知頻道,均可以發送,而Laravel已經內置和一些發送頻道 database、mail 和 nexmo

完成郵件驗證碼發送

其實,這個步驟咱們要作的事情已經不多了,生產通知類的時候,已經完成了 toMail 方法,因此,咱們直接修改其消息內容便可。

完成短信驗證碼發送

短信發送咱們採用 overtrue/easy-sms 包,這是安正超開發的一個短信發送客戶端,已經內置了不少短信平臺,實現也很優秀。(吐槽:雖然有些細節有問題,例如不按照契約調用方法傳遞網關)

首先依賴短信發送客戶端包composer require overtrue/easy-sms而後新建配置 /config/sms.php ,內容嘛,就按照 easy-sms 首頁的說明增長便可,先貼出咱們的配置內容(爲了減小文章字數,只保留阿里大於配置):

圖片描述
圖片描述
我門增長了一個 channel 配置,用於不一樣場景,例如驗證碼場景 code 以方便消息器讀取配置。

而後打開 AppServiceProvider.php 在 register 中增長以下:
圖片描述

至此 EasySms 在 Laravel 中的集成已經完成,可是尚未開發實際功能,咱們接着往下看。

開發 sms 發送頻道

爲何要開發?首先,easy-sms 支持的不少,能夠考慮單獨爲每一個發送平臺開發一個通知發送頻道類,也能夠採用只開發一個sms 發送頻道類,咱們選擇開發一個sms通知發送類,經過 easy-sms 的策略機制去多平臺發送驗證碼。

首先,新建一個 app/Notifications/Channels/SmsChannel.php 文件,由於 Laravel 沒有提供生成函數,這個須要本身建立喲,只要實現 send 方法便可。 SmsChannel 內容以下:

圖片描述

這樣,基於 easy-sms 的短信通知發送頻道就完成了。

開發場景發送消息

這部分徹底屬於 easy-sms 使用開發,咱們新建一個 VerificationCodeMessage.php ,內容以下:

圖片描述

而後回到 VerificationCode 驗證碼通知類中,增長 toSms 方法,代碼以下:

圖片描述

能夠看到,在實例化驗證碼消息的時候傳遞了一個 config 進去,有什麼用呢?其實在前面已經提到了:在配置文件中增長長場景配置,例如驗證碼不一樣頻道的 template 等,這樣消息器就能夠根據發送網關來判斷使用場景的配置是什麼。

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

好了咱們的開發完成了。

發送驗證碼

在建立驗證碼數據模型的時候就已經添加到「工廠」中,因此咱們能夠直接使用 factory 函數了,發送演示:

圖片描述

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

上面代碼都是來自於 ThinkSNS Plus ,看完整的開發代碼能夠看倉庫:

GitHub: https://github.com/slimkit/th...(開源不易,求 Star )

源碼受權購買

現行穩定系統V4系列全端產品(PC/H5/APP),受權源碼購買、產品體驗,請致電:18108035545開源版源碼官方正版獲取惟一渠道:關注公衆號「thinksns」,回覆「開源版」便可得到最新源碼壓縮文件地址。

TS+安裝部署:http://www.thinksns.com/reade...

相關文章
相關標籤/搜索