1. webpack安装
注意: 请先自行安装nodejs
最新版的环境
- 全局安装webpack
npm i webpack webpack-cli -g
- 项目中安装 webpack(推荐)
npm i webpack webpack-cli -D
2. webpack的使用
2.1. webpack-cli
npm 5.2 以上的版本中提供了一个npx
命令
npx 想要解决的主要问题, 就是调用项目内部安装的模块, 原理就是在node_modules
下的.bin
目录中找到对应的命令执行
使用webpack命令: npx webpack
webpack4.0 之后可以实现 0配置打包构建( 默认将src下的index.js打包到dist文件夹下的main.js中), 0配置的特点就是限制较多, 无法自定义很多配置
开发中常用的还是使用webpack配置进行打包构建
2.2. webpack配置
webpack有四大核心概念:
- 入口(entry): 程序的 入口js
- 输出(output): 打包后存放的位置
- loader: 用于对模块的源代码进行转换
- 插件(plugins): 插件目的在于解决 loader 无法实现的其他事
- 配置 webpack.config.js 文件
- 运行
npx webpack
const path = require('path')
module.exports = {
// 入口文件配置
entry: './src/index.js',
// 出口文件配置项
output: {
// 输出的路径,webpack2起就规定必须是绝对路径
// path.resolve() : 解析当前相对路径的绝对路径
// path: path.resolve('./dist/'),
// path: path.resolve(__dirname, './dist/'),
path: path.join(__dirname, 'dist'),
// 输出文件名字
filename: 'bundle.js'
},
// 默认为production, 可以手动设置为development, 区别就是是否进行压缩混淆
mode: 'development'
}
将npx webpack
命令配置到package.json
的脚本中
打包的时候可以通过--config
加文件名来指定此次打包要遵循的配置文件,如:
npm webpack --config webpack.custom.config.js
我们可以将这些复杂的指令配置到 package.json 的 scripts命令中
- 配置
package.json
- 运行对应的指令, 如:
npm run build
{
"name": "webpack-basic",
"version": "1.0.0",
"main": "index.js",
"scripts": {
"build": "webpack"
},
"devDependencies": {
"webpack": "^4.41.1",
"webpack-cli": "^3.3.9"
}
}
2.3. 开发时自动编译工具
每次要编译代码时, 手动运行 npm run build
可能会很麻烦
webpack 中有几个不同的选项, 可以帮助你在代码发生变化后自动编译代码:
- webpack’s Watch Mode
- webpack-dev-server
- webpack-dev-middleware
多数场景中, 可能需要使用webpack-dev-server
, 但是不妨探讨一下以上的所有选项
2.3.1 watch
在webpack
指令后面加上--watch
参数即可
主要的作用就是监视本地项目文件的变化, 发现有修改的代码会自动编译打包, 生成输出文件
- 配置
package.json
的 scripts"watch": "webpack --watch"
- 运行
npm run watch
以上是 cli 的方式设置 watch 的参数
还可以通过配置文件对 watch 的参数进行修改:
const path = require('path')
// webpack的配置文件遵循着CommonJS规范
module.exports = {
entry: './src/main.js',
output: {
// path.resolve() : 解析当前相对路径的绝对路径
// path: path.resolve('./dist/'),
// path: path.resolve(__dirname, './dist/'),
path: path.join(__dirname, './dist/'),
filename: 'bundle.js'
},
mode: 'development',
watch: true
}
2.3.2 webpack-dev-server
- 安装
devServer
:
devServer
需要依赖webpack
, 必须在项目依赖中安装webpack
npm i webpack-dev-server webpack -D
- index.html 中修改
<script scr="/bundle.js"></script>
webpack-dev-server 会在内存中帮我们生成一个bundle.js - 运行:
npx webpack-dev-server
- 运行:
npx webpack-dev-server --hot --open --port 8090
- 配置
package.json
的 scripts:"dev":"webpack-dev-server --hot --open --port 8090"
--contentBase 路径名
设置根路径
--open
编译完成自动打开
--port 端口号
设置端口号
--hot
热模块更新 每次修改完成之后只会把当前更新的内容作为补丁的形式替换上去
--compress
开启bundle.js的 Gzip压缩 - 运行
npm run dev
devServer 会在内存中生成一个打包好的bundle.js
, 开发时使用, 打包效率高, 修改代码后会自动重新打包以及刷新浏览器, 用户体验非常好
以上是 cli 的方式设置 devServer 的参数
还可以通过配置文件对 devServer 的参数进行修改:
- 修改
webpack.config.js
const path = require('path')
module.exports = {
// 入口文件配置
entry: './src/index.js',
// 出口文件配置项
output: {
// 输出的路径,webpack2起就规定必须是绝对路径
path: path.join(__dirname, 'dist'),
// 输出文件名字
filename: 'bundle.js'
},
devServer: {
port: 8090,
open: true,
hot: true
},
mode: 'development'
}
- 修改
package.json
的scripts
:"dev":"webpack-dev-server"
- 运行
npm run dev
2.3.3. html插件
- 安装 html-webpack-plugin 插件
npm i html-webpack-plugin -D
- 在
webpack.config.js
中的plugins
节点下配置
const HtmlWebpackPlugin = require('html-webpack-plugin')
plugins: [
new HtmlWebpackPlugin({
filename: 'index.html',
template: 'template.html'
})
]
- devServer时根据模板在 express 项目根目录下生成 html 文件 (类似于devServer生成内存中的 bundle.js)
- devServer时自动引入 bundle.js
- 打包时会自动生成 index.html
2.3.4. webpack-dev-middleware
webpack-dev-middleware
是一个容器(wrapper), 它可以把 webpack 处理后的文件传递给一个服务器(server).
webpack-dev-server
在内部使用了它, 同时, 它也可以作为一个单独的包来使用, 以便进行更多自定义设置来实现更多的需求.
- 安装
express
和webpack-dev-middleware
npm i express webpack-dev-middleware -D
- 新建
server.js
const express = require('express');
const webpack = require('webpack');
const webpackDevMiddleware = require('webpack-dev-middleware');
const config = require('./webpack.config.js');
const app = express();
const compiler = webpack(config);
app.use(webpackDevMiddleware(compiler, {
publicPath: '/'
}));
app.listen(3000, function () {
console.log('http://localhost:3000');
});
- 配置
package.json
中的 scripts:"server":"node server.js"
- 运行:
npm run server
注意啊: 如果要使用middleware, 必须使用 html-webpack-plugin
插件, 否则 html 文件无法正确的输出到 express 服务器的根目录
2.3.5. 小结
只有在开发时才需要使用自动编译工具, 例如: webpack-dev-server
项目上线时都会直接使用 webpack 进行打包构建, 不需要使用这些自动编译工具
编译工具只是为了提高开发体验
2.4. 处理css
- 安装
npm i css-loader style-loader -D
- 配置
webpack.config.js
module: {
rules: [
// 配置的是用来解析.css文件的loader(style-loader和css-loader)
{
// 用正则匹配当前访问的文件的后缀名是 .css
test: /\.css$/,
// webpack读取loader时, 是从右到左的读取, 会将css文件先交给最右侧的loader来处理
// loader的执行顺序是从右到左以管道的方式链式调用的
// css-loader: 解析css文件
// style-loader: 将解析出阿里的结果放到html中, 使其生效
use: ['style-loader', 'css-loader'] // webpack底层调用这些包的顺序是从右到左
}
]
}
loader的释义:
- css-loader: 解析css文件
- style-loader: 将解析出来的结果 放到html中, 使其生效
weback帮我们把外部的css加载到了当前的网页中, 然后插入到了当前网页的一个节点上面(动态的),
就是加到一个style节点上, 新开了一个style节点, 然后把延时写进去
2.5. 处理less和scss
npm i less less-loader sass-loader node-sass -D
- less-loader: 将less文件解析成css文件
- sass-loader: 将sass文件解析成css文件
{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] },
{ test: /\.s(a|c)ss$/, use: ['style-loader', 'css-loader', 'sass-loader'] }
2.6. 处理图片和字体
npm i file-loader url-loader -D
url-loader 封装了 file-loader, 所以使用 url-loader 时需要安装 file-loader
{
test: /\.(png|jpg|gif)/,
use: [{
loader: 'url-loader',
options: {
// limit表示如果图片大于5KB,就以路径形式展示,小于的话就用base64格式展示
limit: 5 * 1024,
// 打包输出目录
outputPath: 'images',
// 打包输出图片名称
name: '[name]-[hash:4].[ext]'
}
}]
}
2.7. babel
npm i babel-loader @babel/core @babel/preset-env webpack -D
- 如果需要支持更高级的ES6语法, 可以继续安装插件:
npm i @babel/plugin-proposal-class-properties -D
也可以根据需要在babel官网找插件进行安装
{
test: /\.js$/,
use: {
loader: 'babel-loader',
options: {
presets: ['@babel/env'],
plugins: ['@babel/plugin-proposal-class-properties']
}
},
exclude: /node_modules/
}
官方更建议的做法是在项目根目录下新建一个.babelrc
配置文件
{
"presets": ["@babel/env"],
"plugins": ["@babel/plugin-proposal-class-properties"]
}
如果需要使用 generator
, 无法直接使用babel进行转换, 因为会将generator
转换为一个regeneratorRuntime
,然后使用mark
和wrap
来实现generator
但由于babel并没有内置regeneratorRuntime
, 所以无法直接使用
需要安装插件:
npm i @babel/plugin-transform-runtime -D
同时还需要安装运行时依赖
npm i @babel/runtime -D
在.babelrc
中添加插件:
{
"presets": [
"@babel/env"
],
"plugins": [
"@babel/plugin-proposal-class-properties",
"@babel/plugin-transfrom-runtime"
]
}
如果需要使用ES6/7中对象原型提供的新方法, babel默认情况无法转换, 即使用了transform-runtime
的插件也不支持转换原型上的方法
需要使用另一个模块:
npm i @babel/polyfill -S
该模块需要在使用新方法的地方直接引入
import '@babel/polyfill'
2.8. source map
2.8.1. devtool
此选项控制是否生成,以及如何生成 source map
使用 SourceMapDevToolPlugin
进行更细粒度的配置. 查看source-map-loader
来处理已有的 source map.
选择一种 source map
格式来增强调试过程. 不同的值会明显影响到构建(build)和重新构建(rebuild)的速度.
可以直接使用
SourceMapDevToolPlugin
/EvalSourceMapDevToolPlugin
来替代使用devtool
选项, 它有更多的选项, 你是切勿同时使用devtool
选项和SourceMapDevToolPlugin
/EvalSourceMapDevToolPlugin
插件. 因为devtool
选项在内部添加过这些插件,所以会应用两次插件.
devtool | 构建速度 | 重新构建速度 | 生产环境 | 品质(quality) |
---|---|---|---|---|
(none) | +++ | +++ | yes | 打包后的代码 |
eval | +++ | +++ | no | 生成后的代码 |
cheap-eval-source-map | + | ++ | no | 转换过的代码 (仅限行) |
cheap-module-eval-source-map | 0 | ++ | no | 原始源代码 (仅限行) |
eval-source-map | - - | + | no | 原始源代码 |
cheap-source-map | + | 0 | no | 转换过的代码 (仅限行) |
cheap-module-source-map | 0 | - | no | 原始源代码 (仅限行) |
inline-cheap-source-map | + | 0 | no | 转换过的代码 (仅限行) |
inline-cheap-module-source-map | 0 | - | no | 原始源代码 (仅限行) |
source-map | - - | - - | yes | 原始源代码 |
inline-source-map | - - | - - | no | 原始源代码 |
hidden-source-map | - - | - - | yes | 原始源代码 |
nosource-source-map | - - | - - | yes | 无源代码内容 |
+++ 非常快速, ++ 快速, + 比较快, 0 中等, - 比较慢, - - 慢
- 模式的选择
开发环境推荐:
- cheap-module-eval-source-map
生产环境推荐:
- none(不使用 source map)
原因如下:
- 使用 cheap 模式可以大幅提高 source map 生成的效率. 大部分情况我们调试并不关心列信息, 而且就算 source map 没有列, 有些浏览器引擎 (例如 v8) 也会给出列信息.
- 使用 module 可支持 babel 这种预编译工具, 映射转换前的代码.
- 使用 eval 方式可大幅提高持续构建效率. 官方文档提供的速度对比表格可以看到 eval 模式的重新构建速度都很快.
- 使用 eval-source-map 模式可以减少网络请求. 这种模式开启 DataUrl 本身包含完整 sourcemap 信息, 并不需要像 sourceURL 那样, 浏览器需要发送一个完整请求去获取 sourcemap 文件, 这会略微提高点效率, 而生产环境中则不宜用 eval, 这样会让文件变的极大.
2.8.2 插件
- clean-webpack-plugin
该插件在npm run build
时自动清除dist
目录后重新生成, 非常方便
- 安装插件
npm i clean-webpack-plugin -D
- 引入插件
const CleanWebpackPlugin = require('clean-webpack-plugin')
- 使用插件, 在plugin中直接创建对象即可
plugins: [
new HtmlWebpackPlugin({
filename: 'index.html',
template: './src/index.html'
}),
new CleanWebpackPlugin()
],
-
copy-webpack-plugin
帮我们把资源从一个位置拷贝到dist目录下面的某个位置,变相的帮我们实现了img图片的引用
- 安装插件
npm i copy-webpack-plugin -D
- 引入插件
const CopyWebpackPlugin = require('copy-webpack-plugin')
- 使用插件, 在plugins中插件对象并配置源和目标
from: 源, 从哪里拷贝, 可以时相对路径或绝对路径, 推荐绝对路径
to: 目标, 拷贝到哪里去, 相对于output
的路径, 同样可以相对路径或绝对路径, 但更推荐相对路径(直接算相对dist目录即可)
plugins: [
new HtmlWebpackPlugin({
filename: 'index.html',
template: './src/index.html'
}),
new CleanWebpackPlugin(),
new CopyWebpackPlugin([
{
from: path.join(__dirname, 'assets'),
to: 'assets'
}
])
],
- BannerPlugin
这是一个webpack的内置插件, 用于给打包的JS文件加上版权注释信息
- 引入 webpack
const webpack = require('webpack')
- 创建插件对象
plugins: [
new HtmlWebpackPlugin({
filename: 'index.html',
template: './src/index.html'
}),
new CleanWebpackPlugin(),
new CopyWebpackPlugin([
{
from: path.join(__dirname, 'assets'),
to: 'assets'
}
]),
new webpack.BannerPlugin('黑马程序员牛逼!')
],