[ webpack4 ] 配置屬於自己的打包系統教程(最終篇)—— 環境配置篇

yhtx1997發表於2019-01-03

GitHub 完整配置檔案地址: https://github.com/yhtx1997/webpack4-Instance

由於篇幅過長分三次釋出,建議按順序看

環境配置篇

主要內容

  • 開發環境生產環境分離
  • 實時預覽
  • webpack-dev-server 其他常用
  • 程式碼複用處理

開發環境和生產環境

到了這一步,該講講開發環境模式和生產環境模式了

  • 開發環境是自己開發時用的,需要有實時編譯功能、模組熱替換功能(更新檔案不用完全更新頁面)、錯誤提示到具體哪個檔案幾行
  • 生產環境是放到線上給使用者使用的,需要程式碼壓縮功能

配置程式碼元件化

我們先把之前配置好的 webpack 配置檔案改下名,改名 webpack.common.js ,意思是開發環境和生產環境都需要的,將程式碼壓縮之類的挪到生產配置下 之後安裝 webpack-merge ,官方推薦的是為每個環境寫單獨的 webpack 檔案

雖然有簡單的方法實現但是依然推薦寫單獨的配置檔案,因為在這樣的配置方式你可以更清楚你自己在做什麼,還可以讓你的配置更加個性(自定義)

安裝 webpack-merge

npm install webpack-merge -D
複製程式碼

新建開發環境配置

我們新建一個 js 檔案,命名為 webpack.dev.js ,新增如下程式碼

const merge = require('webpack-merge');//合併配置
const common = require('./webpack.common.js');//引入公共配置

 module.exports = merge(common, {
    mode: 'development',//宣告是開發環境
     //關於 dev 的配置
 })
複製程式碼

新建開發環境配置

我們新建一個 js 檔案,命名為 webpack.prod.js

新增如下程式碼

const merge = require('webpack-merge');//合併配置
const UglifyJSPlugin = require('uglifyjs-webpack-plugin');//用來壓縮 js 程式碼
const common = require('./webpack.common.js');//引入公共配置

module.exports = merge(common, {
    mode: 'production',//宣告是生產環境
    //關於 prod 的配置
});
複製程式碼

開發環境

實時預覽

跟著配置並操作的小夥伴可能發現了,每次修改後都需要手動在命令列輸入命令,並且還要重新整理瀏覽器才能看到最新的效果

那麼現在來解決這兩個問題,方法就是使用 webpack-dev-server

安裝
npm install webpack-dev-server -D
複製程式碼
配置
  • 實時預覽
  • 自定義請求代理
  • 自定義 ip 及埠
  • 注:使用 webpack-dev-server 並不會編譯到本地檔案,而是放到記憶體中
const merge = require('webpack-merge');
const common = require('./webpack.common.js');
const path = require('path');
const webpack = require('webpack');

 module.exports = merge(common, {
    mode: 'development',
    devServer: {
        contentBase: path.join(__dirname, 'dist'),//預覽的目錄,寫出口目錄的絕對路徑
        host: 'localhost',//預設值 也可以改為 127.0.0.1 或者其他
        port: 8080,
        proxy: {
            '/api': 'http://localhost:3000'//請求到 /api/users 現在會被代理到請求 http://localhost:3000/api/users
        }

    }
 })
複製程式碼

接下來加入錯誤提示以及將生成 HTML 的程式碼從公共配置( webpack.common.js )拿到這裡

因為開發和生產有些許不一樣,我又不知道怎樣簡單配置,所以開發環境和生產環境我都會放一個生成 HTML 的程式碼

生產環境

  • 每次打包都要清理掉舊檔案
  • 所有程式碼都要進行壓縮
  • 重複的 js 程式碼,需要只有一個就好

檔案清理

從公共配置( webpack.common.js )將之前檔案清理的程式碼拿過來放到這裡

const merge = require('webpack-merge');
const common = require('./webpack.common.js');
const CleanWebpackPlugin = require('clean-webpack-plugin');

module.exports = merge(common, {
    mode: 'production',
    plugins: [
        new CleanWebpackPlugin(['dist']),
        new HtmlWebpackPlugin({
            title: '2048',
            template: './src/index.html',
            minify: true,//HTML 程式碼壓縮
            hash: true
        }),
    ],
})
複製程式碼

程式碼壓縮

先安裝壓縮程式碼的外掛

npm install uglifyjs-webpack-plugin -D 
npm install optimize-css-assets-webpack-plugin -D 

複製程式碼
  • uglifyjs-webpack-plugin 是 js 壓縮外掛
  • optimize-css-assets-webpack-plugin 是推薦和
const UglifyJsPlugin = require("uglifyjs-webpack-plugin");
const OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin");
複製程式碼

複用程式碼分離

假設需要使用 jQuery 來輔助開發,我在 a.js b.js 兩個檔案都引入了 jQuery ,將 a.js b.js 打包成 a.min.js b.min.js ,這時看他們的體積會比原來大很多,且 a 和 b 的程式碼中都包含完整的 jQuery 程式碼

為了解決這種情況,我們需要將 jQuery 這種複用的程式碼分離到單獨的檔案

在將環境設定為生產環境時預設開啟了很多功能,其中 SplitChunksPlugin 就是用於避免重複依賴的

