天天看點

如何在 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 是一個很不錯的包喲。