文章目录
- 前端工程化
- 1、小白眼中的前端开发 vs 实际的前端开发
- 2、什么是前端工程化
- 3、前端工程化的解决方案
- Webpack的基本使用
- 1、什么是 webpack
- 2、创建列表隔行变色项目
- 3、在项目中安装`webpack`
- 4、在项目中配置`webpack`
- Webpack中的插件
- 1、`webpack`插件的作用
- 2、`webpack-dev -server`
- 3、`html-webpack-plugin`
- 4、devServer
- Webpack中的loader
- 1、`loader`概述
- 2、loader的调用过程
- 3、打包处理 css 文件
- 4、打包处理 less 文件
- 5、打包处理样式表中与url路径相关的文件
- 6、打包处理 js 文件中的高级语法
- 打包发布
- 1、为什么要打包发布
- 2、配置 webpack 的打包发布
- 3、把 JavaScript 文件统一生成到 js 目录中
- 4、把图片文件统一生成到 image 目录中
- 5、自动清理 dist 目录下的旧文件
- Source Map
- 1、生产环境遇到的问题
- 2、什么是 Source Map
- 3、`webpack`开发环境下的`Source Map`
- 4、 webpack生产环境下的 Source Map
- 5、`Source Map`的最佳实践
- 总结
前端工程化
1、小白眼中的前端开发 vs 实际的前端开发
小白眼中的前端开发:
- 会写 HTML + CSS + JavaScript 就会前端开发
- 需要美化页面样式,就拽一个 bootstrap 过来
- 需要操作 DOM 或发起 Ajax 请求,再拽一个 jQuery 过来
- 需要快速实现网页布局效果,就拽一个 Layui 过来
实际的前端开发:
- 模块化 (js 的模块化、 css 的模块化、资源的模块化)
- 组件化 (复用现有的 UI 结构、样式行为)
- 规范化 (目录结构的划分、编码规范化、接口规范化、文档规范化、 Git 分支管理)
- 自动化 (自动化构建、自动部署、自动化测试
2、什么是前端工程化
前端工程化指的是:在 企业级的前端项目开发 中,把前端开发所需的 工具 、技术 、流程 、经验 等进行规范化、
标准化。企业中的 Vue 项目和 React 项目,都是基于 工程化的方式 进行开发的。
好处:前端开发 自成体系 ,有一套 标准的开发方案和流程 。
3、前端工程化的解决方案
早期的前端工程化解决方案:
grunt
( https://www.gruntjs.net/ )gulp
( https://www.gulpjs.com.cn/ )
目前主流的前端工程化解决方案:
webpack
( https://www.webpackjs.com/ )parcel
( https://zh.parceljs.org/ )
Webpack的基本使用
1、什么是 webpack
概念: webpack
是前端项目工程化的具体解决方案 。
主要功能:它提供了友好的前端模块化开发支持,以及代码压缩混淆 、处理浏览器端JavaScript
的兼容性 、性能优化 等强大的功能。
好处:让程序员把 工作的重心 放到具体功能的实现上,提高了前端 开发效率 和项目的 可维护性 。
注意:目前 Vue、React 等前端项目,基本上都是基于webpack
进行工程化开发的。
2、创建列表隔行变色项目
① 新建项目空白录,并运行npm init –y
命令,初始化包管理配置文件package.json
② 新建src
源代码目录
③ 新建src -> index.html
首页和src -> index.js
脚本文件
④ 初始化首页基本的结构
⑤ 运行npm install jquery –S
命令,安装jQuery
⑥ 通过ES6
模块化的方式导入jQuery
,实现列表隔行变色效果
3、在项目中安装webpack
在终端运行如下的命令,安装webpack
相关的两个包:
npm install webpack@5.42.1 webpack-cli@4.7.2-D
4、在项目中配置webpack
① 在项目根目录中,创建名为webpack.config.js
的webpack
配置文件,并初始化如下的基本配置:
module.exports={
mode:'development' //mode用来指定构建模式,可选值有development和production
}
② 在 package.json
的scripts
节点下,新增dev
脚本 如下:
"scripts":{
"dev":"webpack" //script节点下的脚本,可以通过npm run执行,例如npm run dev
}
③ 在终端中运行npm run dev
命令,启动webpack
进行项目的打包构建
4.1 mode
的可选值
mode
节点的可选值有两个,分别是:
① development
- 开发环境
- 不会对打包生成的文件进行代码压缩和性能优化
- 打包速度快,适合在开发阶段使用
② production
- 生产环境
- 会对打包生成的文件进行 代码压缩和性能优化
- 打包速度很慢 ,仅适合在项目发布阶段使用
4.2 webpack.config.js
文件的作用
webpack.config.js
是webpack
的配置文件。 webpack
在真正开始打包构建之前,会 先读取这个配置文件 , 从而基于给定的配置,对项目进行打包。
注意:由于webpack
是基于node.js
开发出来的 打包工具,因此在它的配置文件中,支持使用 node.js 相关 的语法和模块进行 webpack 的个性化配置。
4.3 webpack
中的默认约定
在webpack 4.x
和5.x
的版本中,有如下的默认约定:
① 默认的打包入口文件为src-> index.js
② 默认的输出文件路径为dist -> main.js
注意:可以在 webpack.config.js 中修改打包的默认约定
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中的插件
1、webpack
插件的作用
通过安装和配置第三方的插件,可以拓展 webpack 的能力 ,从而让 webpack 用起来更方便 。最常用的 webpack 插件有如下两个:
① webpack-dev-server
- 类似于
node.js
阶段用到的nodemon
工具 - 每当修改了源代码,webpack会自动进行项目的打包和构建
② html-webpack-plugin
webpack
中的 HTML 插件(类似于一个模板引擎插件)- 可以通过此插件自定制 index.html 页面的内容
2、webpack-dev -server
webpack-dev-server
可以让webpack
监听项目源代码的变化 ,从而进行 自动打包构建 。
2.1 安装webpack-dev -server
运行如下的命令,即可在项目中安装此插件 :
npm install webpack-dev-server@3.11.2-D
2.2 配置webpack-dev -server
① 修改package.json -> scripts
中的dev
命令如下:
"scripts":{
"dev":"webpack serve" //script节点下的脚本,可以通过npm run执行,例如npm run 执行
}
② 再次运行npm run dev
命令,重新进行项目的打包
③ 在浏览器中访问http://localhost:8080
地址,查看自动打包效果
注意:webpack-dev-server
会启动一个 实时打包的http服务器
2.3 打包生成的文件哪儿去了?
① 不配置webpack-dev-server
的情况下,webpack
打包生成的文件,会存放到 实际的物理磁盘上
- 严格遵守开发者在
webpack.config.js
中指定配置 - 根据
output
节点 指定路径进行存放
② 配置了webpack-dev-server
之后,打包生成的文件 存放到了内存中
- 不再根据
output
节点指定的路径,存放到实际的物理磁盘上 - 提高了实时打包输出的 性能 ,因为内存比物理磁盘速度快很多
2.4生成到内存中的文件该如何访问?
webpack-dev-server
生成到内存中的文件,默认 放到了项目的根目录中 ,而且是 虚拟的 、不可见的 。
- 可以直接用 / 表示 项目根录 ,后面跟上要访问的文件名称 ,即可访问内存中的文件
- 例如
/bundle.js
就表示要访问webpack-dev-server
生成到内存中的bundle.js
文件
3、html-webpack-plugin
html-webpack-plugin
是webpack
中的 HTML 插件 ,可以通过此插件自定制index.html
页面的内容 。
需求 :通过html-webpack-plugin
插件,将src
目录下的 index.html
首页, 复制到项目根目录中一份 !
3.1 安装html-webpack-plugin
运行如下的命令,即可在项目中安装此插件 :
npm install html-webpack-plugin@5.3.2 -D
3.2 配置html-webpack-plugin
const HtmlPlugin = require('html-webpack-plugin') // 导入node.js中专门操作路径的模块
const htmlPlugin = ({
template:'./src/index.html', // 指定源文件的存取路径
filename:'./index.html' // 指定生成的文件的存取路径
})
module.exports = {
mode:'development',
plugins:[htmlPlugin] // 通过plugins节点,使htmlPlugin插件生效
}
3.3 解惑html-webpack-plugin
① 通过 HTML 插件复制到项目根目录中的index.html
页面, 也被放到了内存中
② HTML 插件在生成的index. html
页面 ,自动注入 了打包的bundle.js
文件
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
1、loader
概述
在实际开发过程中, webpack
默认只能打包处理以 .js 后缀名结尾的模块。其他 非.js
后缀名结尾的模块 , webpack
默认处理不了, 需要调用 loader
加载器才可以正常打包 ,否则会报错!
loader
加载器的作用: 协助 webpack 打包处理特定的文件模块 。比如:
css-loader
可以打包处理.css
相关的文件less -loader
可以打包处理.less
相关的文件babel-loader
可以打包处理webpack
无法处理的高级 JS 语法
2、loader的调用过程
3、打包处理 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 的调用顺序是: 从后往前调用
4、打包处理 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']},
]
}
5、打包处理样式表中与url路径相关的文件
① 运行 npm i url-loader@4.1.1 file-loader@6.2.0 -D
命令
② 在webpack.config.js
的module-> rules
数组中,添加 loader 规则如下:
module:{ // 所有第三方文件模块的匹配规则
rules:[ // 文件后缀名的匹配规则
{test:/\.jpg|ong|gif$/,use['url-loader?limit=22229']},
]
}
其中?
之后的是loader
的参数项 :
limit
用来指定 图片的大小 ,单位是字节 bytebyte)- 只有 ≤ limit 大小的图片,才会被转为 base64格式的图片
6、打包处理 js 文件中的高级语法
webpack只能打包处理 一部分 高级的 JavaScript 语法。对于那些 webpack 无法处理的高级 js 语法,需要借 助于babel-loader
进行打包处理。例如 webpack 无法处理下面的JavaScript代码:
// 1、定义了名为info的装饰器
function info(){
//2、为目标添加静态属性info
target.info = 'Person info'
}
// 3、为Person类应用info装饰器
@info
class Person{}
// 4、打印Person的静态属性info
console.log(Person.info)
6.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/]}
6.2 配置babel-loader
在项目根目录下,创建名为babel.config.js
的配置文件,定义 Babel 的配置项 如下:
module.exports = {
// 声明babel 可用的插件
plugins:[['@babel/plugin-proposal-decorators',{legcay:true}]]
}
详情请参考Babel 的官网
打包发布
1、为什么要打包发布
项目开发完成之后 ,需要使用 webpack 对项目进行打包发布 ,主要原因有以下两点
① 开发环境下,打包生成的文件 存放于内存中 ,无法获取到最终打包生成的文件
② 开发环境下,打包生成的文件 不会进行代码压缩和性能优化
为了让项目能够在生产环境中高性能的运行,因此需要对项目进行打包发布。
2、配置 webpack 的打包发布
在package.json
文件的scripts
节点下,新增 build 命令如下:
"scripts":{
"dev":"webpack serve" // 开发环境中,运行dev命令
"build":"webpack --mode production" // 项目发布时,运行build命令
}
-- model
是一个参数项,用来指定webpack
的运行模式 。production 代表生产环境,会对打包生成的文件
进行 代码压缩 和性能优化 。
注意:通过-- model
指定的参数项,会 覆盖webpack.config.js
中的 model 选项。
3、把 JavaScript 文件统一生成到 js 目录中
在 webpack.config.js 配置文件的 output 节点中,进行如下的配置:
output:{
path:path.join(__dirname,'dist'),
// 明确告诉Webpack把生成bundle.js文件存放到dist目录下的js子目录中
filename:'js/bundle.js',
}
4、把图片文件统一生成到 image 目录中
修改 webpack.config.js 中的 url-loader 配置项,新增 outputPath 选项即可指定图片文件的输出路径:
5、自动清理 dist 目录下的旧文件
为了在每次打包发布时 自动清理掉 dist 目录中的旧文件 ,可以安装并配置 clean-webpack-plugin 插件:
Source Map
1、生产环境遇到的问题
前端项目在投入生产环境之前,都需要对JavaScript 源代码进行 压缩混淆 ,从而减小文件的体积,提高文件的加载效率。此时就不可避免的产生了另一个问题:
对压缩混淆之后的代码除错(debug)是一件极其困难的事情
- 变量被替换成 没有任何语义 的名称
- 空行和注释被剔除
2、什么是 Source Map
Source Map就是一个信息文件,里面储存着位置信息 。也就是说, Source Map文件中存储着压缩混淆后的代码,所对应的 转换前的位置 。有了它,出错的时候,除错工具将直接显示原始代码 ,而不是转换后的代码 ,能够极大的方便后期的调试。
3、webpack
开发环境下的Source Map
在开发环境下 ,webpack 默认启用了 Source Map 功能。当程序运行出错时,可以直接在控制台提示错误行的位置 ,并定位到具体的源代码 :
3.1 默认Source Map
的问题
开发环境下默认生成的Source Map
,记录的是 生成后的代码的位置 。会导致 运行时报错的行数 与源代码的行数不一致的问题。示意图如下:
3.2 解决默认Source Map
的问题
开发环境下,推荐在webpack.config.js
中添加如下的配置,即可保证 运行时报错的行数 与源代码的行数保持一致:
4、 webpack生产环境下的 Source Map
在生产环境下 ,如果 省略了 devtool 选项 ,则最终生成的文件中 不包含 Source Map 。这能够 防止原始代码 通 过 Source Map 的形式 暴露给别有所图之人。
4.1只定位行数不暴露源码
在生产环境下,如果 只想定位报错的具体行数 ,且 不想暴露源码 。此时可以将 devtool 的值设置为nosources-source-map
。实际效果如图所示:
4.2 定位行数且暴露源码
在生产环境下,如果 想在定位报错行数的同时 ,展示具体报错的源码 。此时可以将 devtool 的值设置为 source-map 。实际效果如图所示:
采用此选项后:你应该将你的服务器配置为,不允许普通用户访问 source map 文件 !
5、Source Map
的最佳实践
① 开发环境下:
- 建议把
devtool
的值设置为eval-source-map
- 好处:可以精准定位到具体的错误行
② 生产环境下:
- 建议 关闭 Source Map 或将 devtool 的值设置为
nosources-source-map
- 好处:防止源码泄露,提高网站的安全性
总结
① 能够掌握 webpack 的基本使用
- 安装、 webpack.config.js 、修改打包入口
② 了解常用的 plugin 的基本使用
- webpack-dev-server 、html-webpack-plugin
③ 了解常用的 loader 的基本使用
- loader 的作用、 loader 的调用过程
④ 能够说出 Source Map 的作用
- 精准定位到 错误行 并显示对应的源码
- 方便开发者调试源码中的错误