Laravel Sms
供Laravel5使用的一个可支持多平台，易扩展的短信发送工具, (*1)
仅作为短信发送工具，不涉及业务逻辑, (*2)
环境要求
目前支持的短信平台
安装
Via Composer, (*3)
$ composer require daijulong/laravel-sms
composer.json, (*4)
"daijulong/laravel-sms": "~1.0"
如果Laravel5.5以下版本：, (*5)
-
在config/app.php文件中providers数组里加入：, (*6)
Daijulong\LaravelSms\Providers\SmsServiceProvider::class,
-
在config/app.php文件中的aliases数组里加入：, (*7)
'Sms' => Daijulong\LaravelSms\SmsSender::class,
配置
生成配置文件：, (*8)
php artisan vendor:publish --provider="Daijulong\LaravelSms\Providers\SmsServiceProvider"
将在config目录下生成配置文件：sms.php，各配置项在此配置文件中有详细说明。, (*9)
使用
以新建并使用一个验证码短信为例, (*10)
-
创建短信, (*11)
php artisan sms:create Captcha
短信名应首字母大写, (*12)
将在app/Sms目录下生成类文件：Captcha.php，内容如下：, (*13)
<?php
namespace App\Sms;
use Daijulong\LaravelSms\Sms;
class Captche extends Sms
{
/**
* Content for agent : Content
*
* return string
*/
protected function agentContent ()
{
return '';
}
/**
* Content for agent : Aliyun
*
* return string
*/
protected function agentAliyun ()
{
return '';
}
}
自动生成的类中已包含若干个以“agent”开头的方法，方法的多少及内容以配置文件中的agents定义自动处理
每个方法返回一个字符串，即为代理器发送时需要的短信内容（不包括变量，变量将在代理器中处理）
不同短信平台要求的短信内容不同，有的要求直接发送内容，有的要建立短信模板传入短信模板编号，在此体现, (*14)
补全内容后如下：, (*15)
<?php
namespace App\Sms;
use Daijulong\LaravelSms\Sms;
class Captche extends Sms
{
/**
* Content for agent : Content
*
* return string
*/
protected function agentContent ()
{
return '【' . config('sms.sign') . '】验证码：${code}，打死也不能告诉别人';
}
/**
* Content for agent : Aliyun
*
* return string
*/
protected function agentAliyun ()
{
return 'SMS_12345678';
}
}
-
发送短信, (*16)
代码片断, (*17)
$sms = new App\Sms\Captche();
$result = Sms::send('18012345678', $sms, ['code' => rand(100000,999999)]);
发送后将返回 true（发送成功） 或 false （发送失败）。, (*18)
如需查看各代理器发送结果情况，可以：, (*19)
-
Sms::getResults()：所有代理器发送结果，按发送顺序
-
Sms::getResult()：最后一个代理器发送结果，发送成功的代理器或最后一个发送失败的代理器
- 查看日志，具体请参考后续“日志”相关内容
代理器
代理器是沟通项目和短信平台的桥梁，一般一个短信平台对应一个代理器。, (*20)
如果本工具包提供的代理器不能满足项目需求，可以很方便地增加新的代理器。, (*21)
如果自带的某代理器不能满足需求，可新增一个同名代理器来取而代之。, (*22)
代理器调用顺序
默认代理器（default_agent） > 备用代理器（spare_agents）
发送短信时，将按以上代理器顺序依次发送短信，直到某代理器发送成功或全部发送失败。, (*23)
创建代理器
php artisan sms:agent MyAgent
默认将在 app\Sms\Agents 目录下创建代理器类文件：MyAgent.php，其内容如下：, (*24)
<?php
namespace App\Sms\Agents;
use Daijulong\LaravelSms\Agent;
use Daijulong\Sms\Interfaces\Sms;
class MyAgent extends Agent
{
/**
* 代理器名称
*/
protected $agent_name = 'MyAgent';
/**
* 发送短信
*
* @param string $to
* @param Sms $sms
* @param array $params
* @return bool
* @throws SmsException
*/
public function send(string $to, Sms $sms, array $params = []): bool
{
$content = $this->getSmsContent($sms);
// ... 具体发送操作
// ... 记录发送情况
$this->result
->setStatus()
->setMessage('')
->setContent($content)
->setParams($params)
->setReceiptId('')
->setReceiptData('');
// ... return true or false
// return true;
}
}
只需要完善send方法即可，send方法执行流程为：, (*25)
-
取得本代理器发送短信所需要的内容, (*26)
-
发送短信，这里根据实际情况，可能需要处理短信内容和短信内容变量, (*27)
-
记录发送情况，模板代码已作演示，补全或选择性使用即可, (*28)
-
返回 true 或 false 来标记发送情况, (*29)
代理器配置
-
创建的代理器需要在配置文件（config/sms.php）中agents项目中注册。, (*30)
'agents' => [
// ...
'MyAgent' => [
'key' => '',
],
// ...
],
在代理器中使用配置内容：$this->config['key'], (*31)
-
在配置文件（config/sms.php）的 default_agent 或 spare_agents 中设置其调用优先级。, (*32)
改变代理器调用顺序
某些特殊情况下需要临时调整发送短信的代理器。, (*33)
-
重新调整默认代理器和备用代理器, (*34)
$sms = new App\Sms\Captche();
$result = Sms::agent('MyAgent', ['Aliyun', 'Content'])->send('18012345678', $sms, ['code' => rand(100000,999999)]);
-
仅使用指定代理器发送短信，其他代理器不再参与发送, (*35)
$sms = new App\Sms\Captche();
$result = Sms::onlyAgent('MyAgent')->send('18012345678', $sms, ['code' => rand(100000,999999)]);
注：以上调整仅针对当次发送有效, (*36)
日志
日志功能默认开启，配置文件的log_enable为日志开关。, (*37)
日志支持以下驱动：, (*38)
-
文件：file, (*39)
发送日志文件将存储在Storage::disk('local')下的sms目录中，每天生成一个日志文件。, (*40)
-
数据库：db, (*41)
发送记录将存储于数据库中，使用此驱动前，应先创建日志表。, (*42)
生成migration文件：, (*43)
php artisan sms:table
创建表：, (*44)
php artisan migrate
License
The MIT License (MIT). Please see License File for more information., (*45)
Wallogit.com
daijulong