Laravel Stripe Webhooks 使用教程

项目介绍

Laravel Stripe Webhooks 是一个用于在 Laravel 应用中处理 Stripe 网络钩子的开源包。Stripe 可以通过网络钩子通知您的应用各种事件，这个包可以帮助您处理这些钩子请求。它能够验证 Stripe 签名，确保所有传入请求的有效性。

项目快速启动

安装

首先，通过 Composer 安装包：

composer require spatie/laravel-stripe-webhooks

配置

注册服务提供者并发布配置文件：

php artisan vendor:publish --provider="Spatie\StripeWebhooks\StripeWebhooksServiceProvider"

在 .env 文件中添加 Stripe Webhook 签名密钥：

STRIPE_WEBHOOK_SECRET=your_stripe_webhook_secret

迁移

运行迁移以创建 webhook_calls 表：

php artisan migrate

路由

在 Stripe 控制面板中配置 Webhook URL，并在 Laravel 的路由文件中添加：

Route::stripeWebhooks('webhook-route-configured-at-the-stripe-dashboard');

确保在 VerifyCsrfToken 中间件中排除该路由：

protected $except = [
    'webhook-route-configured-at-the-stripe-dashboard',
];

应用案例和最佳实践

处理特定事件

您可以为特定事件类型创建处理作业。例如，处理 invoice.payment_succeeded 事件：

php artisan make:job StripeInvoicePaymentSucceededJob

在作业类中处理事件：

public function handle(Invoice $invoice)
{
    // 处理逻辑
}

在配置文件中映射事件类型到作业类：

'jobs' => [
    'invoice.payment_succeeded' => \App\Jobs\StripeInvoicePaymentSucceededJob::class,
],

错误处理

如果处理作业失败，可以配置重试策略或记录错误。

典型生态项目

Laravel Cashier

Laravel Cashier 是一个用于处理 Stripe 订阅的包，可以与 Laravel Stripe Webhooks 一起使用，没有已知的冲突。

Laravel Telescope

Laravel Telescope 是一个调试助手，可以监控和查看应用的各种请求和事件，包括 Stripe Webhooks。

通过这些步骤和示例，您可以快速启动并运行 Laravel Stripe Webhooks，处理 Stripe 的各种事件，并与其他 Laravel 生态项目集成。