(Webpack) 当我尝试导入客户端库时，为什么会出现 ReferenceError: self is not defined in Next.js？

Question

尝试在Next.js 中创建一个xterm react 组件时我被卡住了，因为我无法克服以前从未收到过的错误消息。

我正在尝试导入一个名为 的 npm 客户端模块xterm，但是如果我添加导入行，应用程序就会崩溃。

import { Terminal } from 'xterm'

错误读取Server Error... ReferenceError: self is not defined 然后将此代码块显示为Source

module.exports = require("xterm");

根据我所做的一些研究，这与 Webpack 有关，如果这样做会有所帮助：

output: {
  globalObject: 'this'
}

你知道如何解决这个问题吗？先感谢您！

Answer 1

发生错误是因为当 Next.js 在服务器端预渲染该页面时，xterm尝试访问window不可用的对象。要修复它，您必须动态导入，xterm以便它仅在客户端加载。

在 Next.js 中有几种方法可以实现这一点。

使用动态 import()

将 移动import到您的组件的useEffect，然后动态导入库并在那里添加您的逻辑。

useEffect(() => {
    const initTerminal = async () => {
        const { Terminal } = await import('xterm')
        const term = new Terminal()
        // Add logic with `term`
    }
    initTerminal()
}, [])

使用next/dynamic与ssr: false

创建一个组件，您可以在其中添加xterm逻辑。

// components/terminal-component
import { Terminal } from 'xterm'

function TerminalComponent() {
    const term = new Terminal()
    // Add logic around `term`
    return <></>
}

export default TerminalComponent

然后在使用时动态导入该组件。

import dynamic from 'next/dynamic'

const TerminalComponent = dynamic(() => import('<path-to>/components/terminal-component'), {
    ssr: false
})

作为替代方案，您可以在动态导入库时直接添加逻辑next/dynamic以避免为它添加额外的文件。

import dynamic from 'next/dynamic'

const Terminal = dynamic(
    {
        loader: () => import('xterm').then((mod) => mod.Terminal),
        render: (props, Terminal) => {
            const term = new Terminal()
            // Add logic with `term`
            return <></>
        }
    },
    {
        ssr: false
    }
)