• 1. 前言
  • 2. 操作

    1. 前言

    以前本系列教程的其中一篇文章 13. 生产环境 vs 开发环境 有写过如何处理开发和线上环境的配置的差异性问题,之前我们是用一个环境变量 NODE_ENV=production,这个环境变量是放在命令行中,作为命令行的一部分,比如 NODE_ENV=production webpack -p,传入到配置文件webpack.config.js 中,由它通过 process.env.NODE_ENV 这样来引用,从而来判断是开发环境或生产环境。

    我们始终使用的是同一个配置文件,即 webpack.config.js,区别不同的环境是通过变量,这节我们来讲下比较普遍使用的作法,也是官方推荐的作法,来实现配置文件的分离。

    首先要明白的一点是,为什么要分离成不同的环境配置文件呢?主要是开发和生产环境的差异性比较大,比如我们开发环境需要一个 webpack-dev-server 而生产环境不需要,生产环境只需要保证编译出来的文件体积足够小,性能足够好就可以,开发环境也不需要压缩文件,不压缩反而能看得清楚编译后的源码,而生产环境就要保证体积小,所以要压缩编译后的文件。

    之前我们也写了不少配置,现在我们就把它们整理一遍,主要是参照官方的这一篇文档: 生产环境构建,我也把这次的提交放到 github 上了,有兴趣的可以直接来看。

    我们根据文档把这个操作实践一遍,这边主要是贴代码加一些简单的讲解。

    2. 操作

    首先把 webpack.config.js 一分为二,开发环境的配置文件叫 webpack.dev.js,而生产环境的叫 webpack.prod.js,除此之外,还要多加一个文件,就是把他们共同的部分抽出来,单独成一个文件,叫 webpack.common.js,这样 webpack.dev.jswebpack.prod.js 就不会有太多相同或重复的内容,只要写出他们不同的部分就好了,这样也好维护啊。

    1. ├── webpack.common.js
    2. ├── webpack.dev.js
    3. └── webpack.prod.js

    抽出来相同的内容为 webpack.common.js 再加上差异化的部分 webpack.dev.jswebpack.prod.js,那总要把它们合起来才是可读取的真正的配置文件,如何合起来呢,官方提供了一个工具:webpack-merge。

    首先来安装这个工具。

    1. $ npm install --save-dev webpack-merge

    接下来我就要来贴代码啦,贴代码之前,先列一下这次的一些改动:

    1. 去掉了 HMR,之前临时为了 HMR 而改的 [name].[hash].js 也改回来了 [name].[chunkhash].js,可以查看回这篇文章 12. 如何使用模块热替换 HMR 来处理 CSS

    2. 用了 DefinePlugin 这个插件 来定义全局变量,参见下面的 webpack.prod.js 文件,关于它的用法可以看这篇文章 webpack.DefinePlugin使用介绍。

    3. 其他一些细微的调整,比如 sass-loader 那部分,还有 svg 文件的处理等。

    4. 开发环境使用了 devtool: 'inline-source-map',编译出来的 bundle 文件较大。

    5. css 使用 contenthash 而不是 chunkhash,文件内容一改变,文件名才改变。

    开始贴代码。

    webpack.common.js

    1. const path = require('path')
    2. const HtmlWebpackPlugin = require('html-webpack-plugin');
    3. const ExtractTextPlugin = require('extract-text-webpack-plugin');
    4. const CleanWebpackPlugin = require('clean-webpack-plugin');
    5. const webpack = require('webpack');
    6. module.exports = {
    7. output: {
    8. path: path.resolve(__dirname, 'dist'),
    9. filename: '[name].[chunkhash].js'
    10. },
    11. plugins: [
    12. new webpack.ProvidePlugin({
    13. $: 'jquery',
    14. jQuery: 'jquery'
    15. }),
    16. new CleanWebpackPlugin(['dist']),
    17. new HtmlWebpackPlugin({
    18. template: './src/index.html',
    19. filename: 'index.html',
    20. minify: false,
    21. hash: process.env.NODE_ENV === 'production',
    22. excludeChunks: ['contact']
    23. }),
    24. new HtmlWebpackPlugin({
    25. template: './src/contact.html',
    26. filename: 'contact.html',
    27. minify: false,
    28. hash: process.env.NODE_ENV === 'production',
    29. chunks: ['contact']
    30. }),
    31. new ExtractTextPlugin({
    32. filename: '[name].[contenthash].css',
    33. disable: false,
    34. }),
    35. ],
    36. module: {
    37. rules: [
    38. {
    39. test: /\.scss$/,
    40. use: ExtractTextPlugin.extract({
    41. fallback: 'style-loader',
    42. use: ['css-loader?sourceMap', 'sass-loader?sourceMap']
    43. })
    44. },
    45. { test: /\.js$/, loader: 'babel-loader', exclude: /node_modules/ },
    46. { test: /\.jsx$/, loader: 'babel-loader', exclude: /node_modules/ },
    47. { test: /\.pug$/, loader: ['raw-loader', 'pug-html-loader'] },
    48. {
    49. test: /\.(gif|png|jpe?g|svg)$/i,
    50. use: [
    51. {
    52. loader: 'file-loader',
    53. options: {
    54. name: '[name].[ext]',
    55. outputPath: 'images/'
    56. }
    57. },
    58. {
    59. loader: 'image-webpack-loader',
    60. options: {
    61. bypassOnDebug: true,
    62. }
    63. }
    64. ]
    65. },
    66. {
    67. test: /\.html$/,
    68. use: [{
    69. loader: 'html-loader',
    70. }]
    71. },
    72. { test: /\.woff2?$/, loader: 'url-loader?limit=10000&name=[name].[ext]&outputPath=fonts/' },
    73. { test: /\.(ttf|eot)$/, loader: 'file-loader?name=[name].[ext]&outputPath=fonts/' },
    74. { test:/bootstrap-sass[\/\\]assets[\/\\]javascripts[\/\\]/, loader: 'imports-loader?jQuery=jquery' },
    75. ]
    76. }
    77. };

    webpack.dev.js

    1. const merge = require('webpack-merge');
    2. const common = require('./webpack.common.js');
    3. const bootstrapEntryPoints = require('./webpack.bootstrap.config')
    4. module.exports = merge(common, {
    5. entry: {
    6. "app.bundle": './src/app.js',
    7. "contact": './src/contact.js',
    8. "bootstrap": bootstrapEntryPoints.dev
    9. },
    10. devtool: 'inline-source-map',
    11. devServer: {
    12. contentBase: './dist',
    13. inline: true,
    14. port: 9000,
    15. open: true,
    16. }
    17. });

    webpack.prod.js

    1. const merge = require('webpack-merge');
    2. const common = require('./webpack.common.js');
    3. const bootstrapEntryPoints = require('./webpack.bootstrap.config')
    4. const webpack = require('webpack');
    5. module.exports = merge(common, {
    6. entry: {
    7. "app.bundle": './src/app.js',
    8. "contact": './src/contact.js',
    9. "bootstrap": bootstrapEntryPoints.prod
    10. },
    11. plugins: [
    12. new webpack.DefinePlugin({
    13. 'process.env': {
    14. 'NODE_ENV': JSON.stringify('production')
    15. }
    16. })
    17. ]
    18. });

    最后记得修改一下 package.json 文件。

    1. {
    2. "scripts": {
    3. "dev": "webpack-dev-server --config webpack.dev.js",
    4. "prod": "webpack -p --config webpack.prod.js"
    5. }
    6. }

    npm run dev 的运行结果如下:

    18. 构建开发和生产环境-分离配置文件 - 图1

    18. 构建开发和生产环境-分离配置文件 - 图2

    npm run prod 的运行结果如下:

    18. 构建开发和生产环境-分离配置文件 - 图3

    18. 构建开发和生产环境-分离配置文件 - 图4

    先说这么多吧。