Next.js运行时按环境注入head脚本且避免配置泄露的实现咨询
Next.js 中实现服务端动态注入环境关联脚本的正确方案
现有代码的核心问题
你目前在_app.tsx的Head标签内直接调用getScripts()的写法存在两处硬伤:
_app.tsx属于默认客户端渲染的组件层级,一旦getScripts()实现里引入了存储全量端点的JSON配置,整个配置内容会被Webpack打进客户端静态资源包,直接泄露所有环境的端点信息,完全违背你的隐私要求- OpenShift注入的
process.env.ENVIRONMENT是Pod运行时的环境变量,在客户端渲染阶段无法直接读取,会导致环境判断逻辑失效
核心实现原则
要满足全量配置不暴露的要求,必须遵循两条规则:
- 所有读取全量配置、判断当前运行时环境的逻辑,必须完全放在服务端执行,绝对不能被打包到客户端代码路径中
- 仅把当前环境匹配到的单个脚本src值传递到客户端渲染,全量配置文件永远不能被任何客户端侧代码引用
分场景实现方法
场景1:使用App Router(Next.js 13+)
App Router的根布局默认作为服务端组件运行,代码逻辑仅在服务端执行,不会被打包到客户端静态资源中,是实现该需求的合适入口:
- 在
app/layout.tsx(无'use client'标记的默认服务端组件)中直接引入全量配置JSON,这个操作仅会在服务端生效 - 直接读取
process.env.ENVIRONMENT值,通过判断逻辑选出当前环境对应的脚本src - 引入Next.js官方的
Script组件,将选中的src配置到head中,设置加载优先级为beforeInteractive,保证脚本在页面可交互前完成加载
参考实现代码:
// app/layout.tsx import Script from 'next/script' // 这个全量配置仅在服务端被读取,不会进入客户端bundle import fullScriptConfig from '@/config/full-script-config.json' // 服务端执行判断逻辑,客户端完全感知不到全量配置的存在 const getMatchedScriptSrc = () => { const currentEnv = process.env.ENVIRONMENT if (currentEnv === 'test') return fullScriptConfig.test if (currentEnv === 'prod') return fullScriptConfig.prod // 兜底默认值 return fullScriptConfig.default } export default function RootLayout({ children }: { children: React.ReactNode }) { const matchedScriptSrc = getMatchedScriptSrc() return ( <html lang="zh-CN"> <head> <Script src={matchedScriptSrc} strategy="beforeInteractive" /> </head> <body>{children}</body> </html> ) }
场景2:使用Pages Router(传统Next.js)
Pages Router下绝对不能在_app.tsx中引入全量配置文件,否则全量配置会被打包到客户端。正确的实现入口是pages/_document.tsx,该文件的getInitialProps方法完全运行在服务端,执行完成后才会将结果传递到客户端:
- 在
pages/_document.tsx中重写getInitialProps静态方法,在方法内引入全量配置JSON、读取运行时环境变量做判断,选出当前环境对应的脚本src - 将选中的src值作为props返回,在head标签中注入对应的script标签
getInitialProps内的代码永远不会被打包到客户端,在这里读取全量配置是完全安全的
参考实现代码:
// pages/_document.tsx import Document, { Html, Head, Main, NextScript } from 'next/document' class CustomDocument extends Document { static async getInitialProps(ctx) { const initialProps = await Document.getInitialProps(ctx) // 以下逻辑完全运行在服务端,客户端不会执行这段代码 const fullConfig = require('@/config/full-script-config.json') const currentEnv = process.env.ENVIRONMENT let matchedSrc = fullConfig.default if (currentEnv === 'test') matchedSrc = fullConfig.test if (currentEnv === 'prod') matchedSrc = fullConfig.prod // 仅将单个匹配到的src值传递到客户端上下文 return { ...initialProps, matchedScriptSrc: matchedSrc } } render() { return ( <Html> <Head> <script src={this.props.matchedScriptSrc} type="text/javascript" /> </Head> <body> <Main /> <NextScript /> </body> </Html> ) } } export default CustomDocument
适配原有Express使用习惯的补充操作
如果你习惯将脚本src值直接挂载到window对象上,可以在服务端完成src判断后,直接在head中注入内联脚本完成赋值:
// 服务端判断出matchedScriptSrc值后,注入内联脚本 <script dangerouslySetInnerHTML={{ __html: `window.__APP_EXTERNAL_SCRIPT_SRC__ = '${matchedScriptSrc}'` }} />
这个写法可以保证页面HTML加载完成时,window上的自定义属性已经被赋值,不会出现客户端脚本读取值时的时序问题。
如果你的Next.js配置为静态导出模式(设置了
output: 'export'),上述服务端运行时逻辑无法生效——因为静态导出的应用没有常驻服务端运行时,无法读取OpenShift注入的Pod环境变量。这种场景下需要在前置网关层配置请求拦截,在返回静态index.html时完成当前环境脚本src的替换,避免全量配置打包到静态资源中。
内容的提问来源于stack exchange,提问作者Abhijeet Singh
相关产品推荐
相关产品推荐

