Laravel Web Push 通知通道项目教程

Laravel Web Push 通知通道项目教程

webpushWebpush notifications channel for Laravel.项目地址:https://gitcode.com/gh_mirrors/web/webpush

1. 项目的目录结构及介绍

Laravel Web Push 通知通道项目的目录结构遵循标准的 Laravel 包结构。以下是主要目录和文件的介绍：

/src
├── /Contracts
│   └── WebPush 接口定义文件
├── /Exceptions
│   └── WebPush 相关异常类
├── /Notifications
│   └── WebPush 通知类
├── /Support
│   └── 辅助函数和类
├── WebPushChannel.php
└── WebPushMessage.php

/tests
├── /Feature
│   └── 功能测试
├── /Unit
│   └── 单元测试
└── TestCase.php

composer.json
README.md

• /src：包含项目的核心代码。
  • /Contracts：定义 WebPush 接口。
  • /Exceptions：包含 WebPush 相关的异常类。
  • /Notifications：包含 WebPush 通知类。
  • /Support：包含辅助函数和类。
  • WebPushChannel.php：WebPush 通知通道类。
  • WebPushMessage.php：WebPush 消息类。
• /tests：包含项目的测试代码。
  • /Feature：功能测试。
  • /Unit：单元测试。
  • TestCase.php：测试基类。
• composer.json：定义项目的依赖和其他元数据。
• README.md：项目说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 composer.json 文件，它定义了项目的依赖和其他元数据。以下是 composer.json 文件的部分内容：

{
    "name": "laravel-notification-channels/webpush",
    "description": "Web Push Notifications channel for Laravel.",
    "require": {
        "php": "^7.2|^8.0",
        "laravel/framework": "^6.0|^7.0|^8.0",
        "minishlink/web-push": "^6.0"
    },
    "autoload": {
        "psr-4": {
            "NotificationChannels\\WebPush\\": "src"
        }
    },
    "extra": {
        "laravel": {
            "providers": [
                "NotificationChannels\\WebPush\\WebPushServiceProvider"
            ]
        }
    }
}

• name：项目的名称。
• description：项目的描述。
• require：项目的依赖。
• autoload：自动加载配置。
• extra：额外的配置，如 Laravel 服务提供者。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/webpush.php。以下是配置文件的内容：

return [
    'vapid' => [
        'subject' => env('VAPID_SUBJECT'),
        'public_key' => env('VAPID_PUBLIC_KEY'),
        'private_key' => env('VAPID_PRIVATE_KEY'),
    ],
];

• vapid：包含 VAPID（Voluntary Application Server Identification）相关的配置。
  • subject：VAPID 主题，通常是网站的 URL。
  • public_key：VAPID 公钥。
  • private_key：VAPID 私钥。

这些配置项通常在 .env 文件中定义，例如：

VAPID_SUBJECT=mailto:example@example.com
VAPID_PUBLIC_KEY=your_public_key
VAPID_PRIVATE_KEY=your_private_key

通过这些配置，项目可以正确地发送 Web Push 通知。

webpushWebpush notifications channel for Laravel.项目地址:https://gitcode.com/gh_mirrors/web/webpush