前端工程化和webpack

前端工程化

前端工程化指的是：在企业级的前端项目开发中，把前端开发所需的工具、技术、流程、经验等进行规范化、标准化。

企业中的Vue项目和React项目，都是基于 工程化 的方式进行开发的。

工程化开发好处：自成体系、标准的开发方案和流程

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

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

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

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

webpack（https://webpack.docschina.org/）
parcel（https://www.parceljs.cn/）

webpack基本使用

webpack是前端工程化的具体解决方案

提供了友好的前端模块化开发支持
代码压缩混淆
处理浏览器端JavaScript兼容性
性能优化

把工作重心分到具体功能的实现上
提高了前端开发效率
提高项目可以维护性

1、使用npm命令安装webpack模块

npm install webpack webpack-cli -D

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

// 使用nodejs中的导出语法 向外导出一个webpack的配置对象
module.exports = {
    mode: 'development' 
    // mode 用来指定构建模式 有 development / production
}

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

  "scripts": {
    "dev": "webpack" 
  }

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

webpack.config.js是webpack的配置文件。webpack是真正开始打包构建之前，会先读取这个配置文件，从而基于给定的配置，对项目进行打包。

mode节点的可选值有两个，分别是：

development
- 开发环境
- 不会对打包生成的文件进行代码压缩和性能优化
- 打包速度快，适合在开发阶段使用
production
- 生产环境
- 会对打包生成的文件进行代码压缩和性能优化
- 打包速度慢，仅适合在项目开发阶段使用

在webpack4.x 和 5.x版本中，有默认约定：

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

在 webpack.config.js 配置文件中

entry 节点指定打包的入口
output 节点指定打包的出口

// 导入nodejs中用于操作路径的模块
const path = require('path');

// 使用nodejs中的导出语法 向外导出一个webpack的配置对象
module.exports = {
    // mode 用来指定构建模式 有 development / production
    mode: 'development', // 不压缩代码 体积大 打包快
    // mode: 'production' // 压缩代码 体积小 打包长
    
    // 配置打包入口文件 entry 指定要处理的文件
    entry: path.join(__dirname, './src/index.js'),

    // 配置输出文件信息
    output: {
        // 输出文件存放目录
        path: path.join(__dirname, './dist'), 
        // 输出文件名称
        filename: 'bundle.js' 
    }
}

wbepack中的插件

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

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

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

运行如下的命令，即可在项目中安装 webpack-dev-server 插件：

npm install webpack-cli -D

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

  "scripts": {
    "dev": "webpack serve" 
  }

2、再次运行 npm run dev 命令，重新进行项目的打包

3、在浏览器中访问 http://localhost:8080 地址，查看自动打包效果

不配置 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 是 webpack 中的 HTML 插件，可以通过此插件自定制 index.html 页面的内容。

需求：通过 html-webpack-plugin 插件，将 src 目录下的 index.html 首页，复制到项目根目录中一份！

运行如下的命令，即可在项目中安装 html-webpack-plugin插件：

npm install html-webpack-plugin -D

修改 webpack.config.js 文件

// 导入nodejs中用于操作路径的模块
const path = require('path');
// 导入html插件，得到一个构造函数
const HtmlPlugin = require('html-webapck-plugin')

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

// 使用nodejs中的导出语法 向外导出一个webpack的配置对象
module.exports = {
    // mode 用来指定构建模式 有 development / production
    mode: 'development', // 不压缩代码 体积大 打包快
    // mode: 'production' // 压缩代码 体积小 打包长

    // 配置打包入口文件 entry 指定要处理的文件
    entry: path.join(__dirname, './src/index.js'),

    // 配置输出文件信息
    output: {
        // 输出文件存放目录
        path: path.join(__dirname, './dist'), 
        // 输出文件名称
        filename: 'bundle.js' 
    },
        
    plugins: [htmlPlugin] // 通过plugins节点，使htmlplugin插件生效
}

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

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

示例代码：

devServer: {
    open: true, // 打包成功后自动打开浏览器
    port: 80, // 配置打开端口(80端口会被省略)
    host: '127.0.0.1', // 指定运行的主机地址
}

webpack中的loader

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

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

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

01.loader调用的过程

安装处理 css 文件的 loader
```
npm install style-loader css-loader -D
```
在 webpack.config.js 文件中添加 loader 规则：
```
// 配置所有第三方模块的匹配规则
module: {
    rules: [
        // css加载器
        { test: /\.css$/, use: ['style-loader', 'css-loader'] }
    ]
}
```
其中，test表示匹配的文件类型，use表示对应要调用的loader

注意：
- use数组中指定的loader顺序是固定的
- 多个laoder的调用顺序是：从后往前调用

安装处理 less文件的 loader
```
npm install less-loader less -D
```

在 webpack.config.js 文件中添加 loader 规则：

// 配置所有第三方模块的匹配规则
module: {
    rules: [
        // less加载器
        { test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] }
    ]
}

