Development开发环境和production生产环境的区分打包
在实际开发实践中,为了方便开发调试和上线,项目中我们一般配置两个webpack配置,一个是开发环境一个是生产环境,开发环境帮助我们快速开发测试连调,生产环境保证上线环境的打包流程是最优化体验,这就是配置文件根据环境进行区分。
配置文件拆分最重要的收益是我们可以提取不同目标之间的共性,将经常改动的配置跟公共配置分开。并且还可以识别要组合的较小配置部件,这些配置不仅可以推送到自己的软件包以跨项目使用。另外,配置拆分还可以将配置作为依赖项进行管理,而不是在多个项目中复制类似的配置。
开发环境和生产环境需要注意的区别
生产环境可能需要分离css成单独的文件,以便多个页面共享一个css文件
生产环境需要压缩HTML/CSS/Js代码;
生产环境需要压缩图片;
开发环境需要生成SourceMap文件;
开发环境需要打印debug信息
开发环境需要HMR,devServer等功能……
按环境划分Webpack配置文件
Webpack.config.js:所有环境的默认入口配置文件
webpack.base.js:基础部分,即多个文件中共享的配置;
webpack.development.js:开发环境使用的配置;
webpack.production.js:生产环境使用的配置。
webpack.config.js
const baseWebpackConfig = require('./webpack.base.js');
const devWebpackConfig = require('./webpack.development.js');
const merge = require('webpack-merge');
module.exports = merge(baseWebpackConfig, devWebpackConfig);
webpack development config
webpack.development.js文件里面的配置多数跟开发环境相关的配置,例如devServer和一些开发环境中需要的 plugin,比如 hmr、devServer、devtool 等。
webpack production config
这里的配置主要包括了跟生产环境相关的配置项,例如optimization、devtool等。
webpack base config
webpack.base.js是公共部分的配置,除了完全一致的内容之外,还可能会涉及到一些根据不同环境做的事情,比如 style-loader在开发环境用,而生产环境是用mini-css-extract-plugin的 loader,这时候需要使用环境变量来判断。
有两种方式来判断当前的环境变量:
使用环境变量,例如 cross-env + NODE_ENV;
使用 Webpack 配置文件的function 方式。
Tips:这是因为我们所有的入口文件都是webpack.config.js。当然如果我们使用 Webpack 的时候,就已经在npm scripts里面区分了配置文件(webpack --config webpack.production.js),就不在讨论范围之内了。这里只是顺着之前的逻辑继续分析下去。
cross-env
首先安装 cross-env:
npm i -D cross-env
然后修改npm scripts内容:
// package.json
{
"scripts": {
"build": "cross-env NODE_ENV=production webpack --config webpack.config.js"
}
}
最后在webpack.base.js中使用环境变量:
// webpack.base.js
const isProduction = process.env.NODE_ENV === 'production';
//....
module.exports = {
// ...
devtool: isProduction ? null : 'source-map'
};
function配置
根据前面的章节我们知道,Webpack 的配置可以是对象,也可以是函数,如果是 function 则接收一个mode参数,即开发环境打包还是生产环境打包。利用这一点我们可以做下面的配置。
首先是修改npm scripts添加--mode选项:
// package.json
{
"scripts": {
"build": "webpack --mode production --config webpack.config.js"
}
}
然后我们可以将配置文件改成 function 类型的配置:
// 以webpack.config.js为例
module.exports = mode => {
if (mode === 'production') {
// 生产环境
} else {
// 开发环境
}
};
将零件配置进行拆分
除了按照开发环境拆分出development和production之外,我们还可以将公共的配置按照 loader、devServer 等相关配置拆到webpack.parts.js文件中,在其他项目直接组装想用的内容即可。
例如下面的配置:
// webpack.parts.js
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
// 获取 css-loader 配置
exports.getCssLoader = ({mode, test = /.css$/, include, exclude, uses = []} = {}) => ({
test,
include,
exclude,
use: [
{
loader: mode === 'production' ? MiniCssExtractPlugin.loader : 'style-loader'
},
{
loader: 'css-loader'
}
].concat(uses)
});
// 获取 devServer 配置
exports.getDevServerConfig = ({host = '0.0.0.0', port = 8888} = {}) => ({
stats: 'errors-only',
host,
port,
open: true,
overlay: true
});
// 获取 url-loader 配置
exports.getUrlLoader = ({test, largeAssetSize = 1000, assetsDir, dir} = {}) => ({
test,
use: {
loader: 'url-loader',
options: {
limit: largeAssetSize,
name: getAssetPath(assetsDir, `${dir}/[name]${isProduction ? '.[hash:8]' : ''}.[ext]`)
}
}
});
// .....
使用的时候,直接调用对应的方法即可:
const partsConfig = require('./webpack.parts.js');
module.exports = {
mode: 'production',
devtool: 'source-map',
//...
devServer: partsConfig.getDevServer(),
modules: {
rules: [
partsConfig.getCssLoader(),
partsConfig.getUrlLoader({test: /.(png|jpe?g|gif|webp|svg)(?.*)?$/, dir: 'img'})
// ....
]
}
};
小结
在一个 Webpack 项目中,根据不同的使用环境合理划分 Webpack 的配置文件是很有必要的。本文介绍了如何按照开发环境和生产环境划分 Webpack 配置文件,并且介绍了公共配置部分拆分规则,可以使用 cross-env 模块来传入不同的环境变量,这样在公共配置文件内可以根据不同的环境变量进行配置。我们甚至可以将 Webpack 的配置拆成一个个的零件进行自由的搭配。
使用webpack-merge区分打包开发环境和生产环境
分离配置文件
我们在根目录下创建build文件夹,并创建三个配置文件
webpack.common.js
webpack.dev.js
webpack.prod.js
合并配置文件的工具
如果配置文件被分成了许多不同的部分,那么必须以某种方式来组合他们,通常就是合并数组和对象,webpack-merge很好的做到了这一点
webpack-merge做了两件事:它允许连接数组并合并对象,而不是覆盖组合。如下所示:
const merge = require("webpack-merge");
merge(
{a : [1],b:5,c:20},
{a : [2],b:10, d: 421}
)
//合并后的结果
{a : [1,2] ,b :10 , c : 20, d : 421}
那么,如何合并?
1:首先将webpack-merge添加到项目中
npm install webpack-merge -save-dev
在webpack.common.js配置文件中
在webpack.dev.js配置文件中
const webpack = require('webpack');
const merge = require('webpack-merge');
//引入配置信息相同的部分
const commonConfig = require('./webpack.common.js');
const devConfig = {
mode: 'development',
devtool: 'cheap-module-eval-source-map',
devServer: {
contentBase: './dist',
open: true,
port: 8080,
hot: true
},
plugins: [
new webpack.HotModuleReplacementPlugin()
],
optimization: {
usedExports: true
}
}
module.exports = merge(commonConfig, devConfig);
在webpack.prod.js配置文件中
const merge = require('webpack-merge');
const commonConfig = require('./webpack.common.js');
const prodConfig = {
mode: 'production',
devtool: 'cheap-module-source-map'
}
module.exports = merge(commonConfig, prodConfig);
//在package.json中
"scripts": {
"dev": "webpack-dev-server --config ./build/webpack.dev.js",
"build": "webpack --config ./build/webpack.prod.js"
},