webpack 4.0 学习日志(十一)—— 构建开发和生产环境-分离配置文件框架

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 就不会有太多相同或重复的内容,只要写出他们不同的部分就好了,这样也好维护啊。

├── webpack.common.js
├── webpack.dev.js
└── webpack.prod.js

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

首先来安装这个工具。

$ 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

const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin');
const ExtractTextPlugin = require('extract-text-webpack-plugin');
const CleanWebpackPlugin = require('clean-webpack-plugin');
const webpack = require('webpack');

module.exports = {
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: '[name].[chunkhash].js'
  },
  plugins: [
    new webpack.ProvidePlugin({
      $: 'jquery',
      jQuery: 'jquery'
    }),
    new CleanWebpackPlugin(['dist']),
    new HtmlWebpackPlugin({
      template: './src/index.html',
      filename: 'index.html',
      minify: false,
      hash: process.env.NODE_ENV === 'production',
      excludeChunks: ['contact']
    }),
    new HtmlWebpackPlugin({
      template: './src/contact.html',
      filename: 'contact.html',
      minify: false,
      hash: process.env.NODE_ENV === 'production',
      chunks: ['contact']
    }),
    new ExtractTextPlugin({
      filename: '[name].[contenthash].css',
      disable: false,
    }),
  ],
  module: {
    rules: [
      {
        test: /\.scss$/,
        use: ExtractTextPlugin.extract({
          fallback: 'style-loader',
          use: ['css-loader?sourceMap', 'sass-loader?sourceMap']
        })
      },
      { test: /\.js$/, loader: 'babel-loader', exclude: /node_modules/ },
      { test: /\.jsx$/, loader: 'babel-loader', exclude: /node_modules/ },
      { test: /\.pug$/, loader: ['raw-loader', 'pug-html-loader'] },
      {
        test: /\.(gif|png|jpe?g|svg)$/i,
        use: [
          {
            loader: 'file-loader',
            options: {
              name: '[name].[ext]',
              outputPath: 'images/'
            }
          },
          {
            loader: 'image-webpack-loader',
            options: {
              bypassOnDebug: true,
            }
          }
        ]
      },
      {
        test: /\.html$/,
        use: [{
          loader: 'html-loader',
        }]
      },
      { test: /\.woff2?$/, loader: 'url-loader?limit=10000&name=[name].[ext]&outputPath=fonts/' },
      { test: /\.(ttf|eot)$/, loader: 'file-loader?name=[name].[ext]&outputPath=fonts/' },
      { test:/bootstrap-sass[\/\\]assets[\/\\]javascripts[\/\\]/, loader: 'imports-loader?jQuery=jquery' },
    ]
  }
};

webpack.dev.js

const merge = require('webpack-merge');
const common = require('./webpack.common.js');
const bootstrapEntryPoints = require('./webpack.bootstrap.config')

module.exports = merge(common, {
  entry: {
    "app.bundle": './src/app.js',
    "contact": './src/contact.js',
    "bootstrap": bootstrapEntryPoints.dev
  },
  devtool: 'inline-source-map',
  devServer: {
    contentBase: './dist',
    inline: true,
    port: 9000,
    open: true,
  }
});

webpack.prod.js

const merge = require('webpack-merge');
const common = require('./webpack.common.js');
const bootstrapEntryPoints = require('./webpack.bootstrap.config')
const webpack = require('webpack');

module.exports = merge(common, {
  entry: {
    "app.bundle": './src/app.js',
    "contact": './src/contact.js',
    "bootstrap": bootstrapEntryPoints.prod
  },
  plugins: [
    new webpack.DefinePlugin({
      'process.env': {
        'NODE_ENV': JSON.stringify('production')
      }
    })
  ]
});

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

{
  "scripts": {
    "dev": "webpack-dev-server --config webpack.dev.js",
    "prod": "webpack -p --config webpack.prod.js"
  }
}

npm run dev 的运行结果如下:

npm run prod 的运行结果如下:

