CapRover 部署 Next.js 应用时 Stripe 环境变量配置指南

在 CapRover 平台上部署 Next.js 应用时，前端环境变量的配置是一个常见的技术挑战。本文将以 Stripe 支付集成作为典型案例，详细介绍如何在 CapRover 中正确配置前端环境变量。

问题背景

当开发者尝试在 CapRover 上部署 Next.js 应用并集成 Stripe 支付功能时，经常会遇到"Missing value for Stripe(): apiKey should be a string"的错误。这个问题的根源在于前端代码无法正确获取环境变量值。

核心问题分析

Next.js 应用的环境变量处理有其特殊性：

1. 前端代码运行在浏览器环境中，无法直接访问服务器环境变量
2. Next.js 要求前端可访问的环境变量必须以 NEXT_PUBLIC_ 为前缀
3. 构建时需要将这些变量硬编码到生成的静态文件中

解决方案

1. Dockerfile 配置

正确的做法是使用独立的 Dockerfile 文件，而非在 captain-definition 中使用 dockerfileLines。关键配置如下：

FROM node:20.16.0-alpine

ARG NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=${NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY}
ENV NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=${NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY}

RUN mkdir -p /usr/src/app
WORKDIR /usr/src/app
COPY ./ /usr/src/app
RUN npm install && rm -rf .next && npm run build --ignore-engines
ENV NODE_ENV production
ENV PORT 3000
EXPOSE 3000
CMD ["npm", "run", "start"]

2. CapRover 环境变量设置

在 CapRover 管理界面中，需要添加对应的环境变量：

• 变量名：NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY
• 变量值：你的 Stripe 公钥

3. 代码中的引用方式

在前端代码中，应该这样引用环境变量：

const stripe = Stripe(process.env.NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY);

技术原理

这种配置方式之所以有效，是因为：

1. ARG 指令允许在构建时传入变量值
2. ENV 指令将这些值设置为容器环境变量
3. Next.js 构建过程会识别 NEXT_PUBLIC_ 前缀的变量，并将其硬编码到前端代码中
4. 运行时前端代码可以直接访问这些硬编码的值

最佳实践建议

1. 对于敏感信息如 Stripe 密钥，建议：

   • 使用测试环境密钥进行开发和部署测试
   • 通过 CapRover 的加密环境变量功能保护生产环境密钥
   • 定期轮换密钥

2. 对于其他前端环境变量，遵循相同模式：

   • 变量名以 NEXT_PUBLIC_ 开头
   • 同时在 Dockerfile 和 CapRover 环境中配置

3. 部署后验证：

   • 检查构建日志确认变量已正确注入
   • 在浏览器开发者工具中检查最终生成的代码是否包含正确的变量值

通过以上配置，开发者可以确保 Next.js 应用在 CapRover 平台上能够正确访问前端环境变量，从而解决 Stripe 集成等类似问题。