本文会带你简单的认识一下webpack的loader,动手实现一个利用md转成抽象语法树,再转成html字符串的loader。顺便简单的了解一下几个style-loader,vue-loader,babel-loader的源码以及工作流程。
loader简介
webpack允许我们使用loader来处理文件,loader是一个导出为function的node模块。可以将匹配到的文件进行一次转换,同时loader可以链式传递。
loader文件处理器是一个CommonJs风格的函数,该函数接收一个 String/Buffer 类型的入参,并返回一个 String/Buffer 类型的返回值。
loader 的配置的两种形式
方案1:
1 |
|
方法2(右到左地被调用)
1 | // module |
当链式调用多个 loader 的时候,请记住它们会以相反的顺序执行。取决于数组写法格式,从右向左或者从下向上执行。像流水线一样,挨个处理每个loader,前一个loader的结果会传递给下一个loader,最后的 Loader 将处理后的结果以 String 或 Buffer 的形式返回给 compiler。
使用 loader-utils 能够编译 loader 的配置,还可以通过 schema-utils 进行验证
1 | import { getOptions } from 'loader-utils'; |
- content: 表示源文件字符串或者buffer
- map: 表示sourcemap对象
- meta: 表示元数据,辅助对象
同步loader
同步 loader,我们可以通过return和this.callback返回输出的内容1
2
3
4
5module.exports = function(content, map, meta) {
//一些同步操作
outputContent=someSyncOperation(content)
return outputContent;
}
如果返回结果只有一个,也可以直接使用 return 返回结果。但是,如果有些情况下还需要返回其他内容,如sourceMap或是AST语法树,这个时候可以借助webpack提供的api this.callback
1 | module.exports = function(content, map, meta) { |
第一个参数必须是 Error 或者 null
第二个参数是一个 string 或者 Buffer。
可选的:第三个参数必须是一个可以被这个模块解析的 source map。
可选的:第四个选项,会被 webpack 忽略,可以是任何东西【可以将抽象语法树(abstract syntax tree - AST)(例如 ESTree)作为第四个参数(meta),如果你想在多个 loader 之间共享通用的 AST,这样做有助于加速编译时间。】。
异步loader
异步loader,使用 this.async 来获取 callback 函数。
1 | // 让 Loader 缓存 |
详情请参考官网API
开发一个简单的md-loader
1 | const marked = require("marked"); |
上述的例子是通过现成的插件把markdown文件里的content转成html字符串,但是如果没有这个插件,改怎么做呢?这个情况下,我们可以考虑另外一种解法,借助 AST 语法树,来协助我们更加便捷地操作转换。
利用 AST 作源码转换
markdown-ast是将markdown文件里的content转成数组形式的抽象语法树节点,操作 AST 语法树远比操作字符串要简单、方便得多:
1 | const md = require('markdown-ast');//通过正则的方法把字符串处理成直观的AST语法树 |
md通过正则切割的方法转成抽象语树
1 | const md = require('markdown-ast');//md通过正则匹配的方法把buffer转抽象语法树 |
ast抽象语法数转成html字符串
loader的一些开发技巧
- 尽量保证一个loader去做一件事情,然后可以用不同的loader组合不同的场景需求
- 开发的时候不应该在 loader 中保留状态。loader必须是一个无任何副作用的纯函数,loader支持异步,因此是可以在 loader 中有 I/O 操作的。
- 模块化:保证 loader 是模块化的。loader 生成模块需要遵循和普通模块一样的设计原则。
合理的使用缓存
合理的缓存能够降低重复编译带来的成本。loader 执行时默认是开启缓存的,这样一来, webpack 在编译过程中执行到判断是否需要重编译 loader 实例的时候,会直接跳过 rebuild 环节,节省不必要重建带来的开销。
但是当且仅当有你的 loader 有其他不稳定的外部依赖(如 I/O 接口依赖)时,可以关闭缓存:1
this.cacheable&&this.cacheable(false);
loader-runner是一个非常实用的工具,用来开发、调试loader,它允许你不依靠 webpack 单独运行 loaderinstall loader-runner --save-dev``` 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15```js
// 创建 run-loader.js
const fs = require("fs");
const path = require("path");
const { runLoaders } = require("loader-runner");
runLoaders(
{
resource: "./readme.md",
loaders: [path.resolve(__dirname, "./loaders/md-loader")],
readResource: fs.readFile.bind(fs),
},
(err, result) =>
(err ? console.error(err) : console.log(result))
);
执行 node run-loader
认识更多的loader
style-loader源码简析
作用:把样式插入到DOM中,方法是在head中插入一个style标签,并把样式写入到这个标签的 innerHTML 里
看下源码。
先去掉option处理代码,这样就比较清晰明了了
返回一段js代码,通过require来获取css内容,再通过addStyle的方法把css插入到dom里
自己实现一个简陋的style-loader.js
1 | module.exports.pitch = function (request) { |
需要说明的是,正常我们都会用default的方法,这里用到pitch方法。pitch 方法有一个官方的解释在这里 pitching loader。简单的解释一下就是,默认的loader都是从右向左执行,用 pitching loader 是从左到右执行的。
1 | { |
为什么要先执行style-loader呢,因为我们要把css-loader拿到的内容最终输出成CSS样式中可以用的代码而不是字符串。
addstyle.js
1 | module.exports = function (content) { |
babel-loader源码简析
首先看下跳过loader的配置处理,看下babel-loader输出
上图我们可以看到是输出transpile(source, options)的code和map
再来看下transpile方法做了啥
babel-loader是通过babel.transform来实现对代码的编译的,
这么看来,所以我们只需要几行代码就可以实现一个简单的babel-loader
1 | const babel = require("babel-core") |
vue-loader源码简析
vue单文件组件(简称sfc)
1 |
|