Webpack5 基礎使用筆記

本文記錄了webpack5的基礎概念，以及部分常用的插件的使用方式。

[webpack中文文檔](概念 | webpack 中文文檔 | webpack中文文檔 | webpack中文網 (webpackjs.com))：

本質上，webpack 是一個用于現代 JavaScript 應用程序的 靜態模塊打包工具。當 webpack 處理應用程序時，它會在內部從一個或多個入口點構建一個依賴圖(dependency graph)，然后將你項目中所需的每一個模塊組合成一個或多個 bundles，它們均為靜態資源，用于展示你的內容。

這篇筆記主要記錄的是Webpack 5。

基本使用

安裝

安裝webpack的同時需要安裝webpack-cli。

npm i webpack webpack-cli -D

啟動

啟動分為開發模式和生產模式。

開發模式

npx webpack /path/to/main.js --mode=development

生產模式

npx webpack /path/to/main.js --mode=production

其中：

npx webpack：用于運行本地安裝的webpack；
/path/to/main.js：指定webpack從main.js開始打包，會同時打包其依賴文件；
--mode=xxx：指定模式。

注：

如果終端輸出webpack is not recognized as an internal or external command，即無法被識別為指令。

那么可以考慮將webpack進行全局安裝：

npm i -g webpack webpack-cli

輸出

webpack會默認將文件打包輸出到dist文件夾，并且只能處理js資源。

如果需要處理其它資源文件，或者需要更精細化地打包，則需要設置webpack的配置文件：webpack.config.js。

Webpack的配置

webpack的配置文件命名為webpack.config.js，置于項目文件的根路徑下。

webpack是基于node運行的，所以webpack.config.js采用CommonJS模塊化規范。

webpack的配置有五大核心概念：

entry（入口）：webpack從這個文件開始進行打包，并打包其依賴文件；
output（輸出）：決定了webpack打包后的文件的文件名、地址等；
loader（加載器）：webpack只能處理js文件，其它文件比如css文件、圖片資源、jsx文件，需要使用loader才能解析；
plugins（插件）：擴展webpack的功能，每一個插件如何配置取決于插件的提供者如何設計；
mode（模式）：主要有兩種模式，開發模式（development）和生產模式（production）。

簡單的配置文件樣例：

// Node.js的核心模塊，專門用來處理文件路徑
const path = require("path");

module.exports = {
  // 入口
  // 相對路徑和絕對路徑都行
  entry: "./src/main.js",
  // 輸出
  output: {
    // path: 文件輸出目錄，必須是絕對路徑
    // path.resolve()方法返回一個絕對路徑
    // __dirname 當前文件的文件夾絕對路徑
    path: path.resolve(__dirname, "dist"),
    // filename: 輸出文件名
    filename: "main.js",
  },
  // 加載器
  module: {
    rules: [],
  },
  // 插件
  plugins: [],
  // 模式
  mode: "development", // 開發模式
};

在上面基本使用那一欄里，由于沒有配置文件，運行webpack的時候通常會帶上后綴：npx webpack /path/to/main.js --mode=development，用于指定入口文件、模式等信息。

添加配置文件之后，webpack會自動讀取webpack.config.js這個文件里的配置信息，因此可以直接運行：npx webpack。

開發模式介紹

通常會創建兩個配置文件，一個對應開發模式，另一個對應生產模式。

開發模式的webpack主要需要完成以下任務：

編譯代碼，使瀏覽器能識別運行

webpack只能處理js文件，而其它文件，例如：css文件、字體圖標、圖片資源、html資源等，webpack需要通過配置loader才能處理這些資源；
代碼質量檢查

使用例如eslint之類的代碼檢查工具，提前發現代碼缺陷，也可以檢查代碼書寫是否規范，統一團隊編碼風格。

處理樣式資源

需要使用css-loader和style-loader才能處理css文件。

css-loader：負責將CSS文件編譯成webpack可以識別的模塊。
style-loader：會動態地創建一個style標簽，用于放置webpack 中的css模塊。

先安裝：

npm i css-loader style-loader -D

配置webpack：

const path = require("path");

