前端工程化之webpack_webpack开发模式文件保存-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_55323831/article/details/122525445

前端工程化

文章目录

模块化（js 的模块化、css的模块化、资源的模块化）
组件化（复用现有的 UI结构、样式、行为）
规范化（目录结构的划分、编码规范化、接口规范化、文档规范化、Git分支管理）
自动化（自动化构建、自动部署、自动化测试）

前端工程化指的是：在企业级的前端项目开发中，把前端开发所需的工具、技术、流程、经验等进行规范化、标准化。
企业中的 Vue 项目和 React 项目，都是基于工程化的方式进行开发的。
好处：前端开发自成体系，有一套标准的开发方案和流程。

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

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

webpack

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

在项目中安装webpack

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

在项目中安装jQuery

npm install jquery -S

在项目中配置 webpack
在项目根目录中，创建名为 webpack.config.js的 webpack 配置文件，并初始化如下的基本配置：

module.exports = {
  mode: "development", // 用来指定构建模式。可选值有 development 和 production
};

在 package.json的scripts节点下，新增dev脚本如下：

"scripts"{
  "dev":"webpack" //scripts 节点下的脚本，可以通过npm run执行。例如npm run dev
}

在终端中运行 npm run dev 命令，启动 webpack 进行项目的打包构建

webpack.config.js文件的作用
webpack.config.js 是 webpack 的配置文件。webpack 在真正开始打包构建之前，会先读取这个配置文件，从而基于给定的配置，对项目进行打包。
注意：由于 webpack 是基于 node.js 开发出来的打包工具，因此在它的配置文件中，支持使用 node.js 相关的语法和模块进行 webpack 的个性化配置。

webpack中的默认约定

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

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

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

自定义打包的入口与出口

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

const path = require("path");

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

webpack 插件的作用

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

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

安装webpack-dev-server

npm i webpack-dev-server@3.11.2 -D

配置webpack-dev-server

修改package.json -> scripts中的 dev 命令如下：

"scripts"{
  "dev":"webpack server" //scripts 节点下的脚本，可以通过npm run执行。例如npm run dev
}

再次运行 npm run dev命令，重新进行项目的打包
在浏览器中访问 http://localhost:8080 地址，查看自动打包效果

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

安装html-webpack-plugin

npm i html-webpack-plugin@5.3.2 -D

配置html-webpack-plugin

// 1.导入 HTML 插件，得到一个构造函数

const HtmlPlugin = require("html-webpack-plugin");

// 2.创建 HTML 插件的实例对象
const HtmlPlugin = new HtmlPlugin({
  template: "./src/index.html", // 指定原文件的存放路径
  filename: "./index.html", // 指定生成的文件的存放路径
});

module.exports = {
  mode: "development",
  plugins: [HtmlPlugin], // 3.通过plugins节点，使htmlPlugin插件生效
};

解惑 html-webpack-plugin

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

devServer 节点

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

devServer:{
    open: true,  // 初次打包完成后，自动打开浏览器
    host:'127.0.0.1'，// 实时打包所使用的主机地址
    port:80, // 实时打包所使用的端口号
}

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

loader

在实际开发过程中，webpack 默认只能打包处理以 .js 后缀名结尾的模块。其他非 .js 后缀名结尾的模块，webpack 默认处理不了，需要调用 loader 加载器才可以正常打包，否则会报错！

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

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

**loader 的调用过程 **
在这里插入图片描述

打包处理 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: /\.less$/, 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: [// 文件后缀名的匹配规则
    { test: /\.jpg|png|gif$/, use: "url-loader?limit=22229" },
  ];
}

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

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

打包处理 js 文件中的高级语法
webpack 只能打包处理一部分高级的 JavaScript 语法。对于那些 webpack 无法处理的高级 js 语法，需要借
助于 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 规则如下：

// 必须使用 exclude 指定排除项；因为node_modules 目录下的第三方包不需要被打包
{ test: /\.js$/, use: "babel-loader",exclude:/node_modules/ }

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

module.exports={
    // 声明 可用的插件
    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 server", // 开发环境中，运行 dev 命令
  "build":"webpack --mode production" // 项目发布时，运行 build 命令
}

–model 是一个参数项，用来指定 webpack 的运行模式。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 插件：

// 安装
npm install clean-webpack-plugin@3.0.0 -D

// 按需导入插件、得到插件的构造函数之后，创建插件的实例对象
const {CleanWebpackPlugin} = require('clean-webpack-plugin')
const cleanPlugin = new CleanWebpackPlugin()

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

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
  mode: 'development',
  // 在实际发布的时候，建议大家把 devtool 的值设置为 nosources-source-map 或直接关闭 SourceMap
  devtool: 'nosources-source-map',
  // mode 代表 webpack 运行的模式，可选值有两个 development 和 production