webpack

Adrian Yang

Adrian Yang

Front End Engineer

构建工具

构建: 将源代码,经过编译压缩,语法检查,兼容性处理,生成浏览器可以高效,稳定运行的代码

Webpack

什么是webpack

  • webpack 是一个模块打包器(bundler)
  • 在webpack 看来,前端所有的静态文件(js/json/css/img/less..) 都会被视作模块来处理
  • 它将根据模块的以来关系进行静态分析,生成对应的静态资源

对webpack 的看法

使用webpack的主要目的就是为了简化项目依赖的管理,它将所有资源看成是一个模块,将所有逻辑代码看成是一个整体,从打包入口着手,将项目所需的依赖通过loader和plugin进行处理,然后输出一个能通过浏览器解析的js代码。webpack主要有四个核心的概念,分别是entry、output、loader和plugin。

与gulp 的区别: gulp 不强调模块化

webpack是写好配置文件,然后webpack自己按照配置文件来执行前端构建流程,而gulp是直接自己写流程

五个核心概念

  • Entry: 入口起点(entry point) 指示webpack应该使用哪个模块, 来作为构建其内部依赖图的开始
  • Output: output 属性告诉 webpack 在哪里输出它创建的 bundles, 以及如何命名这些文件 默认值为 ./dist
  • Loader: loader 让 webpack 能够处理那些非JavaScript文件 (webpack 本身只能解析JavaScript / jason)
  • Plugins: 插件则可以用于执行范围更广的任务, 插件的范围包括: 从打包 优化 压缩 一直到重新定义环境中的变量等.
  • Mode: 模式, 有生产模式production () 和 开发模式 development

理解 Loader

  • webpack 本身只能加载JS / JSON 模块, 如果要加载其他类型的文件(模块), 就需要使用对应的loader 进行转换 / 加载
  • Loader 本身也是运行在node.js 环境中的 JavaScript模块
  • 它本身是一个函数,接受源文件作为参数, 返回转换的结果
  • Loader 一般以 xxx-loader 的方式命名, xxx 代表这个loader的转换功能(json-loader)

理解Plugins

  • 插件可以完成一些loader 不能完成的功能
  • 插件的使用一般是在 webpack 的配置信息 plugins 选项中指定

运行指令

$: npm install webpack webpack -g
$: npm install webpack webpack-cli -g
$: npm install webpack webpack-cli -D
$: webpack src/js/app.js -o /dist/js/app.js --mode development
// 打包JS 和 JSON 文件 并且能将es6 的模块化语法 转换成 浏览器能够识别的语法

结论

  • webpack 可以打包js 和 json 文件
  • 能将es6 的模块化语法转换成浏览器能够识别的语法
  • 能够压缩代码

缺点

  • 不能编译打包 css img 等文件
  • 不能将js 的es6 语法转成为 es5 一下的语法
  • (改善) -> 使用webpack 配置文件解决, 自定义功能

打包less

  • 概述: less 文件 wenpack 不能解析 需要借助loader
  • 安装loader

运行指令

npm install css-loader style-loader less-loader less -D
$: webpack

配置loader

  • 所有的loader 都要在module 对象的rules 属性中
  • rules 是一个数组 数组中每一个对象就是一个loader
  • loader 的特点: 下载后无需引入,只需声明
moudle: {
reules:[
{
test: /\.less$/, //匹配所有less文件
use:[
'style-loader', //用于html文档中创建一个style标签,将样式加入
'css-loader', //将less 编译后的css转换成CommonJs 的一个模块
'less-loader' //将less 编译为css, 但不生成单独的css文件,在内存中
]
}
]
}

JS 语法检查

  • 概述: 对于js基本语法错误/隐患, 进行提前检查
  • 安装 loader
npm install eslint-loader eslint -D

备注

{
test:/\.js$/,
exclude:'node_modules',
enforce:'pre',// 提前加载使用
use:{
loader:"eslint-loader", //使用eslint-loader 解析
}
}

Js 语法转换

  • 概述: 将浏览器不能识别的新语法转换成原来识别的旧语法,做浏览器兼容性处理
  • 安装loader
npm install babel-loader @babel/core @babel/preset-env -D

配置loader

{
test:/\.js$/,
exclude:'node_modules',
enforce:'pre',// 提前加载使用
use:{
loader:"babek-loader",
options:{
presets:['@babel/preset-env']
}
}
}

Js 兼容性处理

方法一: 使用经典的polyfill

