Next.js 公共变量-js教程-PHP中文网

Next.js 公共变量

Barbara Streisand

发布： 2024-10-21 20:41:30

原创

435 人浏览过

Next.js Public Variables

Next.js 因其对环境变量的处理而受到臭名昭著的批评。尽管多年来它已经得到了改进，但它仍然存在一些可能令人困惑的怪癖，特别是当涉及到通过 process.env 对象公开的公共变量时。

所有 NEXT_PUBLIC_ 前缀的变量都是客户端可访问的，但正如官方文档中提到的，它们仅在构建时可用，因此与 Docker 一起使用时无法在运行时更改。

虽然我过去已经讨论过这个问题，但我发现了另一种可能有趣的探索方法，即使用可以在运行时更改的全局共享变量。

设置 Polyfill

Next.js 部分支持全局变量，但我们可以通过一个小的注入脚本使用 polyfill 来使它们可用。

// app/layout.tsx
<script
  dangerouslySetInnerHTML={{
    __html: `!function(t){function e(){var e=this||self;e.globalThis=e,delete t.prototype._T_}"object"!=typeof globalThis&&(this?e():(t.defineProperty(t.prototype,"_T_",{configurable:!0,get:e}),_T_))}(Object);`,
  }}
/>

登录后复制

原始代码取自GitHub上的这个评论，它基本上创建了一个全局的globalThis对象，可用于在客户端和服务器之间共享变量。 Polyfill 随 Next.js 14.x 一起提供，但它似乎破坏了某些浏览器中的 globalThis 对象，这就是我们使用 __html 属性将代码直接注入页面的原因。

使用 Zod 验证变量

接下来，我们可以使用 Zod 在运行时验证变量，如果变量无效则抛出错误。此步骤对于确保变量始终可用且有效、避免运行时错误以及使应用程序面临安全问题至关重要。

npm install zod

登录后复制

然后我们创建一个变量.ts 文件，其中包含一些实用函数，用于从 process.env 中获取变量并将它们安全地转换为预期类型。

// lib/env.ts
import { z } from 'zod';

// Load the variables
export const load = () => {
  return process.env;
};

// Parse or throw the variables
export function parseOrThrow(schema: z.Schema, data: unknown, error: Error) {
  const parsed = schema.safeParse(data);
  // Log the errror
  if (parsed.success) return parsed.data;
  console.error(parsed.error);
  throw error;
}

// Some zod helpers to use
export const port = z
  .string()
  .refine(
    (port) => parseInt(port) > 0 && parseInt(port) < 65536,
    'Invalid port number'
  );

export const str = z.string();
export const url = z.string().url();
export const num = z.coerce.number();
export const bool = z.coerce.boolean();

登录后复制

load 是一个返回 process.env 对象的简单函数，而 parseOrThrow 是一个实用函数，它使用 Zod 模式解析变量，并在变量无效时抛出错误。

最后，我们可以创建一个变量.ts 文件，其中包含变量架构以及用于加载和解析变量的实用函数。

// lib/vars.ts
import { z } from 'zod';
import { load, parseOrThrow } from './env';
import { parseOrThrow, load, str, num, bool, port } from './env';

// Define the variables schema
const schema = z.object({
  PUBLIC_VARIABLE: str.optional(),
  PUBLIC_MY_NUM: num,
  PUBLIC_BOOL: bool,
  PUBLIC_PORT: port,
});

export const loadEnv = () => {
  const env = load();
  const parsed = parseOrThrow(schema, env, new Error('Invalid variables'));
  for (const key of Object.keys(parsed)) {
    if (!globalThis[key]) {
      globalThis[key] = parsed[key];
    }
  }
};

登录后复制

使用变量

为了使用变量，我们需要先加载它们。我们可以在 app/layout.tsx 文件或任何其他布局文件中执行此操作，以逐渐将它们暴露给应用程序的其余部分，无论是在客户端还是在服务器上。

// app/layout.tsx
import { loadEnv } from '@/lib/vars';

loadEnv();

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  );
}

登录后复制