webpack基础

前端工程化
webpack基本使用
webpack的插件
devServer节点
webpack中的loader
打包发布
Source Map
webpack.config.js解析

参考

参考：npm.js
参考：webpack 中文文档

日志

2022年02月14日23:05:39 初始版本

前端工程化

初级前端开发

会写HTML+CSS+JS。
需要美化页面样式，拽一个bootstrap。
需要操作DOPM或发起Ajax请求，拽一个jQuery。
需要快速实现网页布局效果，拽一个Layui。

实际前端开发

模块化：JS的模块化/CSS的模块化/资源的模块化。
组件化：服用现有的UI结构/样式/行为。
规范化：目录结构的划分/编码规范化/接口规范化/文档规范化/Git分支管理。
自动化：自动化构建/自动化部署/自动化测试。

前端工程化的解决方案

早期的前端工程化解决方案：

grunt（https://www.gruntjs.net/）
gulp（https://www.gulpjs.com.cn/）

目前主流的前端工程化解决方案：

webpack（https://www.webpackjs.com/）
parcel（https://zh.parceljs.org/）

webpack基本使用

概念：webpack 是前端项目工程化的具体解决方案。

主要功能：它提供了友好的前端模块化开发支持，以及代码压缩混淆、处理浏览器端 JavaScript 的兼容性、性能优化等强大的功能。

好处：让程序员把工作的重心放到具体功能的实现上，提高了前端开发效率和项目的可维护性。

注意：目前 Vue，React 等前端项目，基本上都是基于 webpack 进行工程化开发的。

创建项目

参考： npm install命令详解 - 掘金

新建项目空白目录，并运行 npm init –y 命令，初始化包管理配置文件 package.json。
新建 src 源代码目录。
新建 src > index.html 首页和 src > index.js 脚本文件。
初始化首页基本的结构。
运行 npm install jquery –S 命令，安装 jQuery。

在项目中安装webpack。

npm install webpack@5.42.1 webpack-cli@4.7.2 -D

在项目中配置webpack。
1. 在项目根目录中，创建名为 webpack.config.js 的 webpack 配置文件，并初始化如下的基本配置。webpack.config.js 是 webpack 的配置文件。webpack 在真正开始打包构建之前，会先读取这个配置文件，从而基于给定的配置，对项目进行打包。
```
module.exports = {
	// mode用来指定构建模式
	//  development: 开发环境，不会对打包生成的文件进行代码压缩和性能优化，打包速度快，适合在开发阶段使用
	//  production: 生产环境，会对打包生成的文件进行代码压缩和性能优化，打包速度很慢，仅适合在项目发布阶段使用
	mdoe: "development",
};
```
  注意：由于 webpack 是基于 node.js 开发出来的打包工具，因此在它的配置文件中，支持使用 node.js 相关的语法和模块进行 webpack 的个性化配置。
2. 在 package.json 的 scripts 节点下，新增 dev 脚本如下。
```
module.exports = {
  script: {
    "dev": "webpack" // script节点下的脚本，可以通过npm run执行，例如npm run dev
  },
};
```
3. 在终端中运行npm run dev命令，启动webpack进行项目的打包构建。
  在运行webpack之前，会先读取webpack.config.js配置文件，根据配置运行webpack。
  会在内存中生成一个bundle.js文件，其中包含了所需要的依赖项。

备注：

-S，等价于–save安装包信息将加到dependencies（生产阶段的依赖）。

-D，等价于–save-dev安装包信息将加到devDependencies（开发阶段的依赖），所以开发阶段一般使用它。

npm install xx和npm install xx -S和npm install xx -D的差异。参考npm install、npm install --save与npm install --save-dev区别。

webpack 中的默认约定

在 webpack 4.x 和 5.x 的版本中，有如下的默认约定：

默认的打包入口文件为 src > index.js。
默认的输出文件路径为 dist > main.js。

注意：可以在 webpack.config.js 中修改打包的默认约定。

自定义打包的入口与出口

在 webpack.config.js 配置文件中，通过 entry 节点指定打包的入口。通过 output 节点指定打包的出口。

示例代码如下：

const path = require("path"); // 导入node.js中专门操作路径的模块

module.exports = {
  entry: path.join(__dirname, "./src/main.js"), // 打包入口文件的路径
  output: {
    path: path.join(__dirname, "./dist"), // 输出文件的存放路径
    filename: "bundle.js", // 输出文件的名称
  },
};

webpack的插件

webpack插件的作用

通过安装和配置第三方的插件，可以拓展webpack 的能力，从而让webpack用起来更方便。最常用的

