Notify 开源项目教程

1. 项目介绍

Notify 是一个开源的消息通知库，旨在简化不同消息服务（如短信、邮件、推送通知等）的集成。通过统一的 API，开发者可以轻松地将多个消息服务整合到一个平台中，从而提高开发效率并降低维护成本。

项目地址：https://github.com/guanguans/notify

2. 项目快速启动

安装

首先，确保你已经安装了 Composer，然后通过以下命令安装 Notify：

composer require guanguans/notify

基本使用

以下是一个简单的示例，展示如何使用 Notify 发送短信通知：

use Guanguans\Notify\Factory;

// 创建一个短信通知实例
$sms = Factory::sms('aliyun');

// 设置短信内容
$sms->setMessage([
    'template_code' => 'your_template_code',
    'template_param' => [
        'code' => '123456',
    ],
]);

// 设置接收者
$sms->setRecipients('13800138000');

// 发送短信
$sms->send();

配置

在使用 Notify 之前，你需要配置相应的服务提供商。以下是一个配置示例：

return [
    'default' => 'aliyun',
    'drivers' => [
        'aliyun' => [
            'access_key_id' => 'your_access_key_id',
            'access_key_secret' => 'your_access_key_secret',
            'sign_name' => 'your_sign_name',
        ],
    ],
];

3. 应用案例和最佳实践

应用案例

案例一：电商平台的订单通知

在电商平台中，当用户下单后，系统可以通过 Notify 发送短信通知用户订单状态。以下是一个简单的实现：

$sms = Factory::sms('aliyun');
$sms->setMessage([
    'template_code' => 'order_status_template',
    'template_param' => [
        'order_id' => '123456',
        'status' => '已发货',
    ],
]);
$sms->setRecipients('13800138000');
$sms->send();

案例二：用户注册验证码

在用户注册时，可以通过 Notify 发送验证码短信：

$sms = Factory::sms('aliyun');
$sms->setMessage([
    'template_code' => 'verification_code_template',
    'template_param' => [
        'code' => '123456',
    ],
]);
$sms->setRecipients('13800138000');
$sms->send();

最佳实践

1. 统一配置管理：将所有消息服务的配置集中管理，便于维护和更新。
2. 错误处理：在发送消息时，添加错误处理机制，确保消息发送失败时能够及时处理。
3. 日志记录：记录消息发送的日志，便于后续的分析和排查问题。

4. 典型生态项目

生态项目一：Laravel Notify

Laravel Notify 是一个基于 Notify 的 Laravel 扩展包，提供了更便捷的 Laravel 集成方式。

项目地址：https://github.com/guanguans/laravel-notify

生态项目二：Notify Admin

Notify Admin 是一个基于 Notify 的后台管理系统，提供了可视化的消息管理界面。

项目地址：https://github.com/guanguans/notify-admin