【JS】Webpack（学习笔记）

Webpack

1、Webpack概述

Webpack 是一个静态模块打包工具，从入口构建依赖图，打包有关的模块，最后用于展示你的内容

作用：把静态模块内容，压缩，这个和，转译等（前端工程化）

只有和入口有直接/间接引入关系的模块，才会被打包

1、下载 webpack webpack-cli 到项目（版本独立）

npm i webpack webpack-cli --save-dev

2、把 webpack 命令配置到 package.json 的 scripts 自定义命令，作为局部命令使用

"scripts": {
    "build" : "webpack"
}

3、项目中运行工具命令，采用自定义命令的方式（局部命令）

npm run build

2、修改打包入口和出口

1、项目根目录，新建 Webpack.config.js 配置文件

2、导出配置对象，配置入口，出口文件路径（别忘了修改磁盘文件夹和文件的名字）

const path = require('path')

module.exports = {
    entry: path.resolve(__dirname, 'src/index.js'),
    output: {
        path: path.resolve(__dirname, 'dist'),
        filename: './test/index.js'
    }
}

3、自动生成 html 文件

插件 html-webpack-plugin 作用：在 Webpack 打包时生成 html 文件，并引入其他打包后的资源

1、下载 html-webpack-plugin 本地软件包到项目中

npm i html-webpack-plugin --save-dev

2、配置 webpack.config.js 让 Webpack 拥有插件功能

const HtmlWebpackPlugin = require('html-webpack-plugin')

module.exports = {
  plugins: [
    new HtmlWebpackPlugin({
      template: './public/login.html', // 模板文件
      filename: './login/index.html' // 输出文件
    })
  ]
}

4、打包并提取 css 代码

css 文件可以被浏览器缓存，减少 JS 文件体积，让浏览器并行下载 css 和 js 文件

1、下载 mini-css-extract-plugin 插件软件包到本地项目中

npm i --save-dev mini-css-extract-plugin css-loader

2、配置 webpack.config.js 让 Webpack 拥有该插件功能

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

module.exports = {
  module: {
    rules: [
      {
        test: /\.css$/i,
        use: [MiniCssExtractPlugin.loader, "css-loader"],
      },
    ],
  },
  plugins: [
    new MiniCssExtractPlugin()
  ]
};

5、打包 less 代码

加载器 less-loader：把 less 代码编译为 css 代码，还需要依赖 less 软件包

1、新建 login/index.less 文件，设置背景图样式（图片在配套资料-素材文件夹中）

html {
    body {
        background: url('./assets/login-bg.png') no-repeat center/cover;
    }
}

2、less 样式引入到 src/login/index.js 中

import './index.less'

3、下载 less 和 less-loader 本地软件包

npm i less less-loader --save-dev

4、配置 webpack.config.js

module.exports = {
    module: {
        rules: [{
            test: /\.less$/i,
            use: [MiniCssExtractPlugin.loader, "css-loader", "less-loader"]
        }]
    }
}

6、打包图片

资源模块：Webpack5 内置了资源模块的打包，无需下载额外 loader

1、配置 webpack.config.js 让 Webpack 拥有打包图片功能

• 占位符 【hash】对模块内容做算法计算，得到映射的数字字母组合的字符串
• 占位符 【ext】使用当前模块原本的占位符，例如：.png / .jpg 等字符串
• 占位符 【query】保留引入文件时代码中查询参数（只有 URL 下生效）

2、判断临界值默认为 8KB

大于 8KB 文件：发送一个单独的文件并导出 URL 地址

小于 8KB 文件：导出一个 data URI（base64字符串）

3、在 src/login/index.js 中给 img 标签添加 logo 图片

import imgObj from './assets/logo.png'
const theImg = document.createElement('img')
theImg.src = imgObj
document.querySelector('.login-wrap').appendChild(theImg)

4、配置 webpack.config.js 让 Webpack 拥有打包图片功能

module.exports = {
    module: {
        rules: [
            {
                test: /\.(png|jpg|jpeg|gif)$/i,
                type: 'asset',
                generator: {
                    filename: 'assets/[hash][ext][query]'
                }
            }
        ]
    }
}

7、搭建开发环境

启动 Web 服务，打包输出源码在内存，并会自动检测代码变化热更新到网页

1、下载 webpack-dev-server 软件包到当前项目

npm i webpack-dev-server --save-dev

2、配置自定义命令，并设置打包的模式为开发模式

module.exports = {
    mode: 'development'
}

"scripts": {
  "dev": "webpack serve --mode=development"
},

3、启动开发服务器，访问提示的域名+端口号，在浏览器访问打包后的项目网页

npm run dev

热更新：在 js / css 文件中修改代码保存后，会实时反馈到浏览器

8、打包模式

打包模式：告知 Webpack 使用相应模式的内置优化

模式名称	模式名字	特点	场景
开发模式	development	调试代码，实时加载，模块热替换等	本地开发
生产模式	production	压缩代码，资源优化，更轻量等	打包上线

开发模式注重代码热替换更快，让开发调试代码更便捷，生产模式注重项目体积更小，更轻量，适配不同的浏览器环境

方式1：在 webpack.config.js 配置文件设置 mode 选项

module.exports = {
    mode: 'production'
}

方式2：在 package.json 命令行设置 mode 参数

"scripts": {
    "build": "webpack --mode=production",
    "dev": "webpack serve --mode=development"
},

命令行设置优先级高于配置文件

8、打包模式的应用

借助 cross-env （跨平台通用）包命令，设置参数区分环境