本文转自:https://www.rails365.net/groups,由于原文为webpack3,有很多不同于4.0固做了修改
另附上Webpack 3.X - 4.X 升级记录
以及我的练习配置代码


const HtmlWebpackPlugin = require('html-webpack-plugin'); //引入插件html-webpack-plugin
// const ExtractTextPlugin = require('extract-text-webpack-plugin');//引入插件extract-text-webpack-plugin
// const MiniCssExtractPlugin = require("mini-css-extract-plugin");//引入插件mini-css-extract-plugin
const CleanWebpackPlugin = require('clean-webpack-plugin'); //引入清除文件插件

module.exports = {
  entry: {
    'app.bundle':'./src/index.js',
    'contact':'./src/contact.js'
  },//输入文件路径 entry 的默认值是 ./src 
  output: {
    path: __dirname + '/dist', //output.path 的默认值是 ./dist path:对应一个绝对路径,此路径是希望一次性打包的目录
    //修改为hash模式
    filename: '[name].[chunkhash].js'//能指定出口文件中同样的filename名称 filename:编译文件的文件名,首选推荐:main.js||bundle.js||index.js
  },
  devServer: {//webpack-dev-server的运用
    port: 9000,// 端口
    open: true // 执行立即打开浏览器
  },

  // 由于plugin可以携带参数/选项,必须在wepback配置中,向plugins属性传入new实例
  plugins: [
    new HtmlWebpackPlugin({
      template: './src/index.html',//根据自己的指定的模板文件来生成特定的 html 文件。这里的模板类型可以是任意你喜欢的模板,可以是 html, jade, ejs, hbs, 等等,但是要注意的是,使用自定义的模板文件时,需要提前安装对应的 loader, 否则webpack不能正确解析
      filename: 'index.html',// 默认情况下生成的 html 文件叫 index.html
      minify: {
        collapseWhitespace: true, //把生成的 index.html 文件的内容的没用空格去掉,减少空间
      },
      hash: true, //为了更好的 cache,可以在文件名后加个 hash。
      excludeChunks: ['contact']
    }),
    new HtmlWebpackPlugin({
      template: './src/contact.html',
      filename: 'contact.html',
      minify: {
        collapseWhitespace: true,
      },
      hash: true,
      chunks: ['contact']
    }),
    // new ExtractTextPlugin('style.css') //实例ExtractTextPlugin,4.0弃用
    // new MiniCssExtractPlugin({//实例MiniCssExtractPlugin
    //   // Options similar to the same options in webpackOptions.output
    //   // both options are optional
    //   filename: "style.css",
    //   chunkFilename: "app.scss"
    // })
    new CleanWebpackPlugin(['dist']),//实例化,参数为目录
  ],
  module: {
    rules: [
      {
        test: /\.scss$/, //正则验证格式

        use: [ 'style-loader', 'css-loader', 'sass-loader' ] //安装的loader

        // ExtractTextPlugin 4.0弃用
        // use: ExtractTextPlugin.extract({
        //   fallback: 'style-loader',
        //   //resolve-url-loader may be chained before sass-loader if necessary
        //   use: ['css-loader', 'sass-loader']
        // })

        // MiniCssExtractPlugin
        // use: [
        //   // MiniCssExtractPlugin.loader,
        //   "css-loader",
        //   'sass-loader'
        // ]
      },
      {
        test: /\.(gif|png|jpe?g|svg)$/i,//处理图片loader
        use: [
          {
            loader: 'file-loader',
            options: {
              name: '[name].[ext]',
              outputPath: 'images/'
            }
          },
          {
            loader: 'image-webpack-loader',//压缩图片插件
            options: {
              bypassOnDebug: true,
            }
          }
        ]
      },
      // 下面几行才是 html-loader 的配置内容
      {
        test: /\.html$/,//处理htmlloader
        use: [ {
          loader: 'html-loader',
          options: {
            minimize: true
          }
        }],
      }
    ]
  },
};
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容