webpack插件有如下两个：

webpack-dev-server
- 类似于node.js 阶段用到的nodemon工具。
- 每当修改了源代码，webpack 会自动进行项目的打包和构建。
html-webpack-plugin
- webpack 中的HTML 插件（类似于一个模板引擎插件）。
- 可以通过此插件自定制index.html 页面的内容。

webpack-dev-server插件

webpack-dev-server插件介绍

webpack-dev-server可以让webpack 监听项目源代码的变化，从而进行自动打包构建。

运行如下的命令，即可在项目中安装此插件。
```
npm install webpack-dev-server@3.11.2 -D
```
配置webpack-dev-server。
1. 修改package.json -> scripts中的dev命令如下。
```
"script": {
  "dev": "webpack servce" // script节点下的脚本，可以通过npm run执行
}
```
2. 再次运行npm run dev命令，重新进行项目的打包。
3. 在浏览器中访问http://localhost:8080 地址，查看自动打包效果。

注意：webpack-dev-server会启动一个实时打包的http服务器。

webpack-dev-server插件工作原理

打包生成的文件哪儿去了？

不配置webpack-dev-server的情况下，webpack 打包生成的文件，会存放到实际的物理磁盘上。
- 严格遵守开发者在webpack.config.js 中指定配置。
根据output节点指定路径进行存放。
配置了webpack-dev-server 之后，打包生成的文件存放到了内存中。
- 不再根据output节点指定的路径，存放到实际的物理磁盘上。
- 提高了实时打包输出的性能，因为内存比物理磁盘速度快很多。

生成到内存中的文件该如何访问？

webpack-dev-server生成到内存中的文件，默认放到了项目的根目录中，而且是虚拟的、不可见的。

可以直接用/ 表示项目根目录，后面跟上要访问的文件名称，即可访问内存中的文件
例如/bundle.js 就表示要访问webpack-dev-server 生成到内存中的bundle.js 文件

html-webpack-plugin插件

html-webpack-plugin插件介绍

html-webpack-plugin 是 webpack 中的 HTML 插件，可以通过此插件自定制 index.html 页面的内容。需求：通过 html-webpack-plugin 插件，将 src 目录下的 index.html 首页，复制到项目根目录中一份！

运行如下的命令，即可在项目中安装此插件：
```
npm install html-webpack-plugin@5.3.2 -D
```
配置 html-webpack-plugin，修改文件webpack.config.js。

// 1. 导入 html-webpack-plugin 这个插件，得到插件的构造函数
const HtmlPlugin = require('html-webpack-plugin')
// 2. new 构造函数，创建插件的实例对象
const htmlPlugin = new HtmlPlugin({
  // 指定要复制哪个页面
  template: './src/index.html',
  // 指定复制出来的文件名和存放路径
  filename: './index.html'
})

module.exports = {
  mode: 'development',
  plugins: [htmlPlugin], // 3. 通过plugin节点，使htmlPlugin生效
}

解惑 html-webpack-plugin

通过 HTML 插件复制到项目根目录中的 index.html 页面，也被放到了内存中
HTML 插件在生成的 index.html 页面，自动注入了打包的 bundle.js 文件

devServer节点

在 webpack.config.js 配置文件中，可以通过 devServer 节点对 webpack-dev-server 插件进行更多的配置，示例代码如下：

devServer: {
    // 首次打包成功后，自动打开浏览器
    open: true,
    // 在 http 协议中，如果端口号是 80，则可以被省略
    port: 80,
    // 指定运行的主机地址
    host: '127.0.0.1'
},

注意：凡是修改了 webpack.config.js 配置文件，或修改了 package.json 配置文件，必须重启实时打包的服务器，否则最新的配置文件无法生效！

webpack中的loader

loader 概述

在实际开发过程中，webpack 默认只能打包处理以 .js 后缀名结尾的模块。

其他非 .js 后缀名结尾的模块， webpack 默认处理不了，需要调用 loader 加载器才可以正常打包，否则会报错！

loader 加载器的作用：协助 webpack 打包处理特定的文件模块。比如：

css-loader 可以打包处理 .css 相关的文件
less-loader 可以打包处理 .less 相关的文件
babel-loader 可以打包处理 webpack 无法处理的高级 JS 语法

loader 的调用过程

参考：webpack中loader调用过程_m0_61631823的博客-CSDN博客

打包处理CSS文件

运行 npm i style-loader@3.0.0 css-loader@5.2.6 -D 命令，安装处理 css 文件的 loader

在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