module.exports = {
  entry: "./src/main.js",
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "main.js",
  },
  module: {
    rules: [
      {
        // 用來匹配 .css 結尾的文件
        test: /\.css$/,
        // use 數組里面 Loader 執行順序是從右到左
        use: ["style-loader", "css-loader"],
      },
    ],
  },
  plugins: [],
  mode: "development",
};

這里需要注意的是：use字段指定需要應用的loader，順序是從右到左的，即css文件先經由css-loader變成webpack可以識別的模塊，然后再由style-loader將這些模塊注入到html里。

這里提供案例的相關代碼：

/src/assets/css/style.css

#app{
    text-align: center;
    font-weight: bold;
}

/src/js/show.js

export function show(dom, msg){
	dom.innerText = msg;
}

/src/main.js

import {show} from './js/show'
import './assets/css/style.css'

const app = document.getElementById('app');
show(app, 'Hello Webpack');

/public/index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <title>webpack-learning</title>
</head>
<body>
    <div id="app"></div>
    <script src="../dist/main.js"></script>
</body>
</html>

同時，可以在package.json中設置常用的指令：

{
    ...
    "script":{
      	"start": "webpack --config webpack.config.js"  
    },
    ...
}

然后，只需要在終端運行：

npm run start

就會以webpack.config.js為配置，運行webpack，將main.js及其依賴文件，打包到/dist/main.js。

此時，打開/public/index.html，可以看到依賴的js文件show函數的功能正常，且引入的style.css樣式也被打包并注入到style標簽中：

常用的樣式資源還有Less，Sass等，這里再介紹Less樣式表的處理，其它樣式資源的處理方式是類似的。

首先安裝相應的loader：

npm i -D less-loader

配置webpack：在webpack.config.js文件原有的基礎上進行修改。

...
module.exports = {
    ...
    module: {
        rules: [
            ...
            {
                // 用來匹配 .less 結尾的文件
                test: /\.less$/,
                use: ['style-loader', 'css-loader', 'less-loader']
            }
        ]
    },
    ...
}

上述代碼中的...表示原有的，但是這里為了突出重點而省略的代碼片段。

配置less-loader只需要在rules數組中添加新的一項，注意use的順序是從右到左，先把less代碼轉換成css代碼，然后依此類推。

這里我只是在上述css的代碼中做了一些修改：

新增/src/assets/less/style.less文件

#app{
    text-align: center;
    font-weight: bold;
}

/src/main.js中不引入css文件，而是引入less文件

import {show} from './js/show'
import './assets/less/style.less'

const app = document.getElementById('app');
show(app, 'Hello Webpack');

執行npm run start
打開/pubcli/index.html，可以觀察到less也能被正確地處理并注入到最終的style標簽中。

這里再淺淺地提一嘴關于Sass/Scss的樣式資源處理配置，他們的loader都是使用sass-loader，因此，在配置test的時候，正則表達式可以使用：/\.s[ac]ss$/去同時匹配這兩種文件后綴。

處理圖片資源

過去的Webpack4 ，處理圖片資源需要使用file-loader和url-loader。

現在Webpack5已經將兩個Loader功能內置到Webpack里了，只需要簡單配置即可處理圖片資源。

webpack.config.js

...
module.exports = {
  ...
  module: {
    rules: [
      ...
      {
        test: /\.(png|jpe?g|gif|webp)$/,
        type: "asset",
      },
    ],
  },
  ...
};

相關代碼：

在代碼中引入圖片（記得需要出現在入口文件的依賴中，否則不會被webpack處理）

body{
    background-image: url('../images/normal.png');
}
#app{
    text-align: center;
    font-weight: bold;
    background-image: url('../images/small.png');
}

圖片可以隨便照幾張測試，這里我習慣性地將圖片放在/src/assets/images目錄下。

運行webpack之后，可以發現圖片也被輸出了。

上面樣式資源打包后沒有相應的樣式資源出現是因為：經過style-loader的處理，樣式資源被打包進了/dist/main.js。

對圖片資源進行優化：將小于某個大小的圖片轉換成Base64格式。

