前端工程化与webpack

一、前端工程化

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

模块化：JS的模块化、CSS的模块化、资源的模块化。

组件化：复用现有的UI结构、样式、行为。

规范化：目录结构的划分、编码规范化、接口规范化、文档规范化、Git分支管理。

自动化：自动化构建、自动部署、自动化测试。

二、webpack的基本使用

2.1.什么是webpack

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

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

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

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

2.2.创建列表隔行变色项目

1.新建项目空白目录，并运行npm init -y命令，初始化包管理配置文件package.json

2.新建src源代码目录

3.新建src->index.html首页和src->index.js脚本文件

4.初始化首页基本的结构

5.运行npm install jquery -S命令，安装jQuery

6.通过ES6模块化的方式导入jQuery，实现列表隔行变色效果

2.3.在项目中安装webpack

在终端运行如下的命令，安装webpack相关的两个包：

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

2.4.在项目中配置webpack

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

module.exports = {

        mode: 'development'        // mode用来指定构建模式。可选值又development和production

}

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

"scripts": {

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

}

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

2.4.1.mode的可选值

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

1.development

        开发环境

        不会对打包生成的文件进行代码压缩和性能优化

        打包速度快，适合在开发阶段使用

2.production

        生产环境

        会对打包生成的文件进行代码压缩和性能优化

        打包速度很慢，仅适合在项目发布阶段使用

2.4.2.webpack.config.js文件的作用

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

注意：由于webpack是基于node.js开发出来的打包工具，因此在它的配置文件中，支持使用node.js相关的语法和模块进行webpack的个性化配置。

2.4.3.webpack中的默认约定

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

1.默认的打包入口文件为src->index.js

2.默认的输出文件路径为dist->main.js

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

2.4.4.自定义打包的入口与出口

// 在webpack.config.js配置文件中，通过entry节点指定打包的入口。通过output节点指定打包的出口。示例代码如下：
const path = require('path')  // 导入node.js中专门操作路径的模块

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

三、webpack中的插件

3.1.webpack插件的作用

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

1.webpack-dev-server

        类似于node.js阶段用到的nodemon工具

        每当修改了源代码，webpack会自动进行项目的打包和构建

2.html-webpack-plugin

        webpack中的HTML插件(类似于一个模板引擎插件)

        可以通过此插件自定制index.html页面的内容

3.2.webpack-dev-server

3.2.1.安装webpack-dev-server

运行如下的命令，即可在项目中安装此插件：

npm install webpack-dev-server@3.11.2 -D

3.2.2.配置webpack-dev-server

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

"scripts": {

        "dev": "webpack server",    // script节点下的脚本，可以通过npm run 执行

}

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

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

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

3.3.html-webpack-plugin

3.3.1.安装html-webpack-plugin

运行如下的命令，即可在项目中安装此插件：

npm install html-webpack-plugin@5.3.2 -D

3.3.2.配置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插件生效
}

3.4.devServer节点

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

示例代码如下：

devServer: {

        open: true,        // 初次打包完成后，自动打开浏览器

        host: '127.0.0.1',        // 实时打包使用的主机地址

        port: 80,        // 实时打包所使用的端口号

}

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

四、webpack中的loader

4.1.oader概述

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

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

css-loader可以打包处理.css相关的文件

less-loader可以打包处理.less相关的文件

babel-loader可以打包处理webpack无法处理的高级JS语法

4.2.打包处理css文件

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

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

module: {        // 所有第三方文件模块的匹配规则

        rules: [        // 文件后缀名的匹配规则

                { test:/\.css$/, use: ['style-loader', 'css-loader'] }

        ]

}

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

注意：

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

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

4.3.打包处理less文件

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

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

module:{        // 所有第三方文件模块的匹配规则

        rules: {        // 文件后缀名的匹配规则

                { test: /\.less$/, use: ['style-loader','css-loader','less-loader'] }

        }

}

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

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

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

module:{        // 所有第三方模块的匹配规则

        rules: {        // 文件后缀名的匹配规则

                { test: /\.jpg|png|gifs/, use: 'url-loader?limit=22229' }

        }

}

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

        limit用来指定图片的大小，单位是字节(byte)

        只有≤limit大小的图片，才会被转为base64格式的图片

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

// 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的静态属性info
console.log(Person.info)

4.5.1.安装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/ }

4.5.2.配置babel-loader

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

module.exports = {

        // 声明babel可用的插件

        plugins: [['@babel/plugin-proposal-decorators', { legacy: true }]]

}

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

五、打包发布

5.1.为什么要打包发布

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

1.开发环境下，打包生成的文件存放于内存中，无法获取到最终打包生成的文件

2.开发环境下，打包生成的文件不会进行代码压缩和性能优化

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

5.2.配置webpack的打包发布

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

"scripts": {

        "dev": "webpack serve",        // 开发环境中，运行dev命令

        "build": "webpack --mode production"        // 项目发布时，运行build命令

}

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

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

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

// 在webpack.config.js配置文件的output节点中，进行如下的配置：
output:{
    path: path.join(__dirname, 'dist'),
    // 明确告诉webpack把生成的bundle.js文件存放到dist目录下的js子目录中
    filename: 'js/bundle.js'
}

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

// 修改webpack.config.js中的url-loader配置项，新增outputPath选项即可指定图片文件的输出路径：
{
    test:/\.jpg|png|gifs/,
    use: {
        loader: 'url-loader',
        options: {
            limit:22228,
            // 明确指定把打包生成的图片文件，存储到dist目录下的image文件中
            outputPath: 'image',
        },    
    },
}

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

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

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

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

六、Source Map

6.1.什么是Source Map

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

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

6.2.webpack开发环境下的Source Map

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

6.3.Source Map的问题

6.3.1.默认Source Map的问题

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

6.3.2.解决默认Source Map的问题

// 开发环境下，推荐在webpack.config.js中添加如下的配置，即可保证运行时报错的行数与源代码的行数保持一致：
module.exports = {
    mode: 'development',
    // eval-source-map仅限在"开发模式"下使用，不建议在"生产模式"下使用
    // 此选项生成的Source Map能够保证"运行时报错的行数"与"源代码的行数"报错一致
    devtool: 'eval-source-map',
    // 省略其它配置项...
}

6.4.webpack生产环境下的Source Map

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

6.4.1.只定位行数不暴露源码

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

6.4.2.定位行数且暴露源码

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

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

6.5.Source Map的最佳实践

开发环境下：

        建议把devtool的值设置为eval-source-map

        好处：可以精准定位到具体的错误行

生产环境下：

        建议关闭Source Map或将devtool的值设置为nosources-source-map

        好处：防止源码泄露，提高网站的安全性