module: { // 所有第三方文件模块的匹配规则
    rules: [ // 文件后缀名的匹配规则
        { test: /\.css$/, use: ['style-loader', 'css-loader'] } // 从后往前调用
    ]
}

其中，test 表示匹配的文件类型， use 表示对应要调用的 loader

注意：

use 数组中指定的 loader 顺序是固定的

多个 loader 的调用顺序是：从后往前调用

打包处理 less 文件

运行 npm i less-loader@10.0.1 less@4.1.1 -D 命令

在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

module: { // 所有第三方文件模块的匹配规则
    rules: [ // 文件后缀名的匹配规则
        { test: /\.css$/, use: ['style-loader', 'css-loader', 'less-loader'] } // 从后往前调用
    ]
}

备注：

如需要打包处理CSS文件和less文件。在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

module: { // 所有第三方文件模块的匹配规则
    rules: [ // 文件后缀名的匹配规则
        // 定义了不同模块对应的loader
        { test: /\.css$/, use: ['style-loader', 'css-loader'] }
        // 处理 .less 文件的loader
        { test: /\.css$/, use: ['style-loader', 'css-loader', 'less-loader'] }
    ]
}

打包处理样式表中与 url 路径相关的文件

运行 npm i url-loader@4.1.1 file-loader@6.2.0 -D 命令

在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

module: { // 所有第三方文件模块的匹配规则
    rules: [ // 文件后缀名的匹配规则
        // 处理图片文件的loader
        // 如果需要调用的loader只有一个，则只传递一个字符串也行；如果有多个loader，则必须指定数组
        { test: /\.jpg|png|gif$/, use: 'url-loader?limit=22229' }
    ]
}

其中 ? 之后的是 loader 的参数项：

limit 用来指定图片的大小，单位是字节（byte）
只有 ≤ limit 大小的图片，才会被转为 base64 格式的图片

打包处理 js 文件中的高级语法

webpack 只能打包处理一部分高级的 JavaScript 语法。对于那些 webpack 无法处理的高级 js 语法，需要借助于 babel-loader 进行打包处理。例如 webpack 无法处理下面的 JavaScript 代码：（例如React中的装饰器）。

// 定义装饰器函数
function info(target) {
  target.info = 'Person info.'
}

// 定义一个普通的类
@info
class Person {}

console.log(Person.info)

安装 babel-loader 相关的包

运行如下的命令安装对应的依赖包：

npm i babel-loader@8.2.2 @babel/core@7.14.6 @babel/plugin-proposal-decorators@7.14.5 -D

在 webpack.config.js 的 module -> rules 数组中，添加 loader 规则如下：

module: { // 所有第三方文件模块的匹配规则
    rules: [ // 文件后缀名的匹配规则
      // 使用 babel-loader 处理高级的 JS 语法
      // 在配置 babel-loader 的时候，程序员只需要把自己的代码进行转换即可；一定要排除 node_modules 目录中的 JS 文件
      // 因为第三方包中的 JS 兼容性，不需要程序员关心
      { test: /\.js$/, use: 'babel-loader', exclude: /node_modules/ }
    ]
}

配置 babel-loader

在项目根目录下，创建名为 babel.config.js 的配置文件，定义 Babel 的配置项如下：

module.exports = {
  // 声明 babel 可用的插件
  // 将来，webpack 在调用 babel-loader 的时候，会先加载 plugins 插件来使用
  plugins: [['@babel/plugin-proposal-decorators', { legacy: true }]]
}

备注：详情请参考 Babel 的官网 https://babeljs.io/docs/en/babel-plugin-proposal-decorators。

打包发布

为什么要打包发布

项目开发完成之后，需要使用 webpack 对项目进行打包发布，主要原因有以下两点：

开发环境下，打包生成的文件存放于内存中，无法获取到最终打包生成的文件。
开发环境下，打包生成的文件不会进行代码压缩和性能优化为了让项目能够在生产环境中高性能的运行，因此需要对项目进行打包发布。

配置 webpack 的打包发布

在 package.json 文件的 scripts 节点下，新增 build 命令如下：

"scripts": {
    "dev": "webpack serve", // 开发环境，运行 dev 命令。运行在内存中
    "build": "webpack --mode production" // 项目发布时候，运行build命令。运行在物理实盘中
},

--model 是一个参数项，用来指定 webpack 的运行模式，优先级高，高于配置文件中的mode参数内容。production 代表生产环境，会对打包生成的文件进行代码压缩和性能优化。

注意：通过 --model 指定的参数项，会覆盖 webpack.config.js 中的 model 选项。

