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

什么是ThinkSNS ?

ThinkSNS(簡稱TS)，一款全平臺綜合性社交系統，為國內外大中小企業和創業者提供社會化軟件研發及技術解決方案。

需求場景

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

完成

首先，在Laravel中的規范就是使用Laravel的「消息通知」，這里基于場景為「驗證碼」。這個需求幾乎所有軟件系統都有使用到。

創建通知場景

第一步，使用php artisan make:notification創建一個通知類，創建成功后默認已經存在了三個方法via、toMail和toArray，因為是發送驗證碼，姑將這個控制類命名為VerificationCode。

然后創建一個驗證碼數據模型和數據表遷移，可以使用php artisan make:model "VerificationCode" -m直接快速創建數據模型和遷移。

ThinkSNS+的遷移如下：

第二步，打開數據模型類，在里面添加Illuminate\Notifications\Notifiable性狀：

從代碼里面，可以看到我們還添加了「軟刪除」，因為是基于手機號或者郵箱的驗證碼發送，所以不需要其他的內置花花腸子，也不需要記錄到「消息通知數據表」中，所以routeNotificationFor方法我們選擇直接返回需要發送的賬號（手機號或郵箱）。

加入工廠模式，快捷發送#

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

這樣，我們就可以通過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中實現的：

我們選擇方式就是直接返回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/thinksns-plus（開源不易，求Star）