如何在 Laravel 中 “規(guī)范” 的開(kāi)發(fā)驗(yàn)證碼發(fā)送功能

什么是ThinkSNS ?

ThinkSNS(簡(jiǎn)稱(chēng)TS)，一款全平臺(tái)綜合性社交系統(tǒng)，為國(guó)內(nèi)外大中小企業(yè)和創(chuàng)業(yè)者提供社會(huì)化軟件研發(fā)及技術(shù)解決方案。

需求場(chǎng)景

發(fā)送「驗(yàn)證碼」或者「消息通知」，可發(fā)送到手機(jī)或郵箱中。

完成

首先，在Laravel中的規(guī)范就是使用Laravel的「消息通知」，這里基于場(chǎng)景為「驗(yàn)證碼」。這個(gè)需求幾乎所有軟件系統(tǒng)都有使用到。

創(chuàng)建通知場(chǎng)景

第一步，使用php artisan make:notification創(chuàng)建一個(gè)通知類(lèi)，創(chuàng)建成功后默認(rèn)已經(jīng)存在了三個(gè)方法via、toMail和toArray，因?yàn)槭前l(fā)送驗(yàn)證碼，姑將這個(gè)控制類(lèi)命名為VerificationCode。

然后創(chuàng)建一個(gè)驗(yàn)證碼數(shù)據(jù)模型和數(shù)據(jù)表遷移，可以使用php artisan make:model "VerificationCode" -m直接快速創(chuàng)建數(shù)據(jù)模型和遷移。

ThinkSNS+的遷移如下：

第二步，打開(kāi)數(shù)據(jù)模型類(lèi)，在里面添加Illuminate\Notifications\Notifiable性狀：

從代碼里面，可以看到我們還添加了「軟刪除」，因?yàn)槭腔谑謾C(jī)號(hào)或者郵箱的驗(yàn)證碼發(fā)送，所以不需要其他的內(nèi)置花花腸子，也不需要記錄到「消息通知數(shù)據(jù)表」中，所以routeNotificationFor方法我們選擇直接返回需要發(fā)送的賬號(hào)（手機(jī)號(hào)或郵箱）。

加入工廠模式，快捷發(fā)送#

打開(kāi)database/factories/ModelFactory.php在里面添加一個(gè)關(guān)于通知數(shù)據(jù)模型的工廠定義：

這樣，我們就可以通過(guò)factory(\Zhiyi\Plus\Models\VerificationCode::class)工廠函數(shù)快捷的創(chuàng)建驗(yàn)證碼并發(fā)送通知。

為什么在驗(yàn)證碼數(shù)據(jù)模型增加通知性狀？

首先Illuminate\Notifications\Notifiable這份性狀，Laravel默認(rèn)添加到User模型中的，所以通過(guò)$user->notify()可以快速的給用戶發(fā)送一個(gè)通知，但是在規(guī)范文檔中有這么一句話：

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模型上。

所以我們?cè)隍?yàn)證碼模型中添加Illuminate\Notifications\Notifiable是完全符合Laravel通知的正確使用的。

開(kāi)發(fā)通知類(lèi)

首先，在數(shù)據(jù)表遷移中存在一個(gè)字段channel也就是通知頻道標(biāo)識(shí)，我們可根據(jù)這個(gè)值來(lái)決定用什么方式發(fā)送驗(yàn)證碼，而這個(gè)操作在通知類(lèi)的via中實(shí)現(xiàn)的：

我們選擇方式就是直接返回channel值，這個(gè)值可以是任何值，只要我們實(shí)現(xiàn)了這個(gè)通知頻道，都可以發(fā)送，而Laravel已經(jīng)內(nèi)置和一些發(fā)送頻道database、mail和nexmo

完成郵件驗(yàn)證碼發(fā)送

其實(shí)，這個(gè)步驟我們要做的事情已經(jīng)很少了，生產(chǎn)通知類(lèi)的時(shí)候，已經(jīng)完成了toMail方法，所以，我們直接修改其消息內(nèi)容即可。

