webpack打包

435 阅读10分钟

概念:

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

当然直接使用vue-cli可以直接生成

主要功能:

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

好处:

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

使用

1、安装

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

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

拓展:-S 是--save拓展 -D 是--save-dev缩写

2、配置

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

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

解释:

mode可选值

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

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

🍎2.2、在package.json 的scripts 节点下,新增dev 脚本如下:

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

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

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

将案例中引入打包生成的main.js即可成功

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 = {
    //mode: 'development',  //mode用来指定构建模式。可选值有development 和 production
    entry: path.join(__dirname, './src/index.js'),//打包入口文件的路径
    output: {
        path: path.join(__dirname, 'dist'),//输出文件的存放路径
        filename: 'bundle.js'//输出文件的名称
    }
}

webpack中插件

插件的作用

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

webpack-dev-server自动打包构建

类似于node.js 阶段用到的nodemon 工具 每当修改了源代码,webpack 会自动进行项目的打包和构建

使用

1、安装

npm install  webpack-dev-server@3.11.2 -D

有坑webpack-cli内部也就是项目版本必须是4.9.0左右才行

2、配置

2.1、修改package.json -> scripts中的dev命令如下:
"scripts": {
    "dev" : "webpack serve" // script节点下的脚本,可以通过 npm run 执行
  },
2.2、再次运行npm run dev 命令,重新进行项目的打包
2.3、在浏览器中访问http://localhost:8080 地址,查看自动打包效果

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

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

1、不配置webpack-dev-server 的情况下,webpack 打包生成的文件,会存放到实际的物理磁盘上

严格遵守开发者在webpack.config.js 中指定配置

根据output 节点指定路径进行存放

2、配置了webpack-dev-server 之后,打包生成的文件存放到了内存中

不再根据output 节点指定的路径,存放到实际的物理磁盘上

提高了实时打包输出的性能,因为内存比物理磁盘速度快很多

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

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

可以直接用/ 表示项目根目录,后面跟上要访问的文件名称,即可访问内存中的文件

例如/bundle.js 就表示要访问webpack-dev-server 生成到内存中的bundle.js 文件

/bundle.js ⭐⭐⭐引用js

html-webpack-plugin

html-webpack-plugin 是webpack 中的HTML 插件,可以通过此插件自定制index.html 页面的内容。

需求:通过html-webpack-plugin 插件,将src 目录下的index.html 首页,复制到项目根目录中一份!访问直接进入首页

使用

1、安装

npm  install html-webpack-plugin@5.3.2 -D

2、配置

// 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 插件复制到项目根目录中的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 中的loader

loader 概述

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

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

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

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

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

打包处理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 的调用顺序是:从后往前调用

打包处理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'] },
        ]
    }

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

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

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

module: { //所有第三方文件模块的匹配规则
        rules: [ //文件后缀名的匹配规则
            // 如果需要调用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 代码:

// 1.定义了名为info 的装饰器
function info(target) {
    // 2.为目标添加静态属性info
    target.info = 'Person info'
}
//3.为Person类应用info 装饰器
@info
class Person { }
// 4.打印 Person的静态属性info
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 规则如下:

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

配置babel-loader

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

module.exports = {
    //声明babel可用的插件
    plugins: [['@babel/plugin-proposal-decorators', { legacy: true }]]
}

打包发布

为什么要打包发布

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

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

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

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

配置webpack 的打包发布

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

"scripts": {
    "dev" : "webpack serve",//开发环境中,运行dev命令
	"build": "webpack --mode production" //项目发布时,运行build命令
  },

--mode 是一个参数项,用来指定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选项即可指定图片文件的输出路径:

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

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

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

// 1.安装清理dist目录的 webpack插件
npm install --save-dev clean-webpack-plugin -D
// 2.按需导入插件、得到插件的构造函数之后,创建插件的实例对象
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
const cleanPlugin=new CleanWebpackPlugin()
// 3.把创建的 cleanPlugin插件实例对象,挂载到plugins节点中  在module中
plugins: [htmlPlugin,cleanPlugin],//挂载插件

Source Map

1、生产环境遇到的问题

前端项目在投入生产环境之前,都需要对JavaScript 源代码进行压缩混淆,从而减小文件的体积,提高文件的

加载效率。此时就不可避免的产生了另一个问题:

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

变量被替换成没有任何语义的名称

空行和注释被剔除

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

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

  1. webpack 开发环境下的Source Map 在开发环境下,webpack 默认启用了Source Map 功能。当程序运行出错时,可以直接在控制台提示错误行

的位置,并定位到具体的源代码:

3.1 默认Source Map 的问题

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

3.2 解决默认Source Map 的问题 开发环境下,推荐在webpack.config.js 中添加如下的配置,即可保证运行时报错的行数与源代码的行数保持一致:

module.exports = {
	mode: 'development',
	// eval-source-map仅限在"开发模式"下使用,不建议在“生产模式"下使用。
	//此选项生成的 Source Map 能够保证"运行时报错的行数"与"源代码的行数"保持一致
	devtool: 'eval-source-map',
	//省略其它配置项...
}
  1. webpack 生产环境下的Source Map 在生产环境下,如果省略了devtool 选项,则最终生成的文件中不包含Source Map。这能够防止原始代码通

过Source Map 的形式暴露给别有所图之人。

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

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

  1. Source Map 的最佳实践

开发环境下:

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

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

生产环境下:

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

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