npm install @babel/polyfill
// 包含ES6 的高级语法转换 不管编码人员用了哪些新语法,全部的新语法都进行转换 -> 400+ kb

index.js 中引入

import '@babel/polyufill'
  • 优点: 解决babel 只能转换部分低级语法的问题 (如 let const 结构赋值) 引入polyfill 可以转换高级语法 (如Promise)
  • 缺点: 将所有的高级语法都进行了转换, 但实际上可能只使用了一部分
  • 解决: 需要按需加载, 使用了什么高级语法 就转换什么, 其余的就不需要转换

方法二: 按需引入借助 core-js

npm install core-js
//js语法转换+兼容性处理(es6->es5)
{
test: /\.js$/, //只检测js文件
exclude: /node_modules/,
use: {
loader: "babel-loader",
options: {
presets: [
['@babel/preset-env', {
useBuiltIns: 'usage', // 按需引入需要使用polyfill
corejs: { version: 3 }, // 解决不能够找到core-js的问题!!!
targets: { // 指定兼容性处理哪些浏览器
"chrome": "58",
"ie": "9"
}}]
],
cacheDirectory: true, // 开启babel缓存
}
}
},

打包样式文件中的图片资源

  • 概述 图片文件webpack 不能解析, 需要借助loader 解析
npm install file-loader url-loader -D

补充: url-loader 是对 file-loader 的上层封装 需要使用时配合 file-loader 使用

//使用url-loader处理样式文件中的图片
{
test: /\.(png|jpg|gif)$/,
use: [
{
loader: 'url-loader',
options: {
limit: 8192,//// 8kb --> 8kb以下的图片会base64处理
publicPath: 'images/', // 决定图片的url路径
outputPath: 'images', // 决定文件本地输出路径
name: '[hash:5].[ext]' // 修改文件名称 [hash:8] hash值取8位 [ext] 文件扩展名
},
},
],
},

打包html 文件

  • 概述 html 文件 webpack 不能解析, 需要借助插件编译解析
  • 安装插件 Plugins
npm install html-webpack-plugin -D

配置插件Plugins

const HtmlWebpackPlugin = require('html-webpack-plugin');
//配置插件
plugins:[
new HtmlWebpackPlugin({
template: './src/index.html', // 以当前文件为模板创建新的HtML(1. 结构和原来一样 2. 会自动引入打包的资源)
})
],

打包html 中图片资源

  • 概述: html 中的图片url-loader 无法处理, 它只能处理js 中引入的图片 / 样式中的图片. 不能处理HTML 中img标签, 我们需要html-loader 处理
  • 安装loader
npm install html-loader -D

配置loader

//使用html-loader处理html中的标签资源
{
test: /\.(html)$/,
use: {
loader: 'html-loader'
}
},

打包其他资源

配置loader

//使用file-loader处理其他资源
{
test: /\.(eot|svg|woff|woff2|ttf|mp3|mp4|avi)$/, // 处理其他资源
loader: 'file-loader',
options: {
outputPath: 'media',
name: '[hash:5].[ext]'
}
}
]
},

自动编译打包运行 (live reload)

安装loader

npm install webpack-dev-server -D

修改webpack 配置对象 (注意 不是在loader中)

//配置自动化编译
devServer: {
open: true, // 自动打开浏览器
compress: true, // 启动gzip压缩
port: 3000, // 端口号
hot:true //开启热模替换功能 HMR
},
//配置devtool实现源文件映射
devtool:'cheap-module-eval-source-map'
}
  • 修改url-loader 部分配置

    • 因为构建工具以build 为根目录. 不用再找build了
    • publichPath: "../build/images" -> 'images/'
  • 修改package.json 中script 的指令

    • "start": "webpack-dev-server"
  • 运行指令: npm start

HMR 热模替换

  • 概述 是webpack 最有用的功能之一, 它允许在运行时更新所有类型的模块.而且无需完全刷新 (只更新变化的模块,不变的模块不更新)

修改 devServer 配置

hot:true //开启热模替换功能 HMR

问题: HTML 文件无法自动更新了, 需要增加一个入口

entry:['./src/js/index.js','./src/index.html'], //入口

devTool

  • 概述 一种将压缩/编译文件中的代码映射到源源文件原始位置的技术, 让我调试代码不再困难
  • 介绍
    • cheap 只保留行 编译速度快
    • eval webpack 生成的代码(每个模块彼此分开,并使用模块名称进行注释), 编译速度快
    • inline 以Base64 方式将 source-map 嵌入到代码中. 缺点: 造成编译过后 代码很大
  • 推荐使用:
    • 开发环境: cheap-module-eval-source-map
    • 生产环境: cheap-module-source-map

