Laravel Mercure Broadcaster 项目启动与配置教程

1. 项目目录结构及介绍

Laravel Mercure Broadcaster 是一个用于将 Laravel 应用程序与 Mercure 协议集成的扩展。以下是项目的目录结构及各部分的作用介绍：

laravel-mercure-broadcaster/
├── config/                  # 配置文件目录
│   └── mercure.php          # Mercure 配置文件
├── src/                     # 源代码目录
│   ├── Commands/            # 命令行相关
│   ├── Contracts/           # 合同（接口）目录
│   ├── Events/              # 事件目录
│   ├── Exceptions/          # 异常处理目录
│   ├── Http/                # HTTP 相关
│   │   ├── Controllers/     # 控制器目录
│   │   ├── Middleware/      # 中间件目录
│   │   └── Requests/        # 请求目录
│   ├── Jobs/                # 任务目录
│   ├── Listeners/           # 监听器目录
│   ├── Providers/           # 服务提供者目录
│   │   └── MercureBroadcasterProvider.php # Mercure 广播器服务提供者
│   └── Traits/              # 特性目录
├── tests/                   # 测试目录
├── .gitattributes            # Git 属性文件
├── .gitignore               # Git 忽略文件
├── composer.json            # Composer 配置文件
├── README.md                # 项目说明文件
└── webpack.mix.js           # Webpack 配置文件

2. 项目的启动文件介绍

启动文件主要是 src/Providers/MercureBroadcasterProvider.php，这是服务提供者文件，它用于绑定服务到 Laravel 服务容器，并注册事件广播器。

namespace LaravelMercureBroadcaster\Providers;

use Illuminate\Support\ServiceProvider;
use LaravelMercureBroadcaster\MercureBroadcaster;

class MercureBroadcasterProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->singleton(MercureBroadcaster::class, function ($app) {
            return new MercureBroadcaster($app);
        });
    }

    public function boot()
    {
        // ...
    }
}

3. 项目的配置文件介绍

配置文件位于 config/mercure.php，该文件用于定义与 Mercure 集成所需的各种设置。

return [
    // Mercure JWT 令牌的密钥
    'jwt_secret' => env('MERCURE_JWT_SECRET', 'your-jwt-secret'),

    // Mercure 服务的 URL
    'mercure_url' => env('MERCURE_URL', 'https://example.com/mercure'),

    // 是否启用 Mercure 广播
    'enabled' => env('MERCURE_ENABLED', false),

    // ...
];

在配置文件中，你可以设置 JWT 密钥、Mercure 服务的 URL 以及是否启用 Mercure 广播等。确保在生产环境中正确设置这些值，以保障应用程序的安全和正常运行。