...
module.exports = {
  ...
  module: {
    rules: [
      ...
      {
        test: /\.(png|jpe?g|gif|webp)$/,
        type: "asset",
        parser: {
            dataUrlCondition: {
                maxSize: 10 * 1024 // 小于10kb的圖片會被base64處理
            }
        }
      },
    ],
  },
  ...
};

這里我用于測試的兩張圖片：normal.png和small.png，其中normal.png大于10kb，而small.png小于10kb。

再次打包并運行：

可以看到小于10kb的圖片文件被轉換成Base64格式。

優點：減少請求數量
缺點：main.js體積變得更大

修改輸出資源的名稱和路徑

module.exports = {
  ...
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "static/js/main.js", // 將 js 文件輸出到 static/js 目錄中
  },
  module: {
    rules: [
      ...
      {
        test: /\.(png|jpe?g|gif|webp)$/,
        type: "asset",
        parser: {
          dataUrlCondition: {
            maxSize: 10 * 1024, // 小于10kb的圖片會被base64處理
          },
        },
        generator: {
          // 將圖片文件輸出到 static/imgs 目錄中
          // 將圖片文件命名 [hash:8][ext][query]
          // [hash:8]: hash值取8位
          // [ext]: 使用之前的文件擴展名
          // [query]: 添加之前的query參數
          filename: "static/imgs/[hash:8][ext][query]",
        },
      },
    ],
  },
  ...
};

上述配置在原來的基礎上，修改了：

修改了main.js的輸出路徑之后，需要修改/public/index.html中的<script>標簽的路徑。

<script src="../dist/static/js/main.js"></script>

自動清空上次打包的資源

如果想要每次打包自動覆蓋上一次打包生成的資源，使用clean: true

module.exports = {
  entry: "./src/main.js",
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "static/js/main.js",
    clean: true, // 自動將上次打包目錄資源清空
  },
  module: {
    rules: [
      ...
    ],
  },
  ...
};

處理字體圖標資源

字體圖標可以到阿里巴巴矢量圖標庫下載。

下載到本地后解壓并添加到項目中的文件夾，這里只需要以下文件：

src/fonts/iconfont.ttf
src/fonts/iconfont.woff
src/fonts/iconfont.woff2
src/css/iconfont.css

將文件分開放置需要修改iconfont.css中對于字體文件的引用路徑：

@font-face {
  font-family: "iconfont"; /* Project id 4000108 */
  src: url('../fonts/iconfont.woff2?t=1695445577878') format('woff2'),
       url('../fonts/iconfont.woff?t=1695445577878') format('woff'),
       url('../fonts/iconfont.ttf?t=1695445577878') format('truetype');
}

然后在/public/index.html中使用字體圖標：

<div id="app"></div>
<i class="iconfont icon-wode3"></i>
<i class="iconfont icon-search"></i>
<i class="iconfont icon-rollback"></i>
<script src="../dist/static/js/main.js"></script>

配置webpack：

...
module.exports = {
  ...
  module: {
    rules: [
      ...
      {
        test: /\.(ttf|woff2?)$/,
        type: "asset/resource",
        generator: {
          filename: "static/media/[hash:8][ext][query]",
        },
      },
    ],
  },
  ...
};

type: "asset/resource"和type: "asset"的區別：

type: "asset/resource" 相當于file-loader, 將文件轉化成 Webpack 能識別的資源，其他不做處理；
type: "asset" 相當于url-loader, 將文件轉化成 Webpack 能識別的資源，同時小于某個大小的資源會處理成 data URI 形式。

處理音頻視頻資源

音頻和視頻資源和字體圖標做同樣的處理，使用type: "asset/resource"。

...
module.exports = {
  ...
  module: {
    rules: [
      ...
      {
        test: /\.(ttf|woff2?|map4|map3|avi)$/,
        type: "asset/resource",
        generator: {
          filename: "static/media/[hash:8][ext][query]",
        },
      },
    ],
  },
  ...
};

處理JS資源

webpack只能編譯JS中的ES模塊化語法，其它更高級的功能需要配置才能使用。

常用的工具有Babel和Eslint：

