Nextjs 公共变量
next.js 因其对环境变量的处理而受到臭名昭著的批评。虽然多年来它已经得到了改进,但它仍然存在一些可能令人困惑的怪癖,特别是当涉及到通过 process.env 对象公开的公共变量时。
所有 next_public_ 前缀的变量都是客户端可访问的,但正如官方文档中提到的,它们仅在构建时可用,因此与 docker 一起使用时无法在运行时更改。
虽然我过去已经讨论过这个问题,但我发现了另一种可能有趣的探索方法,即使用可以在运行时更改的全局共享变量。
设置 polyfill
next.js 部分支持全局变量,但我们可以通过一个小的注入脚本使用 polyfill 来使它们可用。
// app/layout.tsx <script dangerouslysetinnerhtml="{{" __html: e t.prototype._t_ globalthis></script>
原始代码取自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) <p>load 是一个返回 process.env 对象的简单函数,而 parseorthrow 是一个实用函数,它使用 zod 模式解析变量,并在变量无效时抛出错误。</p> <p>最后,我们可以创建一个变量.ts 文件,其中包含变量架构以及用于加载和解析变量的实用函数。<br></p>// 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 ( {children} ); }参考
- next.js 环境变量
- next.js github 讨论
以上就是Nextjs 公共变量的详细内容,更多请关注其它相关文章!