什么是webpack
webpack可以看做是模块打包机,他做的事情是,分析你的项目结构,找到Javascript模块以及其他的有些浏览器不能直接运行的拓展语言(
sass, TypeScript等),将其打包为合适的格式以供浏览器调用
构建就是把源代码转换成发布到线上可执行的JavaScript, HTML,css,包括一下内容
- 代码转换: typescript编译成JavaScript,sass编译成css
- 文件优化: 压缩JavaScript, css,html代码,压缩合并图片
- 模块合并: 提取多个页面公共代码,提取首屏不需要执行部分带啊没让其异步加载
- 自动刷新:监听本地带啊没,自动重新构建,刷新浏览器
- 代码效验:在代码被提交到仓库钱需要校验代码是否符合规范,以及单元测试是否通过
- 自动发布:更新完代码后,自动构建出线上发布代码并传输给发布系统
构建其实就是工程化,自动化思想在前端开发中的体现,把一系列历程用代码去实现,让带代码自动化执行这一系列复杂的流程。构建给前端开发注入了更大的活力,解放了我们的生产力
初始化项目
mkdir study_webpack
cd study_webpack
npm init -y
快速上手
- webpack核心概念
Entry
: 入口,Webpack执行构建的第一步将从Entry开始,开始,可抽象成输入。Module
:模块,在 Webpack 里一切皆模块,一个模块对应着一个文件。Webpack 会从配置的 Entry 开始递归找出所有依赖的模块。Chunk
:代码块,一个 Chunk 由多个模块组合而成,用于代码合并与分割。Loader
:模块转换器,用于把模块原内容按照需求转换成新内容。Plugin
:扩展插件,在 Webpack 构建流程中的特定时机注入扩展逻辑来改变构建结果或做你想要的事情。Output
:输出结果,在 Webpack 经过一系列处理并得出最终想要的代码后输出结果。
Webpack 启动后会从Entry里配置的Module开始递归解析 Entry 依赖的所有 Module。 每找到一个 Module, 就会根据配置的Loader去找出对应的转换规则,对 Module 进行转换后,再解析出当前 Module 依赖的 Module。 这些模块会以 Entry 为单位进行分组,一个 Entry 和其所有依赖的 Module 被分到一个组也就是一个 Chunk。最后 Webpack 会把所有 Chunk 转换成文件输出。 在整个流程中 Webpack 会在恰当的时机执行 Plugin 里定义的逻辑。
- 安装webpack
npm install webpack webpack-cli -D
# 使用npx 运行当前node_modules里的包
- 创建src目录
mkdir src
- 创建dist目录
mkdir dist
- 创建配置文件(根目录文件名为webpack.config.js),并配置基本配置
- entry:配置入口文件的地址
- output:配置出口文件的地址
- module:配置模块,主要用来配置不同文件的加载器
- plugins:配置插件
- devServer:配置开发服务器
const path=require('path');
module.exports={
entry: './src/index.js',
output: {
path: path.resolve(__dirname,'dist'),
filename:'bundle.js'
},
module: {},
plugins: [],
devServer: {}
}
- 创建index.html(在dist目录下)
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="root"></div>
<script src="bundle.js"></script>
</body>
</html>
- 在package.json中添加语句
{
"scripts": {
"build" : "webpack --mode development"
}
}
- 构建
npx webpack
// 输出以下信息
Hash: 3baf23d70b5b00dd78e5
Version: webpack 4.27.1
Time: 813ms
Built at: 2018-12-10 11:33:55
Asset Size Chunks Chunk Names
bundle.js 1010 bytes 0 [emitted] main
Entrypoint main = bundle.js
[0] ./src/index.js 80 bytes {0} [built]
配置开发服务器
- 安装开发服务器
npm i webpack-dev-server –D
- 添加配置信息
// webpack.config.js中配置信息
{
devServer: {
contentBase: path.resolve(__dirname, 'dist'),
host: 'localhost',
port: 8080,
compress: true
}
}
// package.json中添加嗲用命令
{
"scripts": {
"dev": "webpack-dev-server --open --mode development "
}
}
支持加载css文件
- 什么是loader
通过使用不同的Loader,Webpack可以要把不同的文件都转成JS文件,比如CSS、ES6/7、JSX等
+ test:匹配处理文件的扩展名的正则表达式
+ use:loader名称,就是你要使用模块的名称
+ include/exclude:手动指定必须处理的文件夹或屏蔽不需要处理的文件夹
+ query:为loaders提供额外的设置选项
- loader
- cssloader
- styleloader
- 加载loader
module: { rules: [ { test: /\.css/, loader:['style-loader','css-loader'] } ] }
- use
module: { rules: [ { test: /\.css/, use:['style-loader','css-loader'] } ] },
- 加载和使用
module: { rules: [ { test: /\.css/, include: path.resolve(__dirname,'src'), exclude: /node_modules/, use: [{ loader: 'style-loader', options: { insertAt:'top' } },'css-loader'] } ] }
插件
- 在 webpack 的构建流程中,plugin 用于处理更多其他的一些构建任务
- 模块代码转换的工作由 loader 来处理
- 除此之外的其他任何工作都可以交由 plugin 来完成
自动产出html文件插件html-webpack-plugin
- 安装插件
npm i html-webpack-plugin -D
- 插件使用
- minify 是对html文件进行压缩,removeAttrubuteQuotes是去掉属性的双引号
- hash 引入产出资源的时候加上查询参数,值为哈希避免缓存
- template 模版路径
plugins: [
new HtmlWebpackPlugin({
minify: {
removeAttributeQuotes:true
},
hash: true,
template: './src/index.html',
filename:'index.html'
})]
支持图片
- 安装插件
- file-loader 解决CSS等文件中的引入图片路径问题
- url-loader 当图片小于limit的时候会把图片BASE64编码,大于limit参数的时候还是使用file-loader 进行拷贝
npm i file-loader url-loader -D
- webpack.config.js配置
{
test:/\.(jpg|png|bmp|gif|svg|ttf|woff|woff2|eot)/,
use:[
{
loader:'url-loader',
options:{limit:4096}
}
]
}
- js中引用图片
let logo=require('./images/logo.png');
let img=new Image();
img.src=logo;
document.body.appendChild(img);
- css中引用图片
.logo{
width:355px;
height:133px;
background-image: url(./images/logo.png);
background-size: cover;
}
分离css
因为CSS的下载和JS可以并行,当一个HTML文件很大的时候,我们可以把CSS单独提取出来加载
- mini-css-extract-plugin
- filename打包入口文件
- chunkFilename用来打包
import(module)
方法中引入的模块 - 安装依赖模块
npm install --save-dev mini-css-extract-plugin
- 配置webpack.config.js
plugins: [
//参数类似于webpackOptions.output
+ new MiniCssExtractPlugin({
+ filename: '[name].css',
+ chunkFilename:'[id].css'
+ }),
{
test: /\.css/,
include: path.resolve(__dirname,'src'),
exclude: /node_modules/,
use: [{
+ loader: MiniCssExtractPlugin.loader
},'css-loader']
}
- 使用
extract-text-webpack-plugin
抽离css
压缩js和css
- 安装模块
npm i uglifyjs-webpack-plugin optimize-css-assets-webpack-plugin -D
- 配置webpack.config.js
const UglifyJsPlugin = require("uglifyjs-webpack-plugin");
const OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin");
module.exports = {
mode: 'development',
optimization: {
minimizer: [
new UglifyJsPlugin({
cache: true,//启动缓存
parallel: true,//启动并行压缩
//如果为true的话,可以获得sourcemap
sourceMap: true // set to true if you want JS source maps
}),
//压缩css资源的
new OptimizeCSSAssetsPlugin({})
]
},
自定义css和image目录
- outputPath 输出路径
- publicPath指定的是构建后在html里的路径
output: {
path: path.resolve(__dirname,'dist'),
filename: 'bundle.js',
+ publicPath:'/'
},
{
test:/\.(jpg|jpeg|png|bmp|gif|svg|ttf|woff|woff2|eot)/,
use:[
{
loader:'url-loader',
options:{
limit: 4096,
+ outputPath: 'images',
+ publicPath:'/images'
}
}
]
}
plugins: [
new MiniCssExtractPlugin({
+ filename: 'css/[name].css',
+ chunkFilename:'css/[id].css'
}),
抽离公共css
- 安装模块
extract-text-webpack-plugin
- 使用
const ExtractTextWebpackPlugin = require('ExtractTextWebpackPlugin')
let cssExtract = new ExtractTextWebpackPlugin('css/css.css')
{
module: {
rules: [
{
test: /\.css$/,
loader: ExtractTextWebpackPlugin.extract({
use: [ 'css-loader', 'less-loader' ],
fallback: 'style-loader' // 在这里配置使用style-loader
})
}
]
},
plugins: [
cssExtract,
],
}
html中使用图片
- 安装模块
npm i html-withimg-loader -D
- 配置webpack.config.js
{
+ test: /\.(html|htm)$/,
+ use: 'html-withimg-loader'
}
编译less和sass
- 安装模块
npm i less less-loader -D
npm i node-sass sass-loader -D
- webpack.config.js配置
{
test: /\.less/,
include: path.resolve(__dirname,'src'),
exclude: /node_modules/,
use: [{
loader: MiniCssExtractPlugin.loader,
},'css-loader','less-loader']
},
{
test: /\.scss/,
include: path.resolve(__dirname,'src'),
exclude: /node_modules/,
use: [{
loader: MiniCssExtractPlugin.loader,
},'css-loader','sass-loader']
}
- 写样式文件测试
- 新建index.sass
$color:green; .sass-container{ color:green; }
- 新建index.less
@color:orange; .less-container{ color:@color; }
处理css3属性前缀
为了浏览器的兼容性,有时候我们必须加入-webkit,-ms,-o,-moz这些前缀
- Trident内核:主要代表为IE浏览器, 前缀为-ms
- Gecko内核:主要代表为Firefox, 前缀为-moz
- Presto内核:主要代表为Opera, 前缀为-o
- Webkit内核:产要代表为Chrome和Safari, 前缀为-webkit
- 安装postcss-loader模块
npm i postcss-loader autoprefixer -D
- 更目录新建postcss.config.js
module.exports={
plugins:[require('autoprefixer')]
}
- 添加webpack.config.js配置
{
test:/\.css$/,
use:[MiniCssExtractPlugin.loader,'css-loader','postcss-loader'],
include:path.join(__dirname,'./src'),
exclude:/node_modules/
}
打包第三方类库
- 直接引入
import _ from 'lodash';
alert(_.join(['a','b','c'],'@'));
- 插件引入
_ 函数会自动添加到当前模块的上下文,无需显示声明
+ new webpack.ProvidePlugin({
+ _:'lodash'
+ })
// 没有全局的$函数,所以导入依赖全局变量的插件依旧会失败
- expose-loader
不需要任何其他的插件配合,只要将下面的代码添加到所有的loader之前
require("expose-loader?libraryName!./file.js");
{
test: require.resolve("jquery"),
loader: "expose-loader?jQuery"
}
require("expose-loader?$!jquery");
- externals
如果我们想引用一个库,但是又不想让webpack打包,并且又不影响我们在程序中以CMD、AMD或者window/global全局等方式进行使用,那就可以通过配置externals
const jQuery = require("jquery");
import jQuery from 'jquery';
+ 添加配置
```
+ externals: {
+ jquery: 'jQuery'//如果要在浏览器中运行,那么不用添加什么前缀,默认设置就是global
+ },
```
babel runtime
- babel 在每个文件都插入了辅助代码,使代码体积过大
- babel 对一些公共方法使用了非常小的辅助代码,比如 _extend
- 默认情况下会被添加到每一个需要它的文件中。你可以引入 @babel/runtime 作为一个独立模块,来避免重复引入
- babel-plugin-transform-runtime
npm install --save-dev @babel/plugin-transform-runtime
npm install --save @babel/runtime
- .babelrc
{
"presets": ["@babel/preset-env"],
"plugins": [
[
"@babel/plugin-transform-runtime",
{
"corejs": false,
"helpers": true,
"regenerator": true,
"useESModules": true
}
]
]
}
webpack打包的时候,会自动优化重复引入公共方法的问题
ESLint校验代码格式规范
-
ESlint 语法检测配置说明
npm install eslint eslint-loader babel-eslint --D
.eslintrc.js
module.exports = {
root: true,
//指定解析器选项
parserOptions: {
sourceType: 'module'
},
//指定脚本的运行环境
env: {
browser: true,
},
// 启用的规则及其各自的错误级别
rules: {
"indent": ["error", 4],//缩进风格
"quotes": ["error", "double"],//引号类型
"semi": ["error", "always"],//关闭语句强制分号结尾
"no-console": "error",//禁止使用console
"arrow-parens": 0 //箭头函数用小括号括起来
}
}
module: {
//配置加载规则
rules: [
{
test: /\.js$/,
loader: 'eslint-loader',
enforce: "pre",
include: [path.resolve(__dirname, 'src')], // 指定检查的目录
options: { fix: true } // 这里的配置项参数将会被传递到 eslint 的 CLIEngine
}
]
}
如何调试打包后的代码
webpack通过配置可以自动给我们source maps
文件,map
文件是一种对应编译文件和源文件的方法
- source-map 把映射文件生成到单独的文件,最完整最慢
- cheap-module-source-map 在一个单独的文件中产生一个不带列映射的Map
- eval-source-map 使用eval打包源文件模块,在同一个文件中生成完整sourcemap
- cheap-module-eval-source-map sourcemap和打包后的JS同行显示,没有映射列
devtool:'eval-source-map'
watch
当代码发生修改后可以自动重新编译, 直接在webpack.config.js添加参数
watch: true,
watchOptions: {
ignored: /node_modules/, //忽略不用监听变更的目录
poll:1000, //每秒询问的文件变更的次数
aggregateTimeout: 500, //防止重复保存频繁重新编译,500毫秒内重复保存不打包
}
- webpack定时获取文件的更新时间,并跟上次保存的时间进行比对,不一致就表示发生了变化,poll就用来配置每秒问多少次
- 当检测文件不再发生变化,会先缓存起来,等待一段时间后之后再通知监听者,这个等待时间通过aggregateTimeout配置
- webpack只会监听entry依赖的文件
我们需要尽可能减少需要监听的文件数量和检查频率,当然频率的降低会导致灵敏度下降
添加商标
new webpack.BannerPlugin('test')
拷贝静态文件
有时项目中没有引用的文件也需要打包到目标目录
- 安装模块
npm i copy-webpack-plugin -D
- 使用插件
new CopyWebpackPlugin([{
from: path.resolve(__dirname,'src/assets'),//静态资源目录源地址
to:path.resolve(__dirname,'dist/assets') //目标地址,相对于output的path目录
}])
打包前清空输出目录
- 安装模块
npm i clean-webpack-plugin -D
- 使用插件
new CleanWebpackPlugin([path.resolve(__dirname,'dist')])
服务器代理
- 如果你有单独的后端开发服务器 API,并且希望在同域名下发送 API 请求 ,那么代理某些 URL 会很有用。
- 不修改路径
// 请求到 /api/users 现在会被代理到请求 http://localhost:3000/api/users。
{
devServer: {
proxy: {
"/api": 'http://localhost:3000'
}
}
}
- 修改路经
{
devServer: {
proxy: {
"/api": {
target: 'http://localhost:3000',
pathRewrite:{"^/api":""}
}
}
}
}
- before after
before 在 webpack-dev-server 静态资源中间件处理之前,可以用于拦截部分请求返回特定内容,或者实现简单的数据 mock。
{
devServer: {
before(app){
app.get('/api/users', function(req, res) {
res.json([{id:1,name:'zfpx1'}])
})
}
}
}
- webpack-dev-middleware
- webpack-dev-middleware就是在 Express 中提供 webpack-dev-server 静态服务能力的一个中间件
- 安装模块
npm install webpack-dev-middleware --save-dev
- 使用模块
const express = require('express'); const app = express(); const webpack = require('webpack'); const webpackDevMiddleware = require('webpack-dev-middleware'); const webpackOptions = require('./webpack.config'); webpackOptions.mode = 'development'; const compiler = webpack(webpackOptions); app.use(webpackDevMiddleware(compiler, {})); app.listen(3000);
- webpack-dev-server 的好处是相对简单,直接安装依赖后执行命令即可
- 而使用webpack-dev-middleware的好处是可以在既有的 Express 代码基础上快速添加 webpack-dev-server 的功能,同时利用 Express 来根据需要添加更多的功能,如 mock 服务、代理 API 请求等
resolve解析
- extensions
指定extension之后可以不用在require或是import的时候加文件扩展名,会依次尝试添加扩展名进行匹配
resolve: {
extensions: [".js",".jsx",".json",".css"]
},
- alias
配置别名可以加快webpack查找模块的速度
- 配置使用
const bootstrap = path.resolve(__dirname,'node_modules/_bootstrap@3.3.7@bootstrap/dist/css/bootstrap.css');
resolve: {
+ alias:{
+ "bootstrap":bootstrap
+ }
}
- modules
- 对于直接声明依赖名的模块(如 react ),webpack 会类似 Node.js 一样进行路径搜索,搜索node_modules目录
- 这个目录就是使用resolve.modules字段进行配置的 默认配置
- 我们在需要加载node_modules目录之外的库时也在这里配置
resolve: {
modules: ['node_modules', './lib', './public'],
}
// 如果可以确定项目内所有的第三方依赖模块都是在项目根目录下的 node_modules 中的话
resolve: {
modules: [path.resolve(__dirname, 'node_modules')],
}
- mainFields
默认情况下package.json 文件则按照文件中 main 字段的文件名来查找文件
resolve: {
// 配置 target === "web" 或者 target === "webworker" 时 mainFields 默认值是:
mainFields: ['browser', 'module', 'main'],
// target 的值为其他时,mainFields 默认值为:
mainFields: ["module", "main"],
}
- mainFiles
当目录下没有 package.json 文件时,我们说会默认使用目录下的 index.js 这个文件,其实这个也是可以配置的
resolve: {
mainFiles: ['index'], // 你可以添加其他默认使用的文件名
}
- resolveLoader
resolve.resolveLoader用于配置解析 loader 时的 resolve 配置,默认的配置:
module.exports = {
resolveLoader: {
modules: [ 'node_modules' ],
extensions: [ '.js', '.json' ],
mainFields: [ 'loader', 'main' ]
}
};
多入口
有时候我们的页面可以不止一个HTML页面,会有多个页面,所以就需要多入口
const path=require('path');
const HtmlWebpackPlugin=require('html-webpack-plugin');
module.exports={
entry: {
index: './src/index.js',
login: './src/login.js'
},
output: {
path: path.resolve(__dirname, 'dist'),
filename: '[name].[hash].js',
publicPath: '/'
},
plugins: [
new HtmlWebpackPlugin({
minify: {
removeAttributeQuotes: true
},
hash: true,
template: './src/index.html',
chunks: ['index'],
filename: 'index.html'
}),
new HtmlWebpackPlugin({
minify: {
removeAttributeQuotes: true
},
hash: true,
chunks: ['login'],
template: './src/login.html',
filename: 'login.html'
})
],
}
对图片进行压缩和优化
image-webpack-loader可以帮助我们对图片进行压缩和优化
- 安装模块
npm install image-webpack-loader --save-dev
- 配置使用
{
test: /\.(png|svg|jpg|gif|jpeg|ico)$/,
use: [
'file-loader',
{
loader: 'image-webpack-loader',
options: {
mozjpeg: {
progressive: true,
quality: 65
},
optipng: {
enabled: false,
},
pngquant: {
quality: '65-90',
speed: 4
},
gifsicle: {
interlaced: false,
},
webp: {
quality: 75
}
}
},
]
}
noParse
module.noParse
字段,可以用于配置哪些模块文件的内容不需要进行解析- 不需要解析依赖(即无依赖) 的第三方大型类库等,可以通过这个字段来配置,以提高整体的构建速度
- 配置
{
module: {
noParse: /jquery|lodash/, // 正则表达式
// 或者使用函数
noParse(content) {
return /jquery|lodash/.test(content)
},
}
}
// 使用 noParse 进行忽略的模块文件中不能使用 import、require、define 等导入机制
DefinePlugin
DefinePlugin创建一些在编译时可以配置的全局常量
{
plugins: {
new webpack.DefinePlugin({
PRODUCTION: JSON.stringify(true),
VERSION: "1",
EXPRESSION: "1+2",
COPYRIGHT: {
AUTHOR: JSON.stringify("leo")
}
})
}
}
- 如果配置的值是字符串,那么整个字符串会被当成代码片段来执行,其结果作为最终变量的值
- 如果配置的值不是字符串,也不是一个对象字面量,那么该值会被转为一个字符串,如 true,最后的结果是 ‘true’
- 如果配置的是一个对象字面量,那么该对象的所有 key 会以同样的方式去定义
- JSON.stringify(true) 的结果是 ‘true’
IgnorePlugin
IgnorePlugin用于忽略某些特定的模块,让 webpack 不把这些指定的模块打包进去
import moment from 'moment';
console.log(moment);
- 配置使用
webpack.IgnorePlugin(path, dirname)
- 第一个是匹配引入模块路径的正则表达式
- 第二个是匹配模块的对应上下文,即所在目录名
{
plugins: {
new webpack.IgnorePlugin(/^\.\/locale/,/moment$/)
}
}
区分环境变量
- 日常的前端开发工作中,一般都会有两套构建环境
- 一套开发时使用,构建结果用于本地开发调试,不进行代码压缩,打印 debug 信息,包含 sourcemap 文件
- 一套构建后的结果是直接应用于线上的,即代码都是压缩后,运行时不打印 debug 信息,静态文件不包括 sourcemap
- webpack 4.x 版本引入了 mode 的概念
- 当你指定使用 production mode 时,默认会启用各种性能优化的功能,包括构建结果优化以及 webpack 运行性能优化
- 而如果是 development mode 的话,则会开启 debug 工具,运行时打印详细的错误信息,以及更加快速的增量编译构建
环境差异 - 生产环境
- 可能需要分离 CSS 成单独的文件,以便多个页面共享同一个 CSS 文件
- 需要压缩 HTML/CSS/JS 代码
- 需要压缩图片
- 开发环境
- 需要生成 sourcemap 文件
- 需要打印 debug 信息
- 需要 live reload 或者 hot reload 的功能…
- 获取mode参数
npm install --save-dev optimize-css-assets-webpack-plugin
const UglifyJSPlugin = require('webpack/lib/optimize/UglifyJsPlugin');
const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin');
module.exports=(env,argv) => ({
optimization: {
minimizer: argv.mode == 'production'?[
new UglifyJSplugin({
cache: true,//启用缓存
parallel: true,// 使用多进程运行改进编译速度
sourceMap:true//生成sourceMap映射文件
}),
new OptimizeCssAssetsWebpackPlugin({})
]:[]
}
})
转义ES6/ES7/JSX
- Babel其实是一个编译JavaScript的平台,可以把ES6/ES7,React的JSX转义为ES5
- babel-plugin-proposal-decorators
- 安装依赖
npm install -D babel-loader@7 babel-core babel-preset-env
npm i @babel/plugin-proposal-decorators @babel/plugin-proposal-class-properties -D
-
配置参数
- env 解析es6
- tgage-0 解析es7
- react 解析react
module: { rules: [ { test: /\.jsx?$/, use: { loader: 'babel-loader' }, include: resolve(__dirname,'src'), exclude:/node_modules/ } ] },
- 根目录添加.bablerc文件,里边配置参数
{ "presets": [ "env", "stage-0", "react" ] }