把 JavaScript 文件统一生成到 js 目录中

在 webpack.config.js 配置文件的 output 节点中，进行如下的配置：

// 指定生成的文件要存放到哪里
output: {
    // 存放的目录
    path: path.join(__dirname, 'dist'),
	// 生成的文件名，明确告诉webpack把生成的bundle.js文件存放到dist目录下的JS子目录中
    filename: 'js/bundle.js'
},

把图片文件统一生成到 image 目录中

修改 webpack.config.js 中的 url-loader 配置项，新增 outputPath 选项即可指定图片文件的输出路径：

{
    test: /\.jpg|png|gif$/,
    use: {
        loader: 'url-loader',
        options: {
            limit: 22228,
            // 明确指定把打包生成的图片，存储到dist目录下的image文件夹中
            outputpath: 'image',
        }
    }
}

自动清理 dist 目录下的旧文件

为了在每次打包发布时自动清理掉 dist 目录中的旧文件，可以安装并配置 clean-webpack-plugin 插件：

安装清理dist目录的webpack插件
```
npm i clean-webpack-plugin@3.0.0 -D 
```

按需导入插件、得到插件的构造函数之后，创建插件的实例对象

// 注意：左侧的 { } 是解构赋值
const { CleanWebpackPlugin } = require('clean-webpack-plugin')
const cleanPlugin = new CleanWebpackPlugin()

把创建的cleanPlugin插件实例对象，挂在到plugins节点中
```
plugins: [htmlPlugin, cleanPlugin],
```

Source Map

前端项目在投入生产环境之前，都需要对 JavaScript 源代码进行压缩混淆，从而减小文件的体积，提高文件的加载效率。此时就不可避免的产生了另一个问题：对压缩混淆之后的代码除错（debug）是一件极其困难的事情

变量被替换成没有任何语义的名称
空行和注释被剔除

什么是 Source Map

Source Map 就是一个信息文件，里面储存着位置信息。也就是说，Source Map 文件中存储着压缩混淆后的代码，所对应的转换前的位置。有了它，出错的时候，除错工具将直接显示原始代码，而不是转换后的代码，能够极大的方便后期的调试。

webpack 开发环境下的 Source Map

在开发环境下，webpack 默认启用了 Source Map 功能。当程序运行出错时，可以直接在控制台提示错误行的位置，并定位到具体的源代码。

默认 Source Map 的问题

开发环境下默认生成的 Source Map，记录的是生成后的代码的位置。会导致运行时报错的行数与源代码的行数不一致的问题。

解决默认 Source Map 的问题

开发环境下，推荐在 webpack.config.js 中添加如下的配置，即可保证运行时报错的行数与源代码的行数保持一致。

module.exports = {
  // 在开发调试阶段，建议大家都把 devtool 的值设置为 eval-source-map
  devtool: 'eval-source-map',
  // mode 代表 webpack 运行的模式，可选值有两个 development 和 production
  // 结论：开发时候一定要用 development，因为追求的是打包的速度，而不是体积；
  // 反过来，发布上线的时候一定能要用 production，因为上线追求的是体积小，而不是打包速度快！
  mode: 'development',
}

webpack 生产环境下的 Source Map

在生产环境下，如果省略了 devtool 选项，则最终生成的文件中不包含 Source Map。这能够防止原始代码通过 Source Map 的形式暴露给别有所图之人。

只定位行数不暴露源码

在生产环境下，如果只想定位报错的具体行数，且不想暴露源码。此时可以将 devtool 的值设置为 nosources-source-map。实际效果如图所示

module.exports = {
  // 在开发调试阶段，建议大家都把 devtool 的值设置为 eval-source-map
  // devtool: 'eval-source-map',
  // 在实际发布的时候，建议大家把 devtool 的值设置为 nosources-source-map 或直接关闭 SourceMap
  devtool: 'nosources-source-map',
  // mode 代表 webpack 运行的模式，可选值有两个 development 和 production
  // 结论：开发时候一定要用 development，因为追求的是打包的速度，而不是体积；
  // 反过来，发布上线的时候一定能要用 production，因为上线追求的是体积小，而不是打包速度快！
  mode: 'development',
}

定位行数且暴露源码

在生产环境下，如果想在定位报错行数的同时，展示具体报错的源码。此时可以将 devtool 的值设置为 source-map。

采用此选项后：你应该将你的服务器配置为，不允许普通用户访问 source map 文件！

Source Map 的最佳实践

开发环境下

建议把 devtool 的值设置为 eval-source-map
好处：可以精准定位到具体的错误行

