vue入门基础之–前端工程化与 webpack
webpack文档
https://webpack.docschina.org/concepts/#entry
1 前端工程化
1.1什么是前端开发
小白眼中的前端开发 vs 实际的前端开发
小白眼中的前端开发:
- 会写 HTML + CSS + JavaScript 就会前端开发
- 需要美化页面样式,就拽一个 bootstrap 过来
- 需要操作 DOM 或发起 Ajax 请求,再拽一个 jQuery 过来
- 需要快速实现网页布局效果,就拽一个 Layui 过来
实际的前端开发:
- 模块化(js 的模块化、css 的模块化、资源的模块化)
- 组件化(复用现有的 UI 结构、样式、行为)
- 规范化(目录结构的划分、编码规范化、接口规范化、文档规范化、 Git 分支管理)
- 自动化(自动化构建、自动部署、自动化测试)
1.2 什么是前端工程化
前端工程化指的是:在企业级的前端项目开发
中,把前端开发所需的工具、技术、流程、经验
等进行规范化、标准化。
企业中的 Vue 项目和 React 项目,都是基于工程化的方式进行开发的。
好处:前端开发自成体系,有一套标准的开发方案和流程。
1.3 前端工程化的解决方案
早期的前端工程化解决方案:
- grunt( https://www.gruntjs.net/ )
- gulp( https://www.gulpjs.com.cn/ )
目前主流的前端工程化解决方案:
- webpack( https://www.webpackjs.com/ )
- parcel( https://zh.parceljs.org/ )
2 webpack 的基本使用
2.1 什么是 webpack
概念:webpack 是前端项目工程化
的具体解决方案。
主要功能:它提供了友好的前端模块化开发
支持,以及代码压缩混淆、处理浏览器端 JavaScript 的兼容性、性能优化
等强大的功能。
好处:让程序员把工作的重心
放到具体功能的实现上,提高了前端开发效率
和项目的可维护性
。
注意:目前 Vue,React 等前端项目,基本上都是基于 webpack 进行工程化开发的。
2.2 创建列表隔行变色项目
① 新建项目空白目录,并运行 npm init –y 命令,初始化包管理配置文件 package.json
② 新建 src 源代码目录
③ 新建 src -> index.html 首页和 src -> index.js 脚本文件
index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<script src="./index.js"></script>
</head>
<body>
<ul>
<li>这是第 1 个 li</li>
<li>这是第 2 个 li</li>
<li>这是第 3 个 li</li>
<li>这是第 4 个 li</li>
<li>这是第 5 个 li</li>
<li>这是第 6 个 li</li>
<li>这是第 7 个 li</li>
<li>这是第 8 个 li</li>
<li>这是第 9 个 li</li>
</ul>
<!-- 需求:把 /src/images/logo.jpg 设置给 src 属性 -->
<img src="" alt="" class="box">
</body>
</html>
index.js
// 1. 使用 ES6 导入语法,导入 jQuery
import $ from 'jquery'
// 2. 定义 jQuery 的入口函数
$(function () {
// 3. 实现奇偶行变色
// 奇数行为红色
$('li:odd').css('background-color', 'red')
$('li:even').css('background-color', 'pink')
// 0 是偶数
// 1 是奇数
})
④ 初始化首页基本的结构
⑤ 运行 npm install jquery –S 命令,安装 jQuery
⑥ 通过 ES6 模块化的方式导入 jQuery,实现列表隔行变色效果
2.3 在项目中安装webpack
在终端运行如下的命令,安装 webpack 相关的两个包:
npm install webpack
npm install webpack-cli
2.4 在项目中配置 webpack
① 在项目根目录中,创建名为webpack.config.js
的 webpack 配置文件,并初始化如下的基本配置:
module.exports = {
mode: 'development'
}
② 在 package.json 的 scripts 节点下,新增 dev
脚本如下:
"scripts": {
"dev": "webpack serve"
}
如果遇到报以下错误 看是否逗号没写
package.json must be actual JSON, not just JavaScript.
2.4.1 mode 的可选值
mode 节点
的可选值有两个,分别是:
① development
-
开发环境
- 不会对打包生成的文件进行代码压缩和性能优化
- 打包
速度快
,适合在开发阶段
使用
② production
生产环境
- 会对 打包生成的文件进行
代码压缩
和性能优化
- 打包
速度很慢
,仅适合在项目发布阶段
使用
2.4.2 webpack.config.js 文件的作用
webpack.config.js 是 webpack 的配置文件。webpack 在真正开始打包构建之前,会先读取这个配置文件,从而基于给定的配置,对项目进行打包。
注意:由于 webpack 是基于 node.js 开发出来的
打包工具,因此在它的配置文件中,支持使用 node.js 相关的语法和模块进行 webpack 的个性化配置。
2.4.3 webpack 中的默认约定
在 webpack 4.x 和 5.x 的版本中,有如下的默认约定:
① 默认的打包入口文件为 src -> index.js
② 默认的输出文件路径为 dist -> main.js
注意:可以在 webpack.config.js 中修改打包的默认约定
2.4.4 自定义打包的入口与出口
在 webpack.config.js 配置文件中,通过 entry 节点指定打包的入口。通过 output 节点指定打包的出口。
示例代码如下:
// 导入node.js 中专门操作路径的模块
const path = require('path')
module.exports = {
mode: "development",
entry: path.join(__dirname,'./src/index.js'), //打包入口文件的路径
output: {
path: path.join(__dirname,'./dist'), //输出文件的存放路径
filename: 'bundle.js' //输出文件的名称
},
}
执行npm run dev 输入localhost:8080
网页跟以前一样 但是更改上诉例题中的
// 原来的
<script src="./index.js"></script> -->
// 更改后的
<script src="../dist/bundle.js"></script>
能发现效果还是一样 输出dist目录下有bundle.js文件
3 webpack 中的插件
3.1 webpack 插件的作用
通过安装和配置第三方的插件,可以拓展 webpack 的能力
,从而让 webpack 用起来更方便。最常用的
webpack 插件有如下两个:
① webpack-dev-server
- 类似于 node.js 阶段用到的 nodemon 工具
- 每当修改了源代码,webpack 会自动进行项目的打包和构建
② html-webpack-plugin
- webpack 中的 HTML 插件(类似于一个模板引擎插件)
- 可以通过此插件自定制 index.html 页面的内容
3.2 webpack-dev-server插件
webpack-dev-server
可以让 webpack 监听项目源代码的变化,从而进行自动打包构建
。
3.2.1 安装 webpack-dev-server
运行如下的命令,即可在项目中安装此插件:
npm install webpack-dev-server
3.2.2 配置 webpack-dev-server
① 修改package.json -> scripts
中的 dev 命令如下:
"scripts": {
"dev": "webpack serve"
}
② 再次运行 npm run dev
命令,重新进行项目的打包
③ 在浏览器中访问 http://localhost:8080 地址,查看自动打包效果 可以看出网页效果
注意:webpack-dev-server 会启动一个实时打包
的 http 服务器
3.3 打包生成的文件哪儿去了?(很重要)
① 不配置 webpack-dev-server 的情况下,webpack 打包生成的文件,会存放到实际的物理磁盘上
- 严格遵守开发者在 webpack.config.js 中指定配置
- 根据
output
节点指定路径进行存放
② 配置了 webpack-dev-server 之后,打包生成的文件存放到了内存中
- 不再根据 output 节点指定的路径,存放到实际的物理磁盘上
- 提高了实时打包输出的性能,因为内存比物理磁盘速度快很多
- 但是访问localhost:8080访问不到网页 访问http://localhost:8080/bundle.js可以访问到
- 要想访问index.html 需要使用html-webpack-plugin插件
3.4 生成到内存中的文件该如何访问?
webpack-dev-server 生成到内存中的文件,默认放到了项目的根目录中,而且是虚拟的、不可见的。
- 可以直接用 / 表示
项目根目录,后面跟上要访问的文件名称
,即可访问内存中的文件 - 例如
/bundle.js
就表示要访问 webpack-dev-server 生成到内存中的 bundle.js 文件
更改例题index.html中js文件位置
<!-- 加载和引用内存中的 bundle.js -->
<script src="/bundle.js"></script>
发现虽然根目录下没有bundle.js文件 但依旧样式可以用,说明生成
3.5 html-webpack-plugin插件
html-webpack-plugin 是webpack 中的 HTML 插件
,可以通过此插件自定制
index.html 页面的内容
。
需求:通过 html-webpack-plugin 插件,将 src 目录下的 index.html 首页,复制到项目根目录中一份
!
3.5.1 安装 html-webpack-plugin
运行如下的命令,即可在项目中安装此插件:
npm install html-webpack-plugin
3.5.2 配置 html-webpack-plugin
webpack.config.js (不需要删除前面的配置)
const HtmlPlugin = require('html-webpack-plugin')
const htmlPlugin = new HtmlPlugin({
template: './src/index.html',
filename: './index.html'
})
module.exports = {
plugins:[htmlPlugin]
}
3.6 解惑 html-webpack-plugin
① 通过 HTML 插件复制到项目根目录中的 index.html 页面,也被放到了内存中
② HTML 插件在生成的 index.html 页面,自动注入了打包的 bundle.js 文件
访问localhost:8080 可以看到复制后的html网页
3.7 devServer 节点
在 webpack.config.js 配置文件中,可以通过 devServer 节点对 webpack-dev-server 插件进行更多的配置,
示例代码如下:
devServer: {
open: true, //初次打包完成后,自动打开浏览器
host: '127.0.0.1', //实时打包所用的主机地址
port:80 //实时打包所用的端口
}
注意:凡是修改了 webpack.config.js 配置文件,或修改了 package.json 配置文件,必须重启实时打包的服务器
,否则最新的配置文件无法生效!
4 webpack 中的 loader -处理css等文件
4.1 loader 概述
在实际开发过程中,webpack 默认只能打包处理以 .js 后缀名结尾的模块。其他非 .js 后缀名结尾的模块
,webpack 默认处理不了,需要调用 loader 加载器才可以正常打包
,否则会报错!
loader 加载器的作用:协助 webpack 打包处理特定的文件模块
。比如:
- css-loader 可以打包处理 .css 相关的文件
- less-loader 可以打包处理 .less 相关的文件
- babel-loader 可以打包处理 webpack 无法处理的高级 JS 语法
4.2 loader的调用过程
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-bnBtZe1t-1648651173748)(C:\Users\HONOR\AppData\Roaming\Typora\typora-user-images\image-20220319224409994.png)]
4.3 loader的详细调用过程
// 1 使用ES6导入语法 导入jQuery
import $ from 'jquery'
//导入央视(在webpack中 一切都是模块)
import './css/index.css'
1 webpack默认只能打包处理.js结尾的文件 处理不了其他后缀的文件
2 由于代码中包含了 index.css
这个文件 因此webpack默认处理不了
3 当webpack发现某个文件处理不了的时候 会查找webpack.config.js
这个配置文件,看module.rules数组中,是否配置了对应的loader加载器
module: {
rules: [
// 定义了不同模块对应的 loader
{ test: /\.css$/, use: ['style-loader', 'css-loader'] },
]
}
4 webpack把index.css这个文件 先
转交给最后一个loader进行处理 (先转交给css-loader)
5 当css-loader处理完毕之后 会把处理结果 转交给下一个loader(转交给style-loader)
6 当style-loader处理完毕后 发现没有下一个loader 于是把处理结果转交给webpack
7 webpack把style-loader 处理的结果 合并到/dist/bundle.js
最终生成打包好的文件
4.4 打包处理css文件
① 运行 npm i style-loader css-loader -D
命令,安装处理 css 文件的 loader
② 在 webpack.config.js 的 module -> rules
数组中,添加 loader 规则如下:
module: {
rules: [
// 定义了不同模块对应的 loader
{ test: /\.css$/, use: ['style-loader', 'css-loader'] },
]
}
其中,test 表示匹配的文件类型
, use 表示对应要调用的 loader
注意:
- use 数组中指定的 loader
顺序是固定的
- 多个 loader 的调用顺序是:
从后往前调用
4.5 打包处理 less 文件
① 运行 npm i less-loader less -D
命令
② 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
module: {
rules: [
// 处理 .less 文件的 loader
{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] },
]
}
4.6 打包处理样式表中与 url 路径相关的文件
① 运行 npm i url-loader file-loader-D
命令
② 在 webpack.config.js 的 module -> rules
数组中,添加 loader 规则如下:
module: {
rules: [
// 处理图片文件的 loader
// 如果需要调用的 loader 只有一个,则只传递一个字符串也行,如果有多个loader,则必须指定数组
// 在配置 url-loader 的时候,多个参数之间,使用 & 符号进行分隔
{ test: /\.jpg|png|gif$/, use: 'url-loader?limit=470&outputPath=images' },
]
}
其中 ? 之后的是loader 的参数项
:
- limit 用来指定
图片的大小
,单位是字节(byte) - 只有 ≤ limit 大小的图片,才会被转为 base64 格式的图片
4.7 打包处理 js 文件中的高级语法
webpack 只能打包处理一部分高级的 JavaScript 语法。对于那些 webpack 无法处理的高级 js 语法,需要借助于babel-loader
进行打包处理。例如 webpack 无法处理下面的 JavaScript 代码:
// 定义装饰器函数
function info(target) {
target.info = 'Person info.'
}
// 定义一个普通的类
@info
class Person {}
console.log(Person.info)
4.8 安装 babel-loader 相关的包
运行如下的命令安装对应的依赖包:
npm i babel-loader @babel/core @babel/plugin-proposal-decorators -D
在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
// 使用 babel-loader 处理高级的 JS 语法
// 在配置 babel-loader 的时候,程序员只需要把自己的代码进行转换即可;一定要排除 node_modules 目录中的 JS 文件
// 因为第三方包中的 JS 兼容性,不需要程序员关心
{ test: /\.js$/, use: 'babel-loader', exclude: /node_modules/ }
4.9 配置 babel-loader
在项目根目录下,创建名为 babel.config.js 的配置文件,定义 Babel 的配置项如下:
module.exports = {
// 3. 插件的数组,将来 webpack 在运行时,会加载并调用这些插件
plugins: [ ['@babel/plugin-proposal-decorators',{legary: true}]]
}
详情请参考 Babel 的官网 https://babeljs.io/docs/en/babel-plugin-proposal-decorators
5 打包发布
5.1 为什么要打包发布
项目开发完成之后
,需要使用 webpack 对项目进行打包发布
,主要原因有以下两点:
① 开发环境下,打包生成的文件存放于内存中
,无法获取到最终打包生成的文件
② 开发环境下,打包生成的文件不会进行代码压缩和性能优化
为了让项目能够在生产环境中高性能的运行
,因此需要对项目进行打包发布。
5.2 配置 webpack 的打包发布
在package.json
文件的 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'),
// 生成的文件名 dist下js
filename: 'js/bundle.js'
},
5.4 把图片文件统一生成到 image 目录中
修改 webpack.config.js 中的url-loader
配置项,新增outputPath
选项即可指定图片文件的输出路径:
5.5 自动清理 dist 目录下的旧文件
为了在每次打包发布时自动清理掉 dist 目录中的旧文件
,可以安装并配置clean-webpack-plugin
插件:
6 Source Map
6.1 生产环境遇到的问题
前端项目在投入生产环境之前,都需要对 JavaScript 源代码进行压缩混淆
,从而减小文件的体积,提高文件的加载效率。此时就不可避免的产生了另一个问题:
对压缩混淆之后的代码除错(debug)
是一件极其困难的事情
6.2 什么是 Source Map
Source Map 就是一个信息文件,里面储存着位置信息
。也就是说,Source Map 文件中存储着压缩混淆后的代码,所对应的转换前的位置。
有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码
,能够极大的方便后期的调试。
6.3 webpack 开发环境下的 Source Map
在开发环境下
,webpack 默认启用
了 Source Map 功能。当程序运行出错时,可以直接在控制台提示错误行的位置,并定位到具体的源代码
:
6.3.1 默认 Source Map 的问题
开发环境下默认生成的 Source Map,记录的是生成后的代码的位置
。会导致运行时报错的行数
与源代码的行数不一致的问题。示意图如下:
6.3.2 解决默认 Source Map 的问题
开发环境下,推荐在 webpack.config.js 中添加如下的配置,即可保证运行时报错的行数与源代码的行数
保持一致:
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` - 好处:防止源码泄露,提高网站的安全性
6.6 实际开发中需要自己配置 webpack 吗?
答案:不需要!
- 实际开发中会使命令行工具(俗称 CLI)一键生成带有 webpack 的项目
- 开箱即用,所有 webpack 配置项都是现成的!
- 我们只需要知道 webpack 中的基本概念即可!
总结
① 能够掌握 webpack 的基本使用
- 安装、
webpack.config.js
、修改打包入口
② 了解常用的 plugin 的基本使用
webpack-dev-serve
r、html-webpack-plugin
③了解常用的 loader 的基本使用
- loader 的作用、
loader 的调用过程
④ 能够说出 Source Map 的作用
- 精准定位到
错误行
并显示对应的源码
- 方便开发者调试源码中的错误
source map 文件!
6.5 Source Map 的最佳实践
① 开发环境下:
- 建议把 devtool 的值设置为
eval-source-map
- 好处:可以精准定位到具体的错误行
② 生产环境下:
- 建议
关闭 Source Map
或将 devtool 的值设置为 ``nosources-source-map` - 好处:防止源码泄露,提高网站的安全性
6.6 实际开发中需要自己配置 webpack 吗?
答案:不需要!
- 实际开发中会使命令行工具(俗称 CLI)一键生成带有 webpack 的项目
- 开箱即用,所有 webpack 配置项都是现成的!
- 我们只需要知道 webpack 中的基本概念即可!
总结
① 能够掌握 webpack 的基本使用
- 安装、
webpack.config.js
、修改打包入口
② 了解常用的 plugin 的基本使用
webpack-dev-serve
r、html-webpack-plugin
③了解常用的 loader 的基本使用
- loader 的作用、
loader 的调用过程
④ 能够说出 Source Map 的作用
- 精准定位到
错误行
并显示对应的源码
- 方便开发者调试源码中的错误