安装处理样式表中与url路径相关的文件的 loader
```
npm install url-loader file-loader -D
```
在 webpack.config.js 文件中添加 loader 规则：
```
// 配置所有第三方模块的匹配规则
module: {
    rules: [
        // 文件路径加载器
        { test: /\.jpg|png|gif$/, use: ['url-loader?limit=22229'] }
    ]
}
```
其中 ? 后面，的是loader的参数项：
- limit用来指定图片的大小，单位是字节（byte）
- 只有 ≤ limit 大小的图片，才会被转为 base64 格式的图片

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

// 1、定义了名为info的装饰器
function info(target) {
    // 2、为目标添加静态属性info
    target.info = 'Person info'
}

// 3、为Person类引用info修饰器
@info
class Person {}

// 4、打印Person的静态属性instanceof
console.log(Person.info);

运行如下命令安装打印的依赖包：

npm install babel-loader babel/core babel/plugin-proposal-decorators -D

// OR
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: [
        // JS高级语法处理
        // 在配置babel-loader 的时候，程序员只需要把自己的代码进行转换即可,一定要排除node_modules目录中的js文件
        // 因为第三方包中的JS兼容性，不需要程序员关心
        { test: /\.js$/, use: ['babel-loader'], exclude: /node_module/ }
    ]
}

在项目根目录下，创建名为 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 对项目进行打包发布，主要原因有以下两点：

开发环境下，打包生成的文件存放于内存中，无法获取到最终打包生成的文件
开发环境下，打包生成的文件不会进行代码压缩和性能优化

为了让项目能够在生产环境中高性能的运行，因此需要对项目进行打包发布。

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

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

–model 是一个参数项，用来指定 webpack 的运行模式。production 代表生产环境，会对打包生成的文件进行代码压缩和性能优化。

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

// 配置输出文件信息
output: {
    path: path.join(__dirname, 'dist'),
        // 输出文件名称
        filename: 'js/bundle.js'
}

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

// 文件路径加载器
{
    test: /\.jpg|png|gif$/, use: {
        loader: 'url-loader',
            options: {
                limit: 22229,
                // 指定打包生成的文件放到images文件夹中
                outputPath: 'images'
            }
    }
}

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

运行如下的命令，即可在项目中安装 clean-webpack-plugin插件：

npm install clean-webpack-plugin -D

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

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

Source Map

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

对压缩混淆之后的代码除错（debug）是一件极其困难的事情

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

**Source Map 就是一个信息文件，里面储存着位置信息。**也就是说，Source Map 文件中存储着压缩混淆后的代码，所对应的转换前的位置。

有了它，出错的时候，除错工具将直接显示原始代码，而不是转换后的代码，能够极大的方便后期的调试。

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

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

module.exports = {
    mode: 'development', // 不压缩代码 体积大 打包快

    // eval-source-map 仅限于在开发模式下使用，不建议在生产模式下使用
    // 此选项生成的 Source Map能保证运行时报错错的函数与源代码行数保持一致
    devtool: 'eval-source-map'
}

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

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

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

开发环境下：
- 建议把 devtool 的值设置为 eval-source-map
- 好处：可以精准定位到具体的错误行
生产环境下：
- 建议关闭 Source Map 或将 devtool 的值设置为 nosources-source-map
- 好处：防止源码泄露，提高网站的安全性

思考

实际开发中需要自己配置 webpack 吗？

答案：不需要

实际开发中会使命令行工具（俗称 CLI）一键生成带有 webpack 的项目
开箱即用，所有 webpack 配置项都是现成的！
我们只需要知道 webpack 中的基本概念即可！

拓展

在webpack项目中，建议使用 @ 表示 src 源代码目录，从外往里查找，不要使用 ../ 从里往外查找

使用 @ 符号代替src目录需要在 webpack.config.js 中配置

resolve: {
    alias: {
        // 告诉webpack，程序员写的代码中， @ 符号表示src这层目录
        '@': path.join(__dirname, './src/')
    }
}

rce map 文件！**

开发环境下：
- 建议把 devtool 的值设置为 eval-source-map
- 好处：可以精准定位到具体的错误行
生产环境下：
- 建议关闭 Source Map 或将 devtool 的值设置为 nosources-source-map
- 好处：防止源码泄露，提高网站的安全性

思考

实际开发中需要自己配置 webpack 吗？

答案：不需要

实际开发中会使命令行工具（俗称 CLI）一键生成带有 webpack 的项目
开箱即用，所有 webpack 配置项都是现成的！
我们只需要知道 webpack 中的基本概念即可！

拓展

在webpack项目中，建议使用 @ 表示 src 源代码目录，从外往里查找，不要使用 ../ 从里往外查找

使用 @ 符号代替src目录需要在 webpack.config.js 中配置

resolve: {
    alias: {
        // 告诉webpack，程序员写的代码中， @ 符号表示src这层目录
        '@': path.join(__dirname, './src/')
    }
}