生产环境下

建议关闭 Source Map 或将 devtool 的值设置为 nosources-source-map
好处：防止源码泄露，提高网站的安全性

webpack.config.js解析

const path = require('path')

// 1. 导入 html-webpack-plugin 这个插件，得到插件的构造函数
const HtmlPlugin = require('html-webpack-plugin')
// 2. new 构造函数，创建插件的实例对象
const htmlPlugin = new HtmlPlugin({
  // 指定要复制哪个页面
  template: './src/index.html',
  // 指定复制出来的文件名和存放路径
  filename: './index.html'
})

// 注意：左侧的 { } 是解构赋值
const { CleanWebpackPlugin } = require('clean-webpack-plugin')

// 使用 Node.js 中的导出语法，向外导出一个 webpack 的配置对象
module.exports = {
  // 在开发调试阶段，建议大家都把 devtool 的值设置为 eval-source-map
  // devtool: 'eval-source-map',
  // 在实际发布的时候，建议大家把 devtool 的值设置为 nosources-source-map 或直接关闭 SourceMap
  devtool: 'nosources-source-map',
  // mode 代表 webpack 运行的模式，可选值有两个 development 和 production
  // 结论：开发时候一定要用 development，因为追求的是打包的速度，而不是体积；
  // 反过来，发布上线的时候一定能要用 production，因为上线追求的是体积小，而不是打包速度快！
  mode: 'development',
  // entry: '指定要处理哪个文件'
  entry: path.join(__dirname, './src/index1.js'),
  // 指定生成的文件要存放到哪里
  output: {
    // 存放的目录
    path: path.join(__dirname, 'dist'),
    // 生成的文件名
    filename: 'js/bundle.js'
  },
  // 3. 插件的数组，将来 webpack 在运行时，会加载并调用这些插件
  plugins: [htmlPlugin, new CleanWebpackPlugin()],
  devServer: {
    // 首次打包成功后，自动打开浏览器
    open: true,
    // 在 http 协议中，如果端口号是 80，则可以被省略
    port: 80,
    // 指定运行的主机地址
    host: '127.0.0.1'
  },
  module: {
    rules: [
      // 定义了不同模块对应的 loader
      { test: /\.css$/, use: ['style-loader', 'css-loader'] },
      // 处理 .less 文件的 loader
      { test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] },
      // 处理图片文件的 loader
      // 如果需要调用的 loader 只有一个，则只传递一个字符串也行，如果有多个loader，则必须指定数组
      // 在配置 url-loader 的时候，多个参数之间，使用 & 符号进行分隔
      { test: /\.jpg|png|gif$/, use: 'url-loader?limit=470&outputPath=images' },
      // 使用 babel-loader 处理高级的 JS 语法
      // 在配置 babel-loader 的时候，程序员只需要把自己的代码进行转换即可；一定要排除 node_modules 目录中的 JS 文件
      // 因为第三方包中的 JS 兼容性，不需要程序员关心
      { test: /\.js$/, use: 'babel-loader', exclude: /node_modules/ }
    ]
  },
  resolve: {
    alias: {
      // 告诉 webpack，程序员写的代码中，@ 符号表示 src 这一层目录
      '@': path.join(__dirname, './src/')
    }
  }
}

posted on 2022-03-05 10:20 zyjhandsome 阅读(45) 评论(0) 编辑收藏举报

刷新页面返回顶部

zyjhandsome

webpack基础

前端工程化

webpack基本使用

创建项目

webpack 中的默认约定

自定义打包的入口与出口

webpack的插件

webpack插件的作用

webpack-dev-server插件

webpack-dev-server插件介绍

webpack-dev-server插件工作原理

html-webpack-plugin插件

html-webpack-plugin插件介绍

解惑 html-webpack-plugin

devServer节点

webpack中的loader

loader 概述

loader 的调用过程

打包处理CSS文件

打包处理 less 文件

打包处理样式表中与 url 路径相关的文件

打包处理 js 文件中的高级语法

安装 babel-loader 相关的包

配置 babel-loader

打包发布

配置 webpack 的打包发布

把 JavaScript 文件统一生成到 js 目录中

把图片文件统一生成到 image 目录中

自动清理 dist 目录下的旧文件

Source Map

什么是 Source Map

webpack 开发环境下的 Source Map

默认 Source Map 的问题

解决默认 Source Map 的问题

webpack 生产环境下的 Source Map

只定位行数不暴露源码

定位行数且暴露源码

Source Map 的最佳实践

webpack.config.js解析

导航

公告