以上为webpack 开发环境的配置, 可以在内存中自动打包所有类型的文件, 并自动编译运行, 具有热更新功能

准备生产环境

  • 创建文件夹 config 将 webpack.config.js 复制两份
    • ./config/webpack.dev.js
    • ./config/webpack.prod.js
  • 修改 webpack.prod.js 的配置 删除 webpack-dev-server 配置
output: {
path: resolve(__dirname, '../dist'), //输出路径
filename: './js/index.js', //输出的文件名
publicPath: '/'// 所有输出资源在引入时的公共路径
},
//工作模式
mode: 'production', //配置工作模式
//配置devtool实现源文件映射
devtool:'cheap-module-source-map'

注意: 生产环境嗲买需要部署到服务器上才能运行 (serve 这个库能帮助我们快速搭建一个静态资源服务器)

清除打包文件目录

  • 概述 每次打包生成的文件,都需要手动删除, 引入插件帮助我们自动删除上一次的文件
  • 安装插件
npm isntall clean-webpack-plugin --save-dev
  • 引入插件
    • const {CleanWebpackPlugin} = require('clean-webpack-plugin'); // 注意要解构赋值
  • 配置插件
    • new CleanWebpackPlugin() //自动清除 output.path 目录下的文件

提取css 成单独文件

  • 安装插件
    • npm install mini-css-extract-plugin --save-dev
  • 引入插件
    • const MiniCssExtractPlugin = require("mini-css-extract-plugin");
{
test: /\.less$/, //匹配所有的less文件
use: [
MiniCssExtractPlugin.loader,
'css-loader', //将less编译后的css转换成为CommonJs的一个模块。
{
loader: 'postcss-loader',
options: {
ident: 'postcss',
plugins: () => [
require('postcss-flexbugs-fixes'),
require('postcss-preset-env')({
autoprefixer: {
flexbox: 'no-2009',
},
stage: 3,
}),
require('postcss-normalize')(),
],
sourceMap: true,
},
},
'less-loader' //将less编译为css,但不生成单独的css文件,在内存中。
],
},
new MiniCssExtractPlugin({
filename: "css/[hash:5].css",
}),

添加css 兼容

  • 安装 loader
npm install postcss-loader postcss-felxbugs-fixes postcss-preset-env postcss-normalize autoprefixer --save-dev
扩展前缀
{
loader: 'postcss-loader',
options: {
ident: 'postcss',
plugins: () => [
require('postcss-flexbugs-fixes'),
require('postcss-preset-env')({
autoprefixer: {
flexbox: 'no-2009',
},
stage: 3,
}),
require('postcss-normalize')(),
],
sourceMap: true,
},
},

browserlistrc

# Browsers that we support
last 1 version
> 1%
IE 10 # sorry

压缩css

  • 安装插件
npm isntall optimize-css-assets-webpack-plugin --save-dev
  • 引入插件
const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');

配置

new OptimizeCssAssetsPlugin(
{
cssProcessorPluginOptions: {
preset: ['default', { discardComments: { removeAll: true } }],
},
cssProcessorOptions: { // 解决没有source map问题
map: {
inline: false,
annotation: true,
}
}
}
)

压缩html

  • 修改插件配置
new HtmlWebpackPlugin({
template: './src/index.html', // 以当前文件为模板创建新的HtML(1. 结构和原来一样 2. 会自动引入打包的资源
minify: {
removeComments: true, //移除注释
collapseWhitespace: true, //折叠所有留百
removeRedundantAttributes: true, //移除无用的标签
useShortDoctype: true,//使用短的文档声明
removeEmptyAttributes: true,//移除空标签
removeStyleLinkTypeAttributes: true,//移除rel="stylesheet"
keepClosingSlash: true,//自结束
minifyJS: true,
minifyCSS: true,
minifyURLs: true,
}
}),

压缩js

webpack 3.0+ uglyfly-js

以上为 webpack 生产环境的配置, 可以生成打包之后的文件.

有哪些方式可以减少webpack的打包时间?

  • 优化loader 的文件搜索范围
  • HappyPack 开启多线程打包 将loader 的同步执行转换成并行
  • DullPlugin: 将特定的类库提前打包后引入

有哪些方式可以让webpack打出来的包更小?

  • Tree Shaking 移除JS 中未引用代码 (dead-code)
  • Scope Hoisting 分析模块之间的依赖关系, 尽可能将打包出来的模块合并到一个函数中