1、下载 cross-env 软件包到当前项目

npm i cross-env --save-dev

2、配置自定义命令，传入参数名和值（会绑定到 process.env 对象下）

3、在 webpack.config.js 区分不同环境使用不同配置

module: {
    rules: [
        {
            test: /\.css$/i,
            // use: ['style-loader', "css-loader"],
            use: [process.env.NODE_ENV === 'development' ? 'style-loader' : MiniCssExtractPlugin.loader, "css-loader"]
        },
        {
            test: /\.less$/i,
            use: [
                // compiles Less to CSS
                process.env.NODE_ENV === 'development' ? 'style-loader' : MiniCssExtractPlugin.loader,
                'css-loader',
                'less-loader',
            ],
        }
    ]
}

9、前端注入环境变量

前端项目中，开发模式下打印语句生效，生产模式下打印语句失效

问题：cross-env 设置的只在 Node.js 环境生效，前端代码无法访问 process.env.NODE_ENV

解决：使用 Webpack 内置的 DefinePlugin 插件

作用：在编译时，将前端代码中匹配的变量名，替换为值或表达式

配置 webpack.config.js 中给前端注入环境变量

const webpack = require('webpack')

module.exports = {
  plugins: [
    new webpack.DefinePlugin({
      // key 是注入到打包后的前端 JS 代码中作为全局变量
      // value 是变量对应的值（在 corss-env 注入在 node.js 中的环境变量字符串）
      'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV)
    })
  ]
}

10、开发环境调错 source map

source map：可以准确追踪 error 和 warning 在原始代码的位置

问题：代码被压缩和混淆，无法正确定位源代码位置（行数和列数）

设置：webpack.config.js 配置 devtool 选项

module.exports = {
    devtool: 'inline-source-map'
}

source map 适用于开发环境，不要在生产环境使用（防止被轻易查看源码位置）

11、设置解析别名路径

解析别名：配置模块如何解析，创建 import 或 require 的别名，来确保模块引入变得更简单

配置解析别名：在 webpack.config.js 中设置

const config = {
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src')
    }
  }
}

引入目标模块写的路径就更简单了

import { checkPhone, checkCode } from '@/utils/check.js'

12、CDN使用

开发模式使用本地第三方库，生产模式下使用 CDN 加载引入

CDN：内容分发网络，指的是一组分布在各个地区的服务器

作用：把静态资源文件/第三方库放在 CDN 网络中各个服务器中，供用户就近请求获取

好处：减轻自己服务器请求压力，就近请求物理延迟低，配套缓存策略

1、在 html 中引入第三方库的 CDN 地址 并用模板语法判断

<% if(htmlWebpackPlugin.options.useCdn){ %>
    <link href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/5.2.3/css/bootstrap.min.css" rel="stylesheet">
<% } %>

2、配置 webpack.config.js 中 externals 外部扩展选项（防止某些 import 的包被打包）

// 生产环境下使用相关配置
if (process.env.NODE_ENV === 'production') {
  // 外部扩展（让 webpack 防止 import 的包被打包进来）
  config.externals = {
    // key：import from 语句后面的字符串
    // value：留在原地的全局变量（最好和 cdn 在全局暴露的变量一致）
    'bootstrap/dist/css/bootstrap.min.css': 'bootstrap',
    'axios': 'axios'
  }
}

const config = {
  plugins: [
    new HtmlWebpackPlugin({
      // 自定义属性，在 html 模板中 <%=htmlWebpackPlugin.options.useCdn%> 访问使用
      useCdn: process.env.NODE_ENV === 'production'
    })
  ]
}

13、多页面打包

让 Webpack 同时打包登录和内容列表页面

• 单页面：单个 html 文件，切换 DOM 的方式实现不同业务逻辑展示，后续 Vue/React 会学到
• 多页面：多个 html 文件，切换页面实现不同业务逻辑展示

1. 准备源码（html，css，js）放入相应位置，并改用模块化语法导出

2. 下载 form-serialize 包并导入到核心代码中使用

3. 配置 webpack.config.js 多入口和多页面的设置

const config = {
  entry: {
    '模块名1': path.resolve(__dirname, 'src/入口1.js'),
    '模块名2': path.resolve(__dirname, 'src/入口2.js'),
  },
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: './[name]/index.js'  
  }
  plugins: [
    new HtmlWebpackPlugin({
      template: './public/页面2.html', // 模板文件
      filename: './路径/index.html', // 输出文件
      chunks: ['模块名2']
    })
    new HtmlWebpackPlugin({
      template: './public/页面2.html', // 模板文件
      filename: './路径/index.html', // 输出文件
      chunks: ['模块名2']
    })
  ]
}

14、分割公共代码

把 2 个以上页面引用的公共代码提取

配置 webpack.config.js 的 splitChunks 分割功能

const config = {
    optimization: {
        splitChunks: {
            chunks: 'all', // 所有模块动态非动态移入的都分割分析
            cacheGroups: { // 分隔组
                commons: { // 抽取公共模块
                    minSize: 0, // 抽取的chunk最小大小字节
                    minChunks: 2, // 最小引用数
                    reuseExistingChunk: true, // 当前 chunk 包含已从主 bundle 中拆分出的模块，则它将被重用
                    name(module, chunks, cacheGroupKey) { // 分离出模块文件名
                        const allChunksNames = chunks.map((item) => item.name).join('~') // 模块名1~模块名2
                        return `./js/${allChunksNames}` // 输出到 dist 目录下位置
                    }
                }
            }
        }
    }
}