Babel用于將高版本的JS語法轉換成ES5語法，是針對兼容性的；
Eslint用于檢查代碼格式。

Eslint

Eslint可以用來檢測JS和jsx語法。

使用Eslint需要寫配置文件，標注各種rules，用于聲明哪些代碼規則需要檢查。

在安裝Eslint之前，先了解一下配置的寫法：

新建配置文件.eslintrc.*：位于項目根目錄
- .eslintrc
- .eslintrc.js
- .eslintrc.json
- 上面三種文件命名的區別在于文件類型不同，配置的格式不一樣。
直接在package.json中的eslintConfig進行配置。

基本配置

module.exports = {
  // 解析選項
  parserOptions: {},
  // 具體檢查規則
  rules: {},
  // 繼承其他規則
  extends: [],
};

parserOptions：解析選項

parserOptions: {
  ecmaVersion: 6, // ES 語法版本
  sourceType: "module", // ES 模塊化
  ecmaFeatures: { // ES 其他特性
    jsx: true // 如果是 React 項目，就需要開啟 jsx 語法
  }
}

rules具體規則

off或0：關閉
warn或1：警告
error或2：報錯

rules: {
  semi: "error", // 禁止使用分號
  'array-callback-return': 'warn', // 強制數組方法的回調函數中有 return 語句，否則警告
  'default-case': [
    'warn', // 要求 switch 語句中有 default 分支，否則警告
    { commentPattern: '^no default$' } // 允許在最后注釋 no default, 就不會有警告了
  ],
  eqeqeq: [
    'warn', // 強制使用 === 和 !==，否則警告
    'smart' // https://eslint.bootcss.com/docs/rules/eqeqeq#smart 除了少數情況下不會有警告
  ],
}

extends繼承

直接引入已有的規則，常見的規則：
- Eslint官方的規則：eslint:recommended
- Vue-cli官方的規則：plugin:vue/essential
- React-cli官方的規則：react-app
如果本地的rules和繼承的規則出現相同的選項，則本地的規則覆蓋繼承的規則。

安裝Eslint

npm i -D eslint-webpack-plugin eslint

定義配置文件：.eslintrc.js

module.exports = {
  // 繼承 Eslint 規則
  extends: ["eslint:recommended"],
  env: {
    node: true, // 啟用node中全局變量
    browser: true, // 啟用瀏覽器中全局變量
  },
  parserOptions: {
    ecmaVersion: 6,
    sourceType: "module",
  },
  rules: {
    "no-var": 2, // 不能使用 var 定義變量
  },
};

配置webpack

...
const ESLintWebpackPlugin = require("eslint-webpack-plugin");

module.exports = {
  ...
  plugins: [
    new ESLintWebpackPlugin({
      // 指定檢查文件的根目錄
      context: path.resolve(__dirname, "src"),
    }),
  ],
  ...
};

Babel

Babel的配置文件可以是下面的文件名之一：

babel.config.js
babel.config.json
.babelrc
.babelrc.js
.babelrc.json

或者可以直接在package.json里的babel項進行配置。

以babel.config.js為例，基礎配置為：

module.exports = {
  // 預設
  presets: [],
};

預設可以理解為是Babel插件，擴展Babel的功能。

@babel/preset-env: 一個智能預設，允許您使用最新的 JavaScript；
@babel/preset-react：一個用來編譯 React jsx 語法的預設；
@babel/preset-typescript：一個用來編譯 TypeScript 語法的預設。

安裝

npm i babel-loader @babel/core @babel/preset-env -D

定義配置文件：babel.config.js

module.exports = {
  presets: ["@babel/preset-env"],
};

webpack配置

...
module.exports = {
  ...
  module: {
    rules: [
      ...
      {
        test: /\.js$/,
        exclude: /node_modules/, // 排除node_modules代碼不編譯
        loader: "babel-loader",
      },
    ],
  },
  ...
};

處理Html資源

之前沒有處理html文件，所做的只是處理JS文件和其它資源，然后手動打開public/index.html。（/public/index.html需要手動引入打包后的dist/static/js/main.js文件）