在我們不配置時 預設配置是這樣的

 optimization: {
    splitChunks: {
      chunks: 'async', 
      minSize: 30000,
      minChunks: 1,
    }
  }

複製程式碼
  • chunks: 表示哪些程式碼需要優化,有三個可選值:initial(初始塊)、async(按需載入塊)、all(全部塊),預設為async 改成 all 支援所有的
  • minSize: 這個檔案最少是多少才去優化,預設為 30000 實際測試是檔案大於 30 kb,在 31kb時開始優化
  • minChunks: 最少引用幾次才去優化,預設為1 實際測試為在只引用一次的情況不優化,只有大於它才優化
  • 注: 還有其他屬性個人感覺不常用就沒寫,瞭解更多可以看這裡

最終程式碼彙總

最終公共配置 webpack.common.js 程式碼如下

const path = require('path');
const MiniCssExtractPlugin = require("mini-css-extract-plugin");

module.exports = {
    entry: {
        512:'./src/js/512.js',
        1024:'./src/js/1024.js',
        2048:'./src/js/2048.js',
    },
    plugins: [
        new MiniCssExtractPlugin({
            filename: "css/[name].css"
        })
    ],
    output: {
        filename: "js/[name].js",
        path: path.resolve(__dirname, 'dist')
    },
    module: {
        rules: [
            {
                test: /\.js$/,
                exclude: /(node_modules|bower_components)/,
                use: {
                  loader: 'babel-loader',
                  options: {
                    presets: ['@babel/preset-env']
                  }
                }
              },
              {
                test: /\.scss$/,
                use: [
                    MiniCssExtractPlugin.loader,
                    'css-loader',
                    'postcss-loader',
                    'sass-loader',
                ]
            },
            {
                test: /\.(png|svg|jpg|gif)$/,
                use: [
                    'file-loader'
                ]
            },
            {
                test: /\.(woff|woff2|eot|ttf|otf)$/,
                use: [
                    'file-loader'
                ]
            },
            {
                test: /\.(csv|tsv)$/,
                use: [
                    'csv-loader'
                ]
            },
            {
                test: /\.xml$/,
                use: [
                    'xml-loader'
                ]
            }
        ]
    },

}
複製程式碼

最終開發環境 webpack.dev.js 程式碼如下

const merge = require('webpack-merge');
const common = require('./webpack.common.js');
const path = require('path');
const webpack = require('webpack');
const HtmlWebpackPlugin = require('html-webpack-plugin');

 module.exports = merge(common, {
    mode: 'development',
    plugins: [
        new HtmlWebpackPlugin({
            title: '2048',
            template: './src/index.html',
            minify: false,
            hash: true
        })
    ],
    devtool: 'inline-source-map',
    devServer: {
        contentBase: path.join(__dirname, 'dist'),
        host: 'localhost',
        port: 8080,
        proxy: {
            '/api': 'http://localhost:3000'
        }

    }
 })
複製程式碼

最終生產環境 webpack.prod.js 程式碼如下

const merge = require('webpack-merge');
const common = require('./webpack.common.js');
const UglifyJsPlugin = require("uglifyjs-webpack-plugin");
const OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin");
const HtmlWebpackPlugin = require('html-webpack-plugin');
const CleanWebpackPlugin = require('clean-webpack-plugin');

module.exports = merge(common, {
    mode: 'production',
    plugins: [
        new CleanWebpackPlugin(['dist']),
        new HtmlWebpackPlugin({
            title: '2048',
            template: './src/index.html',
            minify: true,
            hash: true
        }),
    ],
    optimization: {
        splitChunks: {
            chunks: 'all'
        },
        minimizer: [
            new UglifyJsPlugin({
                cache: true,
                parallel: true,
                sourceMap: true 
            }),
            new OptimizeCSSAssetsPlugin({})
        ],
    }
});
複製程式碼

npm 專案配置程式碼 package.json 程式碼如下

{
  "name": "2048",
  "version": "1.0.0",
  "description": "",
  "private": true,
  "main": "index.js",
  "scripts": {
    "dev": "webpack-dev-server --open --config webpack.dev.js",
    "build": "webpack --config webpack.prod.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "webpack": "^4.28.3"
  },
  "devDependencies": {
    "@babel/core": "^7.2.2",
    "@babel/preset-env": "^7.2.3",
    "autoprefixer": "^9.4.3",
    "babel-loader": "^8.0.4",
    "clean-webpack-plugin": "^1.0.0",
    "css-loader": "^2.1.0",
    "csv-loader": "^3.0.2",
    "extract-text-webpack-plugin": "^4.0.0-beta.0",
    "file-loader": "^3.0.1",
    "html-webpack-plugin": "^3.2.0",
    "mini-css-extract-plugin": "^0.5.0",
    "node-sass": "^4.11.0",
    "optimize-css-assets-webpack-plugin": "^5.0.1",
    "postcss": "^7.0.7",
    "postcss-loader": "^3.0.0",
    "sass-loader": "^7.1.0",
    "style-loader": "^0.23.1",
    "uglifyjs-webpack-plugin": "^2.1.1",
    "webpack-cli": "^3.1.2",
    "webpack-dev-server": "^3.1.14",
    "webpack-merge": "^4.1.5",
    "xml-loader": "^1.2.1"
  }
}

複製程式碼

相關文章