完成短信驗(yàn)證碼發(fā)送

短信發(fā)送我們采用overtrue/easy-sms包，這是安正超開(kāi)發(fā)的一個(gè)短信發(fā)送客戶端，已經(jīng)內(nèi)置了很多短信平臺(tái)，實(shí)現(xiàn)也很優(yōu)秀。（吐槽：雖然有些細(xì)節(jié)有問(wèn)題，例如不按照契約調(diào)用方法傳遞網(wǎng)關(guān)）

首先依賴(lài)短信發(fā)送客戶端包c(diǎn)omposer require overtrue/easy-sms然后新建配置/config/sms.php，內(nèi)容嘛，就按照easy-sms首頁(yè)的說(shuō)明增加即可，先貼出我們的配置內(nèi)容（為了減少文章字?jǐn)?shù)，只保留阿里大于配置）：

我門(mén)增加了一個(gè)channel配置，用于不同場(chǎng)景，例如驗(yàn)證碼場(chǎng)景code以方便消息器讀取配置。

然后打開(kāi)AppServiceProvider.php在register中增加如下：

至此EasySms在Laravel中的集成已經(jīng)完成，但是還沒(méi)有開(kāi)發(fā)實(shí)際功能，我們接著往下看。

開(kāi)發(fā)sms發(fā)送頻道

為什么要開(kāi)發(fā)？首先，easy-sms支持的很多，可以考慮單獨(dú)為每個(gè)發(fā)送平臺(tái)開(kāi)發(fā)一個(gè)通知發(fā)送頻道類(lèi)，也可以采用只開(kāi)發(fā)一個(gè)sms發(fā)送頻道類(lèi)，我們選擇開(kāi)發(fā)一個(gè)sms通知發(fā)送類(lèi)，通過(guò)easy-sms的策略機(jī)制去多平臺(tái)發(fā)送驗(yàn)證碼。

首先，新建一個(gè)app/Notifications/Channels/SmsChannel.php文件，因?yàn)長(zhǎng)aravel沒(méi)有提供生成函數(shù)，這個(gè)需要自己創(chuàng)建喲，只要實(shí)現(xiàn)send方法即可。SmsChannel內(nèi)容如下：

這樣，基于easy-sms的短信通知發(fā)送頻道就完成了。

開(kāi)發(fā)場(chǎng)景發(fā)送消息

這部分完全屬于easy-sms使用開(kāi)發(fā)，我們新建一個(gè)VerificationCodeMessage.php，內(nèi)容如下：

然后回到VerificationCode驗(yàn)證碼通知類(lèi)中，增加toSms方法，代碼如下：

可以看到，在實(shí)例化驗(yàn)證碼消息的時(shí)候傳遞了一個(gè)config進(jìn)去，有什么用呢？其實(shí)在前面已經(jīng)提到了：在配置文件中增加長(zhǎng)場(chǎng)景配置，例如驗(yàn)證碼不同頻道的template等，這樣消息器就可以根據(jù)發(fā)送網(wǎng)關(guān)來(lái)判斷使用場(chǎng)景的配置是什么。

再次吐槽，easy-sms的契約設(shè)計(jì)也應(yīng)該是這個(gè)思想，但是getContent/getTemplate/getData在實(shí)際網(wǎng)關(guān)調(diào)用的時(shí)候根本沒(méi)有傳遞網(wǎng)關(guān)過(guò)來(lái)。。。

好了我們的開(kāi)發(fā)完成了。

發(fā)送驗(yàn)證碼

在創(chuàng)建驗(yàn)證碼數(shù)據(jù)模型的時(shí)候就已經(jīng)添加到「工廠」中，所以我們可以直接使用factory函數(shù)了，發(fā)送演示：

大功告成，easy-sms是一個(gè)很不錯(cuò)的包喲。

上面代碼都是來(lái)自于ThinkSNS Plus，看完整的開(kāi)發(fā)代碼可以看倉(cāng)庫(kù)：

GitHub:https://github.com/slimkit/thinksns-plus（開(kāi)源不易，求Star）