摘要:继个实例入门并掌握二后续配置配置配置使用加快打包速度多页面打包配置编写编写编写十七配置源码地址本节使用的代码为基础我们来模拟平时开发中,将打包完的代码防止到服务器上的操作,首先打包代码然后安装一个插件在中配置一个命令运
继 24 个实例入门并掌握「Webpack4」(二) 后续:
PWA 配置
TypeScript 配置
Eslint 配置
使用 DLLPlugin 加快打包速度
多页面打包配置
编写 loader
编写 plugin
编写 Bundle
十七、PWA 配置demo17 源码地址
本节使用 demo15 的代码为基础
我们来模拟平时开发中,将打包完的代码防止到服务器上的操作,首先打包代码 npm run build
然后安装一个插件 npm i http-server -D
在 package.json 中配置一个 script 命令
{ "scripts": { "start": "http-server dist", "dev": "webpack-dev-server --open --config ./build/webpack.dev.conf.js", "build": "webpack --config ./build/webpack.prod.conf.js" } }
运行 npm run start
现在就起了一个服务,端口是 8080,现在访问 http://127.0.0.1:8080 就能看到效果了
如果你有在跑别的项目,端口也是 8080,端口就冲突,记得先关闭其他项目的 8080 端口,再 npm run start
我们按 ctrl + c 关闭 http-server 来模拟服务器挂了的场景,再访问 http://127.0.0.1:8080 就会是这样
页面访问不到了,因为我们服务器挂了,PWA 是什么技术呢,它可以在你第一次访问成功的时候,做一个缓存,当服务器挂了之后,你依然能够访问这个网页
首先安装一个插件:workbox-webpack-plugin
npm i workbox-webpack-plugin -D
只有要上线的代码,才需要做 PWA 的处理,打开 webpack.prod.conf.js
const WorkboxPlugin = require("workbox-webpack-plugin") // 引入 PWA 插件 const prodConfig = { plugins: [ // 配置 PWA new WorkboxPlugin.GenerateSW({ clientsClaim: true, skipWaiting: true }) ] }
重新打包,在 dist 目录下会多出 service-worker.js 和 precache-manifest.js 两个文件,通过这两个文件就能使我们的网页支持 PWA 技术,service-worker.js 可以理解为另类的缓存
还需要去业务代码中使用 service-worker
在 app.js 中加上以下代码
// 判断该浏览器支不支持 serviceWorker if ("serviceWorker" in navigator) { window.addEventListener("load", () => { navigator.serviceWorker .register("/service-worker.js") .then(registration => { console.log("service-worker registed") }) .catch(error => { console.log("service-worker registed error") }) }) }
重新打包,然后运行 npm run start 来模拟服务器上的操作,最好用无痕模式打开 http://127.0.0.1:8080 ,打开控制台
现在文件已经被缓存住了,再按 ctrl + c 关闭服务,再次刷新页面也还是能显示的
TypeScript配置demo18 源码地址
TypeScript 是 JavaScript 类型的超集,它可以编译成纯 JavaScript
新建文件夹,npm init -y,npm i webpack webpack-cli -D,新建 src 目录,创建 index.ts 文件,这段代码在浏览器上是运行不了的,需要我们打包编译,转成 js
class Greeter { greeting: string constructor(message: string) { this.greeting = message } greet() { return "Hello, " + this.greeting } } let greeter = new Greeter("world") alert(greeter.greet())
npm i ts-loader typescript -D
新建 webpack.config.js 并配置
const path = require("path") module.exports = { mode: "production", entry: "./src/index.ts", module: { rules: [ { test: /.ts?$/, use: "ts-loader", exclude: /node_modules/ } ] }, output: { filename: "bundle.js", path: path.resolve(__dirname, "dist") } }
在 package.json 中配置 script
{ "scripts": { "build": "webpack" } }
运行 npm ruh build,报错了,缺少 tsconfig.json 文件
当打包 typescript 文件的时候,需要在项目的根目录下创建一个 tsconfig.json 文件
以下为简单配置,更多详情看官网
{ "compileerOptions": { "outDir": "./dist", // 写不写都行 "module": "es6", // 用 es6 模块引入 import "target": "es5", // 打包成 es5 "allowJs": true // 允许在 ts 中也能引入 js 的文件 } }
再次打包,打开 bundle.js 文件,将代码全部拷贝到浏览器控制台上,使用这段代码,可以看到弹窗出现 Hello,world,说明 ts 编译打包成功
引入第三方库npm i lodash
import _ from "lodash" class Greeter { greeting: string constructor(message: string) { this.greeting = message } greet() { return _.join() } } let greeter = new Greeter("world") alert(greeter.greet())
lodash 的 join 方法需要我们传递参数,但是现在我们什么都没传,也没有报错,我们使用 typescript 就是为了类型检查,在引入第三方库的时候也能如此,可是现在缺并没有报错或者提示
我们还要安装一个 lodash 的 typescript 插件,这样就能识别 lodash 方法中的参数,一旦使用的不对就会报错出来
npm i @types/lodash -D
安装完以后可以发现下划线 _ 报错了
需要改成 import * as _ from "lodash",将 join 方法传递的参数删除,还可以发现 join 方法的报错,这就体现了 typescript 的优势,同理,引入 jQuery 也要引入一个 jQuery 对应的类型插件
如何知道使用的库需要安装对应的类型插件呢?
打开TypeSearch,在这里对应的去搜索你想用的库有没有类型插件,如果有只需要 npm i @types/jquery -D 即可
十九、Eslint 配置demo19 源码地址
创建一个空文件夹,npm init -y,npm webpack webpack-cli -D 起手式,之后安装 eslint 依赖
npm i eslint -D
使用 npx 运行此项目中的 eslint 来初始化配置,npx eslint --init
这里会有选择是 React/Vue/JavaScript,我们统一都先选择 JavaScript。选完后会在项目的根目录下新建一个 .eslintrc.js 配置文件
module.exports = { env: { browser: true, es6: true }, extends: "eslint:recommended", globals: { Atomics: "readonly", SharedArrayBuffer: "readonly" }, parserOptions: { ecmaVersion: 2018, sourceType: "module" }, rules: {} }
里面就是 eslint 的一些规范,也可以定义一些规则,具体看 eslint 配置规则
在 index.js 中随便写点代码来测试一下 eslint
eslint 报错提示,变量定义后却没有使用,如果在编辑器里没出现报错提示,需要在 vscode 里先安装一个 eslint 扩展,它会根据你当前目录的下的 .eslintrc.js 文件来做作为校验的规则
也可以通过命令行的形式,让 eslint 校验整个 src 目录下的文件
如果你觉得某个规则很麻烦,想屏蔽掉某个规则的时候,可以这样,根据 eslint 的报错提示,比如上面的 no-unused-vars,将这条规则复制一下,在 .eslintrc.js 中的 rules 里配置一下,"no-unused-vars": 0,0 表示禁用,保存后,就不会报错了,但是这种方式是适用于全局的配置,如果你只想在某一行代码上屏蔽掉 eslint 校验,可以这样做
/* eslint-disable no-unused-vars */ let a = "1"
这个 eslint 的 vscode 扩展和 webpack 是没有什么关联的,我们现在要讲的是如何在 webpack 里使用 eslint,首先安装一个插件
npm i eslint-loader -D
在 webpack.config.js 中进行配置
/* eslint-disable no-undef */ // eslint-disable-next-line no-undef const path = require("path") module.exports = { mode: "production", entry: { app: "./src/index.js" // 需要打包的文件入口 }, module: { rules: [ { test: /.js$/, // 使用正则来匹配 js 文件 exclude: /nodes_modules/, // 排除依赖包文件夹 use: { loader: "eslint-loader" // 使用 eslint-loader } } ] }, output: { // eslint-disable-next-line no-undef publicPath: __dirname + "/dist/", // js 引用的路径或者 CDN 地址 // eslint-disable-next-line no-undef path: path.resolve(__dirname, "dist"), // 打包文件的输出目录 filename: "bundle.js" // 打包后生产的 js 文件 } }
由于 webpack 配置文件也会被 eslint 校验,这里我先写上注释,关闭校验
如果你有使用 babel-loader 来转译,则 loader 应该这么写
loader: ["babel-loader", "eslint-loader"]
rules 的执行顺序是从右往左,从下往上的,先经过 eslint 校验判断代码是否符合规范,然后再通过 babel 来做转移
配置完 webpack.config.js,我们将 index.js 还原回之前报错的状态,不要使用注释关闭校验,然后运行打包命令,记得去 package.json 配置 script
会在打包的时候,提示代码不合格,不仅仅是生产环境,开发环境也可以配置,可以将 eslint-loader 配置到 webpack 的公共模块中,这样更有利于我们检查代码规范
如:设置 fix 为 true,它会帮你自动修复一些错误,不能自动修复的,还是需要你自己手动修复
{ loader: "eslint-loader", // 使用 eslint-loader options: { fix: true } }
关于 eslint-loader,webpack 的官网也给出了配置,感兴趣的朋友自己去看一看
二十、使用 DLLPlugin 加快打包速度demo20 源码地址
本节使用 demo15 的代码为基础
我们先安装一个 lodash 插件 npm i lodash,并在 app.js 文件中写入
import _ from "lodash" console.log(_.join(["hello", "world"], "-"))
在 build 文件夹下新建 webpack.dll.js 文件
const path = require("path") module.exports = { mode: "production", entry: { vendors: ["lodash", "jquery"] }, output: { filename: "[name].dll.js", path: path.resolve(__dirname, "../dll"), library: "[name]" } }
这里使用 library,忘记的朋友可以回顾一下第十六节,自定义函数库里的内容,定义了 library 就相当于挂载了这个全局变量,只要在控制台输入全局变量的名称就可以显示里面的内容,比如这里我们是 library: "[name]" 对应的 name 就是我们在 entry 里定义的 vendors
在 package.json 中的 script 再新增一个命令
{ "scripts": { "dev": "webpack-dev-server --open --config ./build/webpack.dev.conf.js", "build": "webpack --config ./build/webpack.prod.conf.js", "build:dll": "webpack --config ./build/webpack.dll.js" } }
运行 npm run build:dll,会生成 dll 文件夹,并且文件为 vendors.dll.js
打开文件可以发现 lodash 已经被打包到了 dll 文件中
那我们要如何使用这个 vendors.dll.js 文件呢
需要再安装一个依赖 npm i add-asset-html-webpack-plugin,它会将我们打包后的 dll.js 文件注入到我们生成的 index.html 中
在 webpack.base.conf.js 文件中引入
const AddAssetHtmlWebpackPlugin = require("add-asset-html-webpack-plugin") module.exports = { plugins: [ new AddAssetHtmlWebpackPlugin({ filepath: path.resolve(__dirname, "../dll/vendors.dll.js") // 对应的 dll 文件路径 }) ] }
使用 npm run dev 来打开网页
现在我们已经把第三方模块多带带打包成了 dll 文件,并使用
但是现在使用第三方模块的时候,要用 dll 文件,而不是使用 /node_modules/ 中的库,继续来修改 webpack.dll.js 配置
const path = require("path") const webpack = require("webpack") module.exports = { mode: "production", entry: { vendors: ["lodash", "jquery"] }, output: { filename: "[name].dll.js", path: path.resolve(__dirname, "../dll"), library: "[name]" }, plugins: [ new webpack.DllPlugin({ name: "[name]", // 用这个插件来分析打包后的这个库,把库里的第三方映射关系放在了这个 json 的文件下,这个文件在 dll 目录下 path: path.resolve(__dirname, "../dll/[name].manifest.json") }) ] }
保存后重新打包 dll,npm run build:dll
修改 webpack.base.conf.js 文件,添加 webpack.DllReferencePlugin 插件
module.exports = { plugins: [ // 引入我们打包后的映射文件 new webpack.DllReferencePlugin({ manifest: path.resolve(__dirname, "../dll/vendors.manifest.json") }) ] }
之后再 webpack 打包的时候,就可以结合之前的全局变量 vendors 和 这个新生成的 vendors.manifest.json 映射文件,然后来对我们的源代码进行分析,一旦分析出使用第三方库是在 vendors.dll.js 里,就会去使用 vendors.dll.js,不会去使用 /node_modules/ 里的第三方库了
再次打包 npm run build,可以把 webpack.DllReferencePlugin 模块注释后再打包对比一下
注释前 4000ms 左右,注释后 4300ms 左右,虽然只是快了 300ms,但是我们目前只是实验性的 demo,实际项目中,比如拿 vue 来说,vue,vue-router,vuex,element-ui,axios 等第三方库都可以打包到 dll.js 里,那个时候的打包速度就能提升很多了
还可以继续拆分,修改 webpack.dll.js 文件
const path = require("path") const webpack = require("webpack") module.exports = { mode: "production", entry: { lodash: ["lodash"], jquery: ["jquery"] }, output: { filename: "[name].dll.js", path: path.resolve(__dirname, "../dll"), library: "[name]" }, plugins: [ new webpack.DllPlugin({ name: "[name]", path: path.resolve(__dirname, "../dll/[name].manifest.json") // 用这个插件来分析打包后的这个库,把库里的第三方映射关系放在了这个 json 的文件下,这个文件在 dll 目录下 }) ] }
运行 npm run build:dll
可以把之前打包的 vendors.dll.js 和 vendors.manifest.json 映射文件给删除掉
然后再修改 webpack.base.conf.js
module.exports = { plugins: [ new AddAssetHtmlWebpackPlugin({ filepath: path.resolve(__dirname, "../dll/lodash.dll.js") }), new AddAssetHtmlWebpackPlugin({ filepath: path.resolve(__dirname, "../dll/jquery.dll.js") }), new webpack.DllReferencePlugin({ manifest: path.resolve(__dirname, "../dll/lodash.manifest.json") }), new webpack.DllReferencePlugin({ manifest: path.resolve(__dirname, "../dll/jquery.manifest.json") }) ] }
保存后运行 npm run dev,看看能不能成功运行
这还只是拆分了两个第三方模块,就要一个个配置过去,有没有什么办法能简便一点呢? 有!
这里使用 node 的 api,fs 模块来读取文件夹里的内容,创建一个 plugins 数组用来存放公共的插件
const fs = require("fs") const plugins = [ // 开发环境和生产环境二者均需要的插件 new HtmlWebpackPlugin({ title: "webpack4 实战", filename: "index.html", template: path.resolve(__dirname, "..", "index.html"), minify: { collapseWhitespace: true } }), new webpack.ProvidePlugin({ $: "jquery" }) ] const files = fs.readdirSync(path.resolve(__dirname, "../dll")) console.log(files)
写完可以先输出一下,把 plugins 给注释掉,npm run build 打包看看输出的内容,可以看到文件夹中的内容以数组的形式被打印出来了,之后我们对这个数组做一些循环操作就行了
完整代码:
const path = require("path") const fs = require("fs") const webpack = require("webpack") const HtmlWebpackPlugin = require("html-webpack-plugin") const AddAssetHtmlWebpackPlugin = require("add-asset-html-webpack-plugin") // 存放公共插件 const plugins = [ // 开发环境和生产环境二者均需要的插件 new HtmlWebpackPlugin({ title: "webpack4 实战", filename: "index.html", template: path.resolve(__dirname, "..", "index.html"), minify: { collapseWhitespace: true } }), new webpack.ProvidePlugin({ $: "jquery" }) ] // 自动引入 dll 中的文件 const files = fs.readdirSync(path.resolve(__dirname, "../dll")) files.forEach(file => { if (/.*.dll.js/.test(file)) { plugins.push( new AddAssetHtmlWebpackPlugin({ filepath: path.resolve(__dirname, "../dll", file) }) ) } if (/.*.manifest.json/.test(file)) { plugins.push( new webpack.DllReferencePlugin({ manifest: path.resolve(__dirname, "../dll", file) }) ) } }) module.exports = { entry: { app: "./src/app.js" }, output: { path: path.resolve(__dirname, "..", "dist") }, module: { rules: [ { test: /.js$/, exclude: /node_modules/, use: [ { loader: "babel-loader" } ] }, { test: /.(png|jpg|jpeg|gif)$/, use: [ { loader: "url-loader", options: { name: "[name]-[hash:5].min.[ext]", limit: 1000, // size <= 1KB outputPath: "images/" } }, // img-loader for zip img { loader: "image-webpack-loader", options: { // 压缩 jpg/jpeg 图片 mozjpeg: { progressive: true, quality: 65 // 压缩率 }, // 压缩 png 图片 pngquant: { quality: "65-90", speed: 4 } } } ] }, { test: /.(eot|ttf|svg)$/, use: { loader: "url-loader", options: { name: "[name]-[hash:5].min.[ext]", limit: 5000, // fonts file size <= 5KB, use "base64"; else, output svg file publicPath: "fonts/", outputPath: "fonts/" } } } ] }, plugins, performance: false }
使用 npm run dev 打开网页也没有问题了,这样自动注入 dll 文件也搞定了,之后还要再打包第三方库只要添加到 webpack.dll.js 里面的 entry 属性中就可以了
二十一、多页面打包配置demo21 源码地址
本节使用 demo20 的代码为基础
在 src 目录下新建 list.js 文件,里面写 console.log("这里是 list 页面")
在 webpack.base.conf.js 中配置 entry,配置两个入口
module.exports = { entry: { app: "./src/app.js", list: "./src/list.js" } }
如果现在我们直接 npm run build 打包,在打包自动生成的 index.html 文件中会发现 list.js 也被引入了,说明多入口打包成功,但并没有实现多个页面的打包,我想打包出 index.html 和 list.html 两个页面,并且在 index.html 中引入 app.js,在 list.html 中引入 list.js,该怎么做?
为了方便演示,先将 webpack.prod.conf.js 中 cacheGroups 新增一个 default 属性,自定义 name
optimization: { splitChunks: { chunks: "all", cacheGroups: { jquery: { name: "jquery", // 多带带将 jquery 拆包 priority: 15, test: /[/]node_modules[/]jquery[/]/ }, vendors: { test: /[/]node_modules[/]/, name: "vendors" }, default: { name: "code-segment" } } } }
打开 webpack.base.conf.js 文件,将 HtmlWebpackPlugin 拷贝一份,使用 chunks 属性,将需要打包的模块对应写入
// 存放公共插件 const plugins = [ new HtmlWebpackPlugin({ title: "webpack4 实战", filename: "index.html", template: path.resolve(__dirname, "..", "index.html"), chunks: ["app", "vendors", "code-segment", "jquery", "lodash"] }), new HtmlWebpackPlugin({ title: "多页面打包", filename: "list.html", template: path.resolve(__dirname, "..", "index.html"), chunks: ["list", "vendors", "code-segment", "jquery", "lodash"] }), new CleanWebpackPlugin(), new webpack.ProvidePlugin({ $: "jquery" }) ]
打包后的 dist 目录下生成了两个 html
打开 index.html 可以看到引入的是 app.js,而 list.html 引入的是 list.js,这就是 HtmlWebpackPlugin 插件的 chunks 属性,自定义引入的 js
如果要打包三个页面,再去 copy HtmlWebpackPlugin,通过在 entry 中配置,如果有四个,五个,这样手动的复制就比较麻烦了,可以写个方法自动生成 HtmlWebpackPlugin 配置
修改 webpack.base.conf.js
const path = require("path") const fs = require("fs") const webpack = require("webpack") const HtmlWebpackPlugin = require("html-webpack-plugin") const AddAssetHtmlWebpackPlugin = require("add-asset-html-webpack-plugin") const CleanWebpackPlugin = require("clean-webpack-plugin") const makePlugins = configs => { // 基础插件 const plugins = [ new CleanWebpackPlugin(), new webpack.ProvidePlugin({ $: "jquery" }) ] // 根据 entry 自动生成 HtmlWebpackPlugin 配置,配置多页面 Object.keys(configs.entry).forEach(item => { plugins.push( new HtmlWebpackPlugin({ title: "多页面配置", template: path.resolve(__dirname, "..", "index.html"), filename: `${item}.html`, chunks: [item, "vendors", "code-segment", "jquery", "lodash"] }) ) }) // 自动引入 dll 中的文件 const files = fs.readdirSync(path.resolve(__dirname, "../dll")) files.forEach(file => { if (/.*.dll.js/.test(file)) { plugins.push( new AddAssetHtmlWebpackPlugin({ filepath: path.resolve(__dirname, "../dll", file) }) ) } if (/.*.manifest.json/.test(file)) { plugins.push( new webpack.DllReferencePlugin({ manifest: path.resolve(__dirname, "../dll", file) }) ) } }) return plugins } const configs = { entry: { index: "./src/app.js", list: "./src/list.js" }, output: { path: path.resolve(__dirname, "..", "dist") }, module: { rules: [ { test: /.js$/, exclude: /node_modules/, use: [ { loader: "babel-loader" } ] }, { test: /.(png|jpg|jpeg|gif)$/, use: [ { loader: "url-loader", options: { name: "[name]-[hash:5].min.[ext]", limit: 1000, // size <= 1KB outputPath: "images/" } }, // img-loader for zip img { loader: "image-webpack-loader", options: { // 压缩 jpg/jpeg 图片 mozjpeg: { progressive: true, quality: 65 // 压缩率 }, // 压缩 png 图片 pngquant: { quality: "65-90", speed: 4 } } } ] }, { test: /.(eot|ttf|svg)$/, use: { loader: "url-loader", options: { name: "[name]-[hash:5].min.[ext]", limit: 5000, // fonts file size <= 5KB, use "base64"; else, output svg file publicPath: "fonts/", outputPath: "fonts/" } } } ] }, performance: false } makePlugins(configs) configs.plugins = makePlugins(configs) module.exports = configs
再次打包后效果相同,如果还要增加页面,只要在 entry 中再引入一个 js 文件作为入口即可
多页面配置其实就是定义多个 entry,配合 htmlWebpackPlugin 生成多个 html 页面二十二、编写 loader
demo22 源码地址
新建文件夹,npm init -y,npm i webpack webpack-cli -D,新建 src/index.js,写入 console.log("hello world")
新建 loaders/replaceLoader.js 文件
module.exports = function(source) { return source.replace("world", "loader") }
source 参数就是我们的源代码,这里是将源码中的 world 替换成 loader
新建 webpack.config.js
const path = require("path") module.exports = { mode: "development", entry: { main: "./src/index.js" }, module: { rules: [ { test: /.js/, use: [path.resolve(__dirname, "./loaders/replaceLoader.js")] // 引入自定义 loader } ] }, output: { path: path.resolve(__dirname, "dist"), filename: "[name].js" } }
目录结构:
打包后打开 dist/main.js 文件,在最底部可以看到 world 已经被改为了 loader,一个最简单的 loader 就写完了
添加 optiions 属性
const path = require("path") module.exports = { mode: "development", entry: { main: "./src/index.js" }, module: { rules: [ { test: /.js/, use: [ { loader: path.resolve(__dirname, "./loaders/replaceLoader.js"), options: { name: "xh" } } ] } ] }, output: { path: path.resolve(__dirname, "dist"), filename: "[name].js" } }
修改 replaceLoader.js 文件,保存后打包,输出看看效果
module.exports = function(source) { console.log(this.query) return source.replace("world", this.query.name) }
打包后生成的文件也改为了 options 中定义的 name
更多的配置见官网 API,找到 Loader Interface,里面有个 this.query
如果你的 options 不是一个对象,而是按字符串形式写的话,可能会有一些问题,这里官方推荐使用 loader-utils 来获取 options 中的内容
安装 npm i loader-utils -D,修改 replaceLoader.js
const loaderUtils = require("loader-utils") module.exports = function(source) { const options = loaderUtils.getOptions(this) console.log(options) return source.replace("world", options.name) }
console.log(options) 与 console.log(this.query) 输出内容一致
如果你想传递额外的信息出去,return 就不好用了,官网给我们提供了 this.callback API,用法如下
this.callback( err: Error | null, content: string | Buffer, sourceMap?: SourceMap, meta?: any )
修改 replaceLoader.js
const loaderUtils = require("loader-utils") module.exports = function(source) { const options = loaderUtils.getOptions(this) const result = source.replace("world", options.name) this.callback(null, result) }
目前没有用到 sourceMap(必须是此模块可解析的源映射)、meta(可以是任何内容(例如一些元数据)) 这两个可选参数,只将 result 返回回去,保存重新打包后,效果和 return 是一样的
如果在 loader 中写异步代码,会怎么样
const loaderUtils = require("loader-utils") module.exports = function(source) { const options = loaderUtils.getOptions(this) setTimeout(() => { const result = source.replace("world", options.name) return result }, 1000) }
报错 loader 没有返回,这里使用 this.async 来写异步代码
const loaderUtils = require("loader-utils") module.exports = function(source) { const options = loaderUtils.getOptions(this) const callback = this.async() setTimeout(() => { const result = source.replace("world", options.name) callback(null, result) }, 1000) }
模拟一个同步 loader 和一个异步 loader
新建一个 replaceLoaderAsync.js 文件,将之前写的异步代码放入,修改 replaceLoader.js 为同步代码
// replaceLoaderAsync.js const loaderUtils = require("loader-utils") module.exports = function(source) { const options = loaderUtils.getOptions(this) const callback = this.async() setTimeout(() => { const result = source.replace("world", options.name) callback(null, result) }, 1000) } // replaceLoader.js module.exports = function(source) { return source.replace("xh", "world") }
修改 webpack.config.js,loader 的执行顺序是从下到上,先执行异步代码,将 world 改为 xh,再执行同步代码,将 xh 改为 world
module: { rules: [ { test: /.js/, use: [ { loader: path.resolve(__dirname, "./loaders/replaceLoader.js") }, { loader: path.resolve(__dirname, "./loaders/replaceLoaderAsync.js"), options: { name: "xh" } } ] } ] }
保存后打包,在 mian.js 中可以看到已经改为了 hello world,使用多个 loader 也完成了
如果有多个自定义 loader,每次都通过 path.resolve(__dirname, xxx) 这种方式去写,有没有更好的方法?
使用 resolveLoader,定义 modules,当你使用 loader 的时候,会先去 node_modules 中去找,如果没找到就会去 ./loaders 中找
const path = require("path") module.exports = { mode: "development", entry: { main: "./src/index.js" }, resolveLoader: { modules: ["node_modules", "./loaders"] }, module: { rules: [ { test: /.js/, use: [ { loader: "replaceLoader.js" }, { loader: "replaceLoaderAsync.js", options: { name: "xh" } } ] } ] }, output: { path: path.resolve(__dirname, "dist"), filename: "[name].js" } }二十三、编写 plugin
demo23 源码地址
首先新建一个文件夹,npm 起手式操作一番,具体的在前几节已经说了,不再赘述
在根目录下新建 plugins 文件夹,新建 copyright-webpack-plugin.js,一般我们用的都是 xxx-webpack-plugin,所以我们命名也按这样来,plugin 的定义是一个类
class CopyrightWebpackPlugin { constructor() { console.log("插件被使用了") } apply(compiler) {} } module.exports = CopyrightWebpackPlugin
在 webpack.config.js 中使用,所以每次使用 plugin 都要使用 new,因为本质上 plugin 是一个类
const path = require("path") const CopyrightWebpackPlugin = require("./plugins/copyright-webpack-plugin") module.exports = { mode: "development", entry: { main: "./src/index.js" }, plugins: [new CopyrightWebpackPlugin()], output: { path: path.resolve(__dirname, "dist"), filename: "[name].js" } }
保存后打包,插件被使用了,只不过我们什么都没干
如果我们要传递参数,可以这样
new CopyrightWebpackPlugin({ name: "xh" })
同时在 copyright-webpack-plugin.js 中接收
class CopyrightWebpackPlugin { constructor(options) { console.log("插件被使用了") console.log("options = ", options) } apply(compiler) {} } module.exports = CopyrightWebpackPlugin
我们先把 constructor 注释掉,在即将要把打包的结果,放入 dist 目录之前的这个时刻,我们来做一些操作
apply(compiler) {} compiler 可以看作是 webpack 的实例,具体见官网 compiler-hooks
hooks 是钩子,像 vue、react 的生命周期一样,找到 emit 这个时刻,将打包结果放入 dist 目录前执行,这里是个 AsyncSeriesHook 异步方法
class CopyrightWebpackPlugin { apply(compiler) { compiler.hooks.emit.tapAsync( "CopyrightWebpackPlugin", (compilation, cb) => { console.log(11) cb() } ) } } module.exports = CopyrightWebpackPlugin
因为 emit 是异步的,可以通过 tapAsync 来写,当要把代码放入到 dist 目录之前,就会触发这个钩子,走到我们定义的函数里,如果你用 tapAsync 函数,记得最后要用 cb() ,tapAsync 要传递两个参数,第一个参数传递我们定义的插件名称
保存后再次打包,我们写的内容也输出了
compilation 这个参数里存放了这次打包的所有内容,可以输出一下 compilation.assets 看一下
返回结果是一个对象,main.js 是 key,也就是打包后生成的文件名及文件后缀,我们可以来仿照一下
class CopyrightWebpackPlugin { apply(compiler) { compiler.hooks.emit.tapAsync( "CopyrightWebpackPlugin", (compilation, cb) => { // 生成一个 copyright.txt 文件 compilation.assets["copyright.txt"] = { source: function() { return "copyright by xh" }, size: function() { return 15 // 上面 source 返回的字符长度 } } console.log("compilation.assets = ", compilation.assets) cb() } ) } } module.exports = CopyrightWebpackPlugin
在 dist 目录下生成了 copyright.txt 文件
之前介绍的是异步钩子,现在使用同步钩子
class CopyrightWebpackPlugin { apply(compiler) { // 同步钩子 compiler.hooks.compile.tap("CopyrightWebpackPlugin", compilation => { console.log("compile") }) // 异步钩子 compiler.hooks.emit.tapAsync( "CopyrightWebpackPlugin", (compilation, cb) => { compilation.assets["copyright.txt"] = { source: function() { return "copyright by xh" }, size: function() { return 15 // 字符长度 } } console.log("compilation.assets = ", compilation.assets) cb() } ) } } module.exports = CopyrightWebpackPlugin二十四、编写 Bundle
demo24 源码地址
模块分析在 src 目录下新建三个文件 word.js、message.js、index.js,对应的代码:
// word.js export const word = "hello" // message.js import { word } from "./word.js" const message = `say ${word}` export default message // index.js import message from "./message.js" console.log(message)
新建 bundle.js
const fs = require("fs") const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") console.log(content) } moduleAnalyser("./src/index.js")
使用 node 的 fs 模块,读取文件信息,并在控制台输出,这里全局安装一个插件,来显示代码高亮,npm i cli-highlight -g,运行 node bundle.js | highlight
index.js 中的代码已经被输出到控制台上,而且代码有高亮,方便阅读,读取入口文件信息就完成了
现在我们要读取 index.js 文件中使用的 message.js 依赖,import message from "./message.js"
安装一个第三方插件 npm i @babel/parser
@babel/parser 是 Babel 中使用的 JavaScript 解析器。
官网也提供了相应的示例代码,根据示例代码来仿照,修改我们的文件
const fs = require("fs") const parser = require("@babel/parser") const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") console.log( parser.parse(content, { sourceType: "module" }) ) } moduleAnalyser("./src/index.js")
我们使用的是 es6 的 module 语法,所以 sourceType: "module"
保存后运行,输出了 AST (抽象语法树),里面有一个 body 字段,我们输出这个字段
const fs = require("fs") const parser = require("@babel/parser") const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") const ast = parser.parse(content, { sourceType: "module" }) console.log(ast.program.body) } moduleAnalyser("./src/index.js")
打印出了两个 Node 节点,第一个节点的 type 是 ImportDeclaration(引入的声明),对照我们在 index.js 中写的 import message from "./message.js",第二个节点的 type 是 ExpressionStatement (表达式的声明),对照我们写的 console.log(message)
使用 babel 来帮我们生成抽象语法树,我们再导入 import message1 from "./message1.js" 再运行
抽象语法树将我们的 js 代码转成了对象的形式,现在就可以遍历抽象语法树生成的节点对象中的 type,是否为 ImportDeclaration,就能找到代码中引入的依赖了
再借助一个工具 npm i @babel/traverse
const fs = require("fs") const parser = require("@babel/parser") const traverse = require("@babel/traverse").default const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") const ast = parser.parse(content, { sourceType: "module" }) traverse(ast, { ImportDeclaration({ node }) { console.log(node) } }) } moduleAnalyser("./src/index.js")
只打印了两个 ImportDeclaration,遍历结束,我们只需要取到依赖的文件名,在打印的内容中,每个节点都有个 source 属性,里面有个 value 字段,表示的就是文件路径及文件名
const fs = require("fs") const parser = require("@babel/parser") const traverse = require("@babel/traverse").default const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") const ast = parser.parse(content, { sourceType: "module" }) const dependencise = [] traverse(ast, { ImportDeclaration({ node }) { dependencise.push(node.source.value) } }) console.log(dependencise) } moduleAnalyser("./src/index.js")
保存完重新运行,输出结果:
["./message.js", "./message1.js"]
这样就对入口文件的依赖分析就分析出来了,现在把 index.js 中引入的 message1.js 的依赖给删除,这里有个注意点,打印出来的文件路径是相对路径,相对于 src/index.js 文件,但是我们打包的时候不能是入口文件(index.js)的相对路径,而应该是根目录的相对路径(或者说是绝对路径),借助 node 的 api,引入一个 path
const fs = require("fs") const path = require("path") const parser = require("@babel/parser") const traverse = require("@babel/traverse").default const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") const ast = parser.parse(content, { sourceType: "module" }) const dependencise = [] traverse(ast, { ImportDeclaration({ node }) { const dirname = path.dirname(filename) console.log(dirname) dependencise.push(node.source.value) } }) // console.log(dependencise) } moduleAnalyser("./src/index.js")
输出为 ./src,继续修改
ImportDeclaration({ node }) { const dirname = path.dirname(filename) const newFile = path.join(dirname, node.source.value) console.log(newFile) dependencise.push(node.source.value) }
输出为 srcmessage.js
windows 和 类 Unix(linux/mac),路径是有区别的。windows 是用反斜杠 分割目录或者文件的,而在类 Unix 的系统中是用的 /。
由于我是 windows 系统,所以这里输出为 srcmessage.js,而类 Unix 输出的为 src/message.js
.srcmessage.js 这个路径是我们真正打包时要用到的路径
newFile .srcmessage.js [ ".srcmessage.js" ]
既存一个相对路径,又存一个绝对路径
const fs = require("fs") const path = require("path") const parser = require("@babel/parser") const traverse = require("@babel/traverse").default const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") const ast = parser.parse(content, { sourceType: "module" }) const dependencise = {} traverse(ast, { ImportDeclaration({ node }) { const dirname = path.dirname(filename) const newFile = "." + path.join(dirname, node.source.value) console.log("newFile", newFile) dependencise[node.source.value] = newFile } }) console.log(dependencise) return { filename, dependencise } } moduleAnalyser("./src/index.js")
newFile .srcmessage.js { "./message.js": ".srcmessage.js" }
因为我们写的代码是 es6,浏览器无法识别,还是需要 babel 来做转换
npm i @babel/core @babel/preset-env
"use strict" var _message = _interopRequireDefault(require("./message.js")) function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj } } console.log(_message.default)
const fs = require("fs") const path = require("path") const parser = require("@babel/parser") const traverse = require("@babel/traverse").default const babel = require("@babel/core") const moduleAnalyser = filename => { const content = fs.readFileSync(filename, "utf-8") const ast = parser.parse(content, { sourceType: "module" }) const dependencise = {} traverse(ast, { ImportDeclaration({ node }) { const dirname = path.dirname(filename) const newFile = "." + path.join(dirname, node.source.value) dependencise[node.source.value] = newFile } }) const { code } = babel.transformFromAst(ast, null, { presets: ["@babel/preset-env"] }) return { filename, dependencise, code } } const moduleInfo = moduleAnalyser("./src/index.js") console.log(moduleInfo)
分析的结果就在控制台上打印了
{ filename: "./src/index.js", dependencise: { "./message.js": ".srcmessage.js" }, code: ""use strict"; var _message = _interopRequireDefault(require("./message.js")); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } console.log(_message.default);" }
目前我们只对一个模块进行分析,接下来要对整个项目进行分析,所以我们先分析了入口文件,再分析入口文件中所使用的依赖
依赖图谱创建一个函数来循环依赖并生成图谱
// 依赖图谱 const makeDependenciesGraph = entry => { const entryModule = moduleAnalyser(entry) const graphArray = [entryModule] for (let i = 0; i < graphArray.length; i++) { const item = graphArray[i] const { dependencise } = item // 如果入口文件有依赖就去做循环依赖,对每一个依赖做分析 if (dependencise) { for (const j in dependencise) { if (dependencise.hasOwnProperty(j)) { graphArray.push(moduleAnalyser(dependencise[j])) } } } } console.log("graphArray = ", graphArray) }
将入口的依赖,依赖中的依赖全部都分析完放到 graphArray 中,控制台输出的打印结果
可以看到 graphArray 中一共有三个对象,就是我们在项目中引入的三个文件,全部被分析出来了,为了方便阅读,我们创建一个 graph 对象,将分析的结果依次放入
// 依赖图谱 const makeDependenciesGraph = entry => { const entryModule = moduleAnalyser(entry) const graphArray = [entryModule] for (let i = 0; i < graphArray.length; i++) { const item = graphArray[i] const { dependencise } = item // 如果入口文件有依赖就去做循环依赖,对每一个依赖做分析 if (dependencise) { for (const j in dependencise) { if (dependencise.hasOwnProperty(j)) { graphArray.push(moduleAnalyser(dependencise[j])) } } } } // console.log("graphArray = ", graphArray) // 创建一个对象,将分析后的结果放入 const graph = {} graphArray.forEach(item => { graph[item.filename] = { dependencise: item.dependencise, code: item.code } }) console.log("graph = ", graph) return graph }
输出的 graph 为:
最后在 makeDependenciesGraph 函数中将 graph 返回,赋值给 graphInfo,输出的结果和 graph 是一样的
const graghInfo = makeDependenciesGraph("./src/index.js") console.log(graghInfo)生成代码
现在已经拿到了所有代码生成的结果,现在我们借助 DependenciesGraph(依赖图谱) 来生成真正能在浏览器上运行的代码
最好放在一个大的闭包中来执行,避免污染全局环境
const generateCode = entry => { // makeDependenciesGraph 返回的是一个对象,需要转换成字符串 const graph = JSON.stringify(makeDependenciesGraph(entry)) return ` (function (graph) { })(${graph}) ` } const code = generateCode("./src/index.js") console.log(code)
我这里先把输出的 graph 代码格式化了一下,可以发现在 index.js 用到了 require 方法,message.js 中不仅用了 require 方法,还用 exports 对象,但是在浏览器中,这些都是不存在的,如果我们直接去执行,是会报错的
let graph = { "./src/index.js": { dependencise: { "./message.js": ".srcmessage.js" }, code: ` "use strict"; var _message = _interopRequireDefault(require("./message.js")); function _interopRequireDefault(obj){ return obj && obj.__esModule ? obj : { default: obj }; } console.log(_message.default); ` }, ".srcmessage.js": { dependencise: { "./word.js": ".srcword.js" }, code: ""use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.default = void 0; var _word = require("./word.js"); var message = "say ".concat(_word.word); var _default = message; exports.default = _default;" }, ".srcword.js": { dependencise: {}, code: ""use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.word = void 0; var word = "hello"; exports.word = word;" } }
接下来要去构造 require 方法和 exports 对象
const generateCode = entry => { console.log(makeDependenciesGraph(entry)) // makeDependenciesGraph 返回的是一个对象,需要转换成字符串 const graph = JSON.stringify(makeDependenciesGraph(entry)) return ` (function (graph) { // 定义 require 方法 function require(module) { }; require("${entry}") })(${graph}) ` } const code = generateCode("./src/index.js") console.log(code)
graph 是依赖图谱,拿到 entry 后去执行 ./src/index.js 中的 code,也就是下面高亮部分的代码,为了直观我把前面输出的 graph 代码拿下来参考:
let graph = { "./src/index.js": { dependencise: { "./message.js": ".srcmessage.js" }, code: ` "use strict"; var _message = _interopRequireDefault(require("./message.js")); function _interopRequireDefault(obj){ return obj && obj.__esModule ? obj : { default: obj }; } console.log(_message.default); ` } }
为了让 code 中的代码执行,这里再使用一个闭包,让每一个模块里的代码放到闭包里来执行,这样模块的变量就不会影响到外部的变量
return ` (function (graph) { // 定义 require 方法 function require(module) { (function (code) { eval(code) })(graph[module].code) }; require("${entry}") })(${graph}) `
闭包里传递的是 graph[module].code,现在 entry 也就是 ./src/index.js 这个文件,会传给 require 中的 module 变量,实际上去找依赖图谱中 ./src/index.js 对应的对象,然后再去找到 code 中对应的代码,也就是下面这段代码,被我格式化过,为了演示效果
"use strict" var _message = _interopRequireDefault(require("./message.js")) function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj } } console.log(_message.default)
但是我们会发现,这里 _interopRequireDefault(require("./message.js")) 引入的是 ./message.js 相对路径,等到第二次执行的时候,require(module) 这里的 module 对应的就是 ./message.js
它会到 graph 中去找 ./message.js 下对应的 code,可是我们在 graph 中存的是 ".srcmessage.js" 绝对路径,这样就会找不到对象
因为我们之前写代码的时候引入的是相对路径,现在我们要把相对路径转换成绝对路径才能正确执行,定义一个 localRequire 方法,这样当下次去找的时候就会走我们自己定义的 localRequire,其实就是一个相对路径转换的方法
return ` (function (graph) { // 定义 require 方法 function require(module) { // 相对路径转换 function localRequire(relativePath) { return require(graph[module].dependencise[relativePath]) } (function (require, code) { eval(code) })(localRequire, graph[module].code) }; require("${entry}") })(${graph}) `
我们定义了 localRequire 方法,并把它传递到闭包里,当执行了 eval(code) 时执行了 require 方法,就不是执行外部的 require(module) 这个方法,而是执行我们传递进去的 localRequire 方法
我们在分析出的代码中是这样引入 message.js 的
var _message = _interopRequireDefault(require("./message.js"))
这里调用了 require("./message.js"),就是我们上面写的 require 方法,也就是 localRequire(relativePath)
所以 relativePath 就是 "./message.js"
这个方法返回的是 require(graph[module].dependencise[relativePath])
这里我把参数带进去,就是这样:
graph("./src/index.js").dependencise["./message.js"]
let graph = { "./src/index.js": { dependencise: { "./message.js": ".srcmessage.js" }, code: ` "use strict"; var _message = _interopRequireDefault(require("./message.js")); function _interopRequireDefault(obj){ return obj && obj.__esModule ? obj : { default: obj }; } console.log(_message.default); ` } }
对照着图谱就能发现最终返回的就是 ".srcmessage.js" 绝对路径,返回绝对路径后,我们再调用 require(graph("./src/index.js").dependencise["./message.js"]) 就是执行外部定义的 require(module) 这个方法,重新递归的去执行,光这样还不够,这只是实现了 require 方法,还差 exports 对象,所以我们再定义一个 exports 对象
return ` (function (graph) { // 定义 require 方法 function require(module) { // 相对路径转换 function localRequire(relativePath) { return require(graph[module].dependencise[relativePath]) } var exports = {}; (function (require, exports, code) { eval(code) })(localRequire, exports, graph[module].code) return exports }; require("${entry}") })(${graph}) `
最后要记得 return exports 将 exports 导出,这样下一个模块在引入这个模块的时候才能拿到导出的结果,现在代码生成的流程就写完了,最终返回的是一个大的字符串,保存再次运行 node bundle.js | highlight
这里我是 windows 环境,将输出完的代码直接放到浏览器里不行,我就把压缩的代码格式化成下面这种样子,再放到浏览器里就能输出成功了
;(function(graph) { function require(module) { function localRequire(relativePath) { return require(graph[module].dependencise[relativePath]) } var exports = {} ;(function(require, exports, code) { eval(code) })(localRequire, exports, graph[module].code) return exports } require("./src/index.js") })({ "./src/index.js": { dependencise: { "./message.js": ".srcmessage.js" }, code: ""use strict"; var _message = _interopRequireDefault(require("./message.js")); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } console.log(_message.default);" }, ".srcmessage.js": { dependencise: { "./word.js": ".srcword.js" }, code: ""use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.default = void 0; var _word = require("./word.js"); var message = "say ".concat(_word.word); var _default = message; exports.default = _default;" }, ".srcword.js": { dependencise: {}, code: ""use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.word = void 0; var word = "hello"; exports.word = word;" } })
将上面代码放入浏览器的控制台中,回车就能输出 say hello
总结这就是打包工具打包后的内容,期间涉及了 node 知识,使用 babel 来转译 ast(抽象语法树),最后的 generateCode 函数涉及到了递归和闭包,形参和实参,需要大家多看几遍,加深理解
To Be Continued 个人博客 24 个实例入门并掌握「Webpack4」(一) 24 个实例入门并掌握「Webpack4」(二)文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/110207.html
摘要:前言此项目总共小节,目录搭建项目并打包文件生产和开发模式覆盖默认用转译自动生成文件处理文件图片处理汇总处理第三方库开发模式与开发模式和生产模式实战打包自定义函数库配置配置配置使用加快打包速度多页面打包配置编写编写编写前节基于渐进式教程为 前言 此项目总共 24 小节,目录: 搭建项目并打包 JS 文件 生产和开发模式 覆盖默认 entry/output 用 Babel 7 转译 ES...
摘要:代码如下所示按照正常使用习惯,操作来实现样式的添加和卸载,是一贯技术手段。将帮助我们进行操作。 继 24 个实例入门并掌握「Webpack4」(一) 后续: JS Tree Shaking CSS Tree Shaking 图片处理汇总 字体文件处理 处理第三方 js 库 开发模式与 webpack-dev-server 开发模式和生产模式・实战 打包自定义函数库 九、JS Tre...
摘要:介绍背景最近和部门老大,一起在研究团队前端新手村的建设,目的在于帮助新人快速了解和融入公司团队,帮助零基础新人学习和入门前端开发并且达到公司业务开发水平。 showImg(https://segmentfault.com/img/remote/1460000020063710?w=1300&h=646); 介绍 1. 背景 最近和部门老大,一起在研究团队【EFT - 前端新手村】的建设...
摘要:五六月份推荐集合查看最新的请点击集前端最近很火的框架资源定时更新,欢迎一下。苏幕遮燎沈香宋周邦彦燎沈香,消溽暑。鸟雀呼晴,侵晓窥檐语。叶上初阳乾宿雨,水面清圆,一一风荷举。家住吴门,久作长安旅。五月渔郎相忆否。小楫轻舟,梦入芙蓉浦。 五、六月份推荐集合 查看github最新的Vue weekly;请::点击::集web前端最近很火的vue2框架资源;定时更新,欢迎 Star 一下。 苏...
阅读 3000·2021-09-03 10:33
阅读 1157·2019-08-30 15:53
阅读 2584·2019-08-30 15:45
阅读 3351·2019-08-30 14:11
阅读 500·2019-08-30 13:55
阅读 2556·2019-08-29 15:24
阅读 1863·2019-08-26 18:26
阅读 3521·2019-08-26 13:41