本文首发于政采云前端团队博客:前端工程师需要了解的Babel 知识
https://www.zoo.team/article/babel
Babel 是怎么工作的
Babel
是一个
JavaScript
编译器。
做与不做
Babel
只是转译新标准引入的语法,比如:
-
箭头函数
-
let / const
-
解构
-
全局变量
-
Promise
-
Symbol
-
WeakMap
-
Set
-
includes
-
generator 函数
Babel
是不会转译的,需要引入
polyfill
来解决。
Babel 编译的三个阶段
-
解析(Parsing):将代码字符串解析成抽象语法树。
-
转换(Transformation):对抽象语法树进行转换操作。
-
生成(Code Generation): 根据变换后的抽象语法树再生成代码字符串。
Babel
,我们从最简单一句
console
命令下手
解析(Parsing)
Babel
拿到源代码会把代码抽象出来,变成
AST
(抽象语法树),学过编译原理的同学应该都听过这个词,全称是
Abstract Syntax Tree。
console.log('zcy');
的 AST 长这样:
"type": "Program",
"body": [
{
"type": "ExpressionStatement",
"expression": {
"type": "CallExpression",
"callee": {
"type": "MemberExpression",
"computed": false,
"object": {
"type": "Identifier",
"name": "console"
},
"property": {
"type": "Identifier",
"name": "log"
}
},
"arguments": [
{
"type": "Literal",
"value": "zcy",
"raw": "'zcy'"
}
]
}
}
],
"sourceType": "script"
}
AST
描述了源代码的每个部分以及它们之间的关系。
AST 是怎么来的?
-
分词:将整个代码字符串分割成语法单元数组
-
语法分析:建立分析语法单元之间的关系
Javascript
代码中的语法单元主要包括以下这么几种:
-
关键字:
const
、let
、var
等 -
标识符:可能是一个变量,也可能是 if、else 这些关键字,又或者是 true、false 这些常量
-
运算符
-
数字
-
空格
-
注释:对于计算机来说,知道是这段代码是注释就行了,不关心其具体内容
其实分词说白了就是简单粗暴地对字符串一个个遍历。为了模拟分词的过程,写了一个简单的 Demo,仅仅适用于和上面一样的简单代码。Babel 的实现比这要复杂得多,但是思路大体上是相同的。对于一些好奇心比较强的同学,可以看下具体是怎么实现的,链接在文章底部。
function tokenizer(input) {
const tokens = [];
const punctuators = [',', '.', '(', ')', '=', ';'];
let current = 0;
while (current < input.length) {
let char = input[current];
if (punctuators.indexOf(char) !== -1) {
tokens.push({
type: 'Punctuator',
value: char,
});
current++;
continue;
}
// 检查空格,连续的空格放到一起
let WHITESPACE = /\s/;
if (WHITESPACE.test(char)) {
current++;
continue;
}
// 标识符是字母、$、_开始的
if (/[a-zA-Z\$\_]/.test(char)) {
let value = '';
while(/[a-zA-Z0-9\$\_]/.test(char)) {
value += char;
char = input[++current];
}
tokens.push({ type: 'Identifier', value });
continue;
}
// 数字从0-9开始,不止一位
const NUMBERS = /[0-9]/;
if (NUMBERS.test(char)) {
let value = '';
while (NUMBERS.test(char)) {
value += char;
char = input[++current];
}
tokens.push({ type: 'Numeric', value });
continue;
}
// 处理字符串
if (char === '"') {
let value = '';
char = input[++current];
while (char !== '"') {
value += char;
char = input[++current];
}
char = input[++current];
tokens.push({ type: 'String', value });
continue;
}
// 最后遇到不认识到字符就抛个异常出来
throw new TypeError('Unexpected charactor: ' + char);
}
return tokens;
}
const input = `console.log("zcy");`
console.log(tokenizer(input));
{
"type" : "Identifier" ,
"value" : "console"
},
{
"type" : "Punctuator" ,
"value" : "."
},
{
"type" : "Identifier" ,
"value" : "log"
},
{
"type" : "Punctuator" ,
"value" : "("
},
{
"type" : "String" ,
"value" : "'zcy'"
},
{
"type" : "Punctuator" ,
"value" : ")"
},
{
"type" : "Punctuator" ,
"value" : ";"
}
]
Babel
会在解析每个语句和表达式的过程中设置一个暂存器,用来暂存当前读取到的语法单元,如果解析失败,就会返回之前的暂存点,再按照另一种方式进行解析,如果解析成功,则将暂存点销毁,不断重复以上操作,直到最后生成对应的语法树。
转换(Transformation)
Plugins
babel
的转译过程,尤其是第二个阶段
Transformation
,如果这个阶段不使用任何插件,那么
babel
会原样输出代码。
Presets
Babel
官方帮我们做了一些预设的插件集,称之为
Preset
,这样我们只需要使用对应的 Preset 就可以了。每年每个
Preset
只编译当年批准的内容。而
babel-preset-env
相当于 ES2015 ,ES2016 ,ES2017 及最新版本。
Plugin/Preset 路径
node_modules
中。
Plugin/Preset 排序
-
Plugin 会运行在 Preset 之前。
-
Plugin 会从第一个开始顺序执行。
-
Preset 的顺序则刚好相反(从最后一个逆序执行)。
"plugins": [
"transform-decorators-legacy",
"transform-class-properties"
]
}
transform-decorators-legacy
再执行
transform-class-properties
"presets": [
"es2015",
"react",
"stage-2"
]
}
stage-2
,
react
, 最后
es2015
。
presets
和
plugins
同时存在,那执行顺序又是怎样的呢?答案是先执行
plugins
的配置,再执行
presets
的配置。
-
@babel/plugin-proposal-decorators
-
@babel/plugin-proposal-class-properties
-
@babel/plugin-transform-runtime
-
@babel/preset-env
{
"presets": [
[
"@babel/preset-env"
]
],
"plugins": [
[ "@babel/plugin-proposal-decorators", { "legacy": true }],
[ "@babel/plugin-proposal-class-properties", { "loose": true }],
"@babel/plugin-transform-runtime",
]
}
生成(Code Generation)
babel-generator
通过 AST 树生成 ES5 代码。
如何编写一个 Babel 插件
Babel
官方的介绍。
插件格式
Babel
对象作为参数的
Function
开始。
// plugin contents
}
//
}
visitor
属性是这个插件的主要访问者。
return {
visitor: {
// visitor contents
}
};
};
visitor
中的每个函数接收 2 个参数:
path
和
state
return {
visitor: {
CallExpression(path, state) {}
}
};
};
写一个简单的插件
a
的换成
b
,先看下
var a = 1
的 AST
"type": "Program",
"start": 0,
"end": 10,
"body": [
{
"type": "VariableDeclaration",
"start": 0,
"end": 9,
"declarations": [
{
"type": "VariableDeclarator",
"start": 4,
"end": 9,
"id": {
"type": "Identifier",
"start": 4,
"end": 5,
"name": "a"
},
"init": {
"type": "Literal",
"start": 8,
"end": 9,
"value": 1,
"raw": "1"
}
}
],
"kind": "var"
}
],
"sourceType": "module"
}
VariableDeclarator
,下面开始撸代码
return {
visitor: {
VariableDeclarator(path, state) {
if (path.node.id.name == 'a') {
path.node.id = t.identifier( 'b')
}
}
}
}
}
id
属性是 a 的替换成 b 就好了。但是这里不能直接
path.node.id.name = 'b'
。如果操作的是Object,就没问题,但是这里是 AST 语法树,所以想改变某个值,就是用对应的 AST 来替换,现在我们用新的标识符来替换这个属性。
const c = `var a = 1`;
const { code } = babel.transform(c, {
plugins: [
function({ types: t }) {
return {
visitor: {
VariableDeclarator(path, state) {
if (path.node.id.name == 'a') {
path.node.id = t.identifier( 'b')
}
}
}
}
}
]
})
console.log(code); // var b = 1
实现一个简单的按需打包功能
import { Button } from 'antd'
转成
import Button from 'antd/lib/button'
specifiers
里的
type
和
source
不同。
"specifiers": [
{
"type": "ImportSpecifier",
...
}
]
"specifiers": [
{
"type": "ImportDefaultSpecifier",
...
}
]
const c = `import { Button } from 'antd'`;
const { code } = babel.transform(c, {
plugins: [
function({ types: t }) {
return {
visitor: {
ImportDeclaration(path) {
const { node: { specifiers, source } } = path;
if (!t.isImportDefaultSpecifier(specifiers[ 0])) { // 对 specifiers 进行判断,是否默认倒入
const newImport = specifiers.map( specifier => (
t.importDeclaration(
[t.ImportDefaultSpecifier(specifier.local)],
t.stringLiteral( `${source.value}/lib/${specifier.local.name}`)
)
))
path.replaceWithMultiple(newImport)
}
}
}
}
}
]
})
console.log(code); // import Button from "antd/lib/Button";
babel-plugin-import
这个插件是有配置项的,我们可以对代码做以下更改。
return {
visitor: {
ImportDeclaration(path, { opts }) {
const { node: { specifiers, source } } = path;
if (source.value === opts.libraryName) {
// ...
}
}
}
}
}
至此,这个插件我们就编写完成了。
Babel 常用 API
@babel/core
Babel
的编译器,核心 API 都在这里面,比如常见的
transform
、
parse
。
@babel/cli
cli
是命令行工具, 安装了
@babel/cli
就能够在命令行中使用
babel
命令来编译文件。当然我们一般不会用到,打包工具已经帮我们做好了。
@babel/node
node
环境中,运行 ES6 的代码。
babylon
Babel
的解析器。
babel-traverse
babel-types
babel-generator
总结
Babel
编译代码的过程和原理以及简单编写了一个
babel
插件,欢迎大家对内容进行指正和讨论。
招贤纳士
ZooTeam@cai-inc.com
完
觉得文章不错可以分享到朋友圈让更多的小伙伴看到哦~
转载:https://blog.csdn.net/qq_29438877/article/details/101443810