安裝

npm i html-webpack-plugin -D

配置

...
const HtmlWebpackPlugin = require("html-webpack-plugin");

module.exports = {
  ...
  plugins: [
    ...
    new HtmlWebpackPlugin({
      // 以 public/index.html 為模板創建文件
      // 新的html文件有兩個特點：1. 內容和源文件一致 2. 自動引入打包生成的js等資源
      template: path.resolve(__dirname, "public/index.html"),
    }),
  ],
  ...
};

修改/public/index.html

我們的目標是使用html-webpack-plugin完成html文件的打包，現在/public/index.html不需要手動引入dist/static/js/main.js文件了，插件會自動完成這個任務，并把html文件也一并打包到/dist文件夾中。

打包并檢查結果

npm run start

可以看到index.html也被打包了：

以下打包之后的/dist/index.html，可以看到被自動添加了<script>標簽：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>webpack-learning</title>
<script defer src="static/js/main.js"></script></head>
<body>
    <div id="app"></div>
    <i class="iconfont icon-wode3"></i>
    <i class="iconfont icon-search"></i>
    <i class="iconfont icon-rollback"></i>
</body>
</html>

開發服務器與自動化

使用自動化代替原先的手動輸入打包指令的操作。

安裝依賴

npm i webpack-dev-server -D

配置：(webpack.config.js文件)

...
module.exports = {
  ...
  // 開發服務器
  devServer: {
    host: "localhost", // 啟動服務器域名
    port: "3000", // 啟動服務器端口號
    open: true, // 是否自動打開瀏覽器
  },
  ...
};

修改package.json腳本

"scripts": {
    "start": "webpack --config webpack.config.js",
    "dev": "webpack serve --config webpack.config.js"
},

新加一個dev指令，用于啟動本地服務。

運行指令

npm run dev

啟動服務之后，會自動打開瀏覽器（可能會被電腦的安全軟件攔截，點擊允許就行）。

默認啟動熱加載功能，此時修改源代碼，會自動更新。

注：使用開發服務器的時候，代碼不會被打包到/dist文件夾，而是編譯打包在內存中。

生產模式介紹

開發完成代碼之后，需要將代碼打包給后端用于部署。

打包的配置需要考慮優化問題，主要從兩個方面考慮：

優化代碼運行性能
優化代碼打包速度

注：

通常會使用兩個配置文件來對應開發模式和生產模式，方便隨時切換。

在項目根目錄下創建文件夾：config。

然后新建兩個配置文件：

開發模式配置文件：/config/webpack.dev.js
生產模式配置文件：/config/webpack.prod.js

在上文已經寫好的webpack.config.js文件的基礎上，稍作修改，拆分出兩個模式的配置文件。

配置文件遷移的時候，由于目錄變更，配置文件中的路徑字符串需要做出相應的修改。同時，mode字段需要區分development或production。

開發模式需要注意：

沒有輸出，不需要指定輸出路徑，也不需要清空輸出結果。
需要啟動開發服務器。

生產模式需要注意：

需要指定輸出路徑。
關閉開發服務器。

更新package.json里的腳本

"scripts": {
    "start": "npm run dev",
    "dev": "webpack serve --config ./config/webpack.dev.js",
    "build": "webpack --config ./config/webpack.prod.js"
},

啟動開發模式使用：npm run start或npm run dev
啟動生產模式使用：npm run build

CSS處理

將css打包成單獨文件

上文中的CSS處理是使用style-loader，這樣做的結果是：樣式會被打包到js文件中，最終再由js生成style標簽。

這樣做可能會導致白屏現象，因為目前流行的前端框架vue和react主要做的都是單頁面應用，需要加載一個很大的js文件來渲染頁面，如果樣式也由js文件來負責的話，在js解析加載完成之前，頁面內容一片空白。這樣的頁面用戶體驗不好。

因此，更好的解決方案是將CSS打包成單獨的.css文件，然后使用<link>引入。

安裝相關的插件

npm i -D mini-css-extract-plugin

配置webpack.build.js

...
// 引入插件
const MiniCssExtractPlugin = require("mini-css-extract-plugin");

