在Next.js中实现强类型Stripe Webhook事件处理

在Next.js项目中处理Stripe Webhook事件时，确保事件类型的强类型检查对于代码的健壮性和开发体验至关重要。本文将详细介绍如何在Next.js（特别是pages路由模式下）实现这一目标。

获取原始请求体

Stripe Webhook验证需要访问HTTP请求的原始体(raw body)，但在Vercel环境中这并不直接可用。我们需要创建一个辅助函数来获取原始请求体：

import { VercelRequest, VercelResponse } from "@vercel/node";

export function getRawBody(req: VercelRequest): Promise<string> {
  return new Promise(resolve => {
    const bodyChunks = [];
    req.on("end", () => {
      const rawBody = Buffer.concat(bodyChunks).toString("utf8");
      resolve(rawBody);
    });
    req.on("data", chunk => bodyChunks.push(chunk));
  });
}

这个函数通过监听请求的"data"和"end"事件来收集所有数据块，最后将它们合并为完整的原始请求体。

验证Webhook事件

有了原始请求体后，我们可以使用Stripe SDK提供的constructEvent方法来验证和解析Webhook事件：

import { VercelRequest, VercelResponse } from "@vercel/node";
import stripe, { Stripe } from "stripe";

export default async (req: VercelRequest, res: VercelResponse) => {
  const signature = req.headers["stripe-signature"];
  const rawBody = await getRawBody(req);

  let event: Stripe.Event;

  try {
    event = stripe.webhooks.constructEvent(
      rawBody,
      signature,
      WEBHOOK_SECRET,
    );
  } catch (err) {
    return res.status(401).json({
      sucess: false,
      error: "Invalid signature",
    });
  }

  // 现在event对象已经具有完整的类型信息
}

类型区分处理

为了更精确地处理不同类型的事件，我们可以利用TypeScript的类型守卫或区分联合类型。Stripe提供了DiscriminatedEvent类型，可以让我们根据事件类型自动推断出对应的数据对象类型：

const event = stripe.webhooks.constructEvent(
  'payload',
  'signature',
  'whsec_test'
) as Stripe.DiscriminatedEvent;

switch (event.type) {
  case 'charge.succeeded':
    // 这里event.data.object会自动推断为Charge类型
    const charge = event.data.object;
    break;
  case 'customer.created':
    // 这里event.data.object会自动推断为Customer类型
    const customer = event.data.object;
    break;
}

这种方法极大地提高了代码的类型安全性和开发体验，避免了手动类型断言可能带来的错误。

注意事项

1. 在测试环境中，需要模拟getRawBody函数的行为
2. 确保WEBHOOK_SECRET的安全性，不要硬编码在代码中
3. 对于App Router项目，Vercel已经提供了更简单的方式来访问原始请求体
4. 处理不同类型的事件时，建议使用完整的switch语句并处理default情况

通过以上方法，我们可以在Next.js项目中实现强类型的Stripe Webhook事件处理，提高代码的可靠性和可维护性。