Easy SMS 使用教程

1. 项目目录结构及介绍

Easy SMS 是一个灵活且强大的 PHP 消息通知组件，允许开发者通过统一的接口与多种通知服务提供商交互。下面简述其核心目录结构及其重要组件：

• src

  • 包含了 Easy SMS 的核心类库，如 EasySms 类，负责整个通知发送的核心逻辑。
  • Message
    消息构建器相关类，用于定制化消息内容，比如 OrderPaidMessage 可用于订单支付成功的通知。
  • PhoneNumber
    提供对联系方式的支持，包括国际号码处理，确保正确发送跨国通知。

• Gateways
  各个服务商的适配器，如阿里云 (Aliyun), 云片 (Yunpian) 等，实现具体的服务交互逻辑。

• Strategies
  网关调用策略的集合，如顺序调用策略 (OrderStrategy)，可自定义以应对不同可靠性要求。

• Exception
  抛出的异常类型，帮助开发者理解和处理发送过程中遇到的问题。

• Tests
  项目测试套件，确保代码质量。

• config.php
  示例配置文件，展示如何配置各个服务提供商的信息。

• README.md
  主要文档，介绍项目特点、安装步骤、快速使用指南。

2. 项目的启动文件介绍

在 Easy SMS 中，并不存在传统意义上的"启动文件"。它是一个库，集成在其他PHP应用中使用。通常，你会在你的应用程序中创建一个新的实例来开始使用它，例如：

use Overtrue\EasySms\EasySms;

$config = [
    // ...配置信息...
];

$easySms = new EasySms($config);

这段代码是你的"入口"，通过 $easySms 实例进行通知的发送操作。

3. 项目的配置文件介绍

配置文件主要用于设置通知服务的各种参数，典型的配置示例如下：

return [
    'default' => [
        'gateways' => ['yunpian', 'aliyun'], // 默认使用的服务提供者列表
    ],
    'gateways' => [
        'yunpian' => [
            'api_key' => 'your_api_key_here',
        ],
        'aliyun' => [
            'access_key_id' => 'your_access_key_id',
            'access_key_secret' => 'your_access_key_secret',
            'sign_name' => '你的签名名称',
        ],
        // ...添加更多服务商配置...
    ],
];

• default: 定义默认使用的网关策略和网关列表。
• gateways: 详细配置每一种服务商的具体参数，如API key、秘密等。

对于服务商特定的配置（如模板ID或签名），则在发送通知时动态传递至对应的API调用中。

通过这样的配置，Easy SMS 提供了一种灵活的方式来管理多个通知服务，轻松切换或扩展不同的服务而无需修改大量代码。