module.exports = {
  ...
  module: {
    // css相關的rules，將style-loader替換成新插件的loader
    rules: [
      {
          // 用來匹配 .css 結尾的文件
          test: /\.css$/,
          use: [MiniCssExtractPlugin.loader, 'css-loader']
      },
        {
            // 用來匹配 .less 結尾的文件
            test: /\.less$/,
            use: [MiniCssExtractPlugin.loader, 'css-loader', 'less-loader']
        },
      ...
    ],
  },
  plugins: [
    ...
    // 提取css成單獨文件
    new MiniCssExtractPlugin({
      // 定義輸出文件名和目錄
      filename: "static/css/main.css",
    }),
  ],
  mode: "production",
};

主要步驟：

引入插件；
修改rules中的loader；
新增plugins，并指定輸出的文件名。

運行打包指令

npm run build

效果：

輸出了/dist/static/css/main.css文件：
輸出的/dist/index.html中出現了<link>標簽，并引入了打包后的css文件。

css兼容性處理

css兼容性處理可以使用postcss，擁有許多插件，可以按需配置，可以與解決JS兼容性問題的Babel進行類比。

安裝

需要安裝：

postcss：postcss本身
postcss-loader：為了webpack接入的loader
postcss-preset-env：postcss官方提供的預設配置

npm i -D postcss postcss-loader postcss-preset-env

配置webpack.prod.js

只需要在css-loader之前新增一個postcss-loader就可以：

rules: [
    {
        // 用來匹配 .css 結尾的文件
        test: /\.css$/,
        use: [
            MiniCssExtractPlugin.loader, 
            'css-loader',
            // 在css-loader之前使用postcss-loader
            {
                loader: 'postcss-loader',
                options: {
                    postcssOptions: {
                        plugins: ['postcss-preset-env']
                    }
                }
            }
        ]
    },
    {
        // 用來匹配 .less 結尾的文件
        test: /\.less$/,
        use: [
            MiniCssExtractPlugin.loader,
            'css-loader', 
            {
                loader: 'postcss-loader',
                options: {
                    postcssOptions: {
                        plugins: ['postcss-preset-env']
                    }
                }
            },
            'less-loader',
        ]
    },
]

對于其它css擴展語法，例如less，可以先使用less-loader轉成css，然后使用postcss-loader處理其兼容性，最后才是使用css-loader處理成webpack可以處理的模塊，以及打包用的MiniCssExtractPlugin.loader。

兼容性控制

package.json文件中可以寫入browserslist這個屬性，指定兼容性的考慮程度。

這個屬性是共用的，與兼容性問題相關的許多插件都會自動讀取這個屬性。

常用案例：

{
    "browserslist": ["last 2 version", "> 1%", "not dead"]
}

css壓縮

減少打包后的體積。

安裝

npm i -D css-minimizer-webpack-plugin

配置

...
const CssMinimizerPlugin = require("css-minimizer-webpack-plugin");

module.exports = {
    ...
    plugins: [
        ...
        // css壓縮
        new CssMinimizerPlugin()
    ],
    mode: 'production'
}

html和js壓縮

生產環境下，html和js是默認壓縮的，即打包后的代碼都是單行的。

總結

5個核心概念：

entry（入口）：webpack從這個文件開始進行打包，并打包其依賴文件；
output（輸出）：決定了webpack打包后的文件的文件名、地址等；
loader（加載器）：webpack只能處理js文件，其它文件比如css文件、圖片資源、jsx文件，需要使用loader才能解析；
plugins（插件）：擴展webpack的功能，每一個插件如何配置取決于插件的提供者如何設計；
mode（模式）：主要有兩種模式，開發模式（development）和生產模式（production）。

2種模式

使用兩個獨立的配置文件。

開發模式：需要代碼編譯、語法檢查、熱加載。
生產模式：需要考慮性能與兼容性。

參考資料

尚硅谷 Web 前端之 Webpack5 教程

posted @ 2023-10-01 20:57 feixianxing 閱讀(314) 評論(1) 收藏舉報

刷新頁面返回頂部

feixianxing