本文介绍在使用 Webpack 4 配置服务端渲染（SSR）环境时，因 mini-css-extract-plugin 在服务端打包中引用了 document 对象而引发的 ReferenceError。通过区分客户端与服务端配置，服务端使用 vue-style-loader 替代 mini-css-extract-plugin，可有效解决该错误。
Webpack 4 SSR 配置问题背景
最近在使用 Webpack 4 配置服务端渲染（SSR）环境时，遇到了一个典型问题。
ReferenceError: document is not defined
本次项目 package.json 中使用的关键版本信息如下：
{
"vue-loader": "^15.4.2",
"mini-css-extract-plugin": "^0.4.3",
"webpack": "^4.20.2",
"webpack-cli": "^3.1.2"
...
}
相关代码配置见下文。
错误原因分析
问题产生的原因分析：
在服务端渲染的打包配置中，如果使用了 mini-css-extract-plugin，会导致生成的 server bundle 中包含对 document 对象的引用。由于 Node.js 服务端环境中不存在 window 对象，因此会抛出 ReferenceError: document is not defined 错误。
解决方案与配置差异
针对该问题的解决思路：
在基础配置 webpack.base.config.js 中，不应配置样式相关的 loader，以避免客户端和服务端配置冲突。
# 基本配置
const path = require('path')
const webpack = require('webpack')
const {VueLoaderPlugin} = require('vue-loader')
const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin')
const resolve = dir => path.join(__dirname, '../', dir)
const isProd = process.env.NODE_ENV === 'production'
const base = {
mode: isProd ? 'production' : 'development',
devtool: isProd ? false : 'cheap-eval-source-map',
output: {
path: path.resolve(__dirname, '../dist'),
publicPath: '/dist/',
filename: '[name].[chunkhash].js'
},
resolve: {
alias: {
'vue$': 'vue/dist/vue.esm.js',
'public': path.resolve(__dirname, '../public')
}
},
module: {
noParse: /es6-promise\.js$/, // avoid webpack shimming process
rules: [
{
test: /\.vue$/,
loader: 'vue-loader',
include: resolve("src")
},
{
test: /\.js$/,
loader: 'babel-loader',
exclude: file => (
/node_modules/.test(file) && !/\.vue\.js/.test(file)
)
},
{
test: /\.(png|jpg|gif|svg)$/,
loader: 'url-loader',
options: {
limit: 10000,
name: '[name].[ext]?[hash]'
}
}
]
},
plugins: setPlugin()
}
function setPlugin() {
const base = [new VueLoaderPlugin()]
const dev = [new FriendlyErrorsPlugin()]
const prod = []
return base.concat(isProd ? prod : dev)
}
module.exports = base;
在客户端配置 webpack.client.config.js 中，可以正常使用 mini-css-extract-plugin 来提取 CSS。
# 只展示先关配置
const webpack = require('webpack')
const merge = require('webpack-merge')
const base = require('./webpack.base.config')
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const VueSSRClientPlugin = require('vue-server-renderer/client-plugin')
const isProd = process.env.NODE_ENV === 'production'
const config = merge(base, {
module: {
rules: [
{
test: /\.styl(us)?$/,
use: [
isProd ? MiniCssExtractPlugin.loader : 'vue-style-loader',
{
loader: 'css-loader'
},
'stylus-loader'
],
},
{
test: /\.(le|c)ss$/,
use: [
isProd ? MiniCssExtractPlugin.loader : 'vue-style-loader',
{
loader: 'css-loader'
},
'less-loader',
],
}
]
},
plugins: [
new MiniCssExtractPlugin({
filename: isProd ? '[name].[chunkhash].css' : '[name].css',
chunkFilename: isProd ? '[id].[chunkhash].css': '[id].css',
}),
new VueSSRClientPlugin()
]
})
module.exports = config
在服务端配置 webpack.server.config.js 中，不应使用 mini-css-extract-plugin，而应使用 vue-style-loader 等适用于服务端的样式处理方案。
# 只展示先关配置
const webpack = require('webpack')
const merge = require('webpack-merge')
const base = require('./webpack.base.config')
const VueSSRServerPlugin = require('vue-server-renderer/server-plugin')
module.exports = merge(base, {
target: 'node',
module: {
rules: [
{
test: /\.styl(us)?$/,
use: [
'vue-style-loader',
{
loader: 'css-loader'
},
'stylus-loader'
],
},
{
test: /\.(le|c)ss$/,
use: [
'vue-style-loader',
{
loader: 'css-loader'
},
'less-loader',
],
}
]
},
plugins: [
new VueSSRServerPlugin()
]
})
参考资源与总结
参考 Demo 项目：
tiodot/vnews
相关 Issues 讨论：
vue-loader@15.0.0-rc.1 in a server bundle
webpack-contrib/mini-css-extract-plugin
总结：
由于 Webpack 4 版本较新，周边插件可能未能及时完全适配 SSR 场景；
相信随着社区的持续努力，整个生态将更加健壮和完善。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。