当我在前端道路上越走越远的时候,渐渐发现各种厉害的构建工具,比如:webpack,vite,eslint,babel等…,这些牛逼的工具其背后的都离不开,一个叫AST的东西。那什么叫AST?AST(Abstract Syntax Tree)中文叫做抽象语法树。
有人肯定会问了,什么叫抽象语法树? 它为什么抽象了?
回答之前,我们先看一下代码组织结构
const a = 'hello world';
如上code,是我们正常在写的JavaScript代码。细心的人可看到,代码的左边和右边使用 = 号连接的。
在看一下AST抽象语法树转换后的代码
{
"type": "Program",
"start": 0,
"end": 23,
"body": [
{
"type": "VariableDeclaration",
"start": 0,
"end": 23,
"declarations": [
{
"type": "VariableDeclarator",
"start": 6,
"end": 23,
"id": {
"type": "Identifier",
"start": 6,
"end": 7,
"name": "a"
},
"init": {
"type": "Literal",
"start": 10,
"end": 23,
"value": "hello world",
"raw": "'hello world'"
}
}
],
"kind": "const"
}
],
"sourceType": "module"
}
对比转换前后的差别,就可以看出为什么抽象了。
简单理解就是原来我们写的代码有各种分隔符号组合而成,而转换后的代码没有了分隔符符关联,使用的是json描述的所以是抽象语法树。没有分隔符了那太抽象了...
什么叫AST抽象语法树简单的理解就是将字符串解析成json,整理成的json(清爽)比直接解析字符串简单的多测试网站。
JavaScript转换AST工具
对于JavaScript而言,可以通过JS Parser将JS代码转换成AST。目前比较常见的JS Parser如下:
- esprima(流行库)
- Babylon(babel中使用)
- acorn(webpack中使用)
- espree(在acorn基础上衍生而来,eslint中使用)
- astexplorer(在线生成工具,可选不同的JS Parser实时查看)
本文中的例子均是使用esprima来实现。
如何将代码转换成AST
在将代码转换成AST的过程中,有两个重要的阶段:词法分析(Lexical Analysis)和语法分析(Syntax Analysis)。
词法分析
也称为分词,是将字符串形式的代码转换为标记(token)序列的过程。这里的 token 是一个字符串,是构成源代码的最小单位,类似于英语中单词。词法分析也可以理解成将英文字母组合成单词的过程。词法分析过程中不会关心单词之间的关系。比如:词法分析过程中能够将括号标记成token,但并不会校验括号是否匹配。
JavaScript中的token主要包含以下几种:
- 关键字:var、let、const等
- 标识符:没有被引号括起来的连续字符,可能是一个变量,也可能是 if、else 这些关键字,又或者是 true、false 这些内置常量
- 运算符: +、-、 *、/ 等
- 数字:像十六进制,十进制,八进制以及科学表达式等
- 字符串:变量的值等
- 空格:连续的空格,换行,缩进等
- 注释:行注释或块注释都是一个不可拆分的最小语法单元
- 标点:大括号、小括号、分号、冒号等
上述const a = 'hello world'经过语法分析后生成的AST如下:
[ { "type": "Keyword", "value": "const" }, { "type": "Identifier", "value": "a" }, { "type": "Punctuator", "value": "=" }, { "type": "String", "value": "'hello world'" }]
语法分析
也称为解析器,是将词法分析产生的token按照某种给定的形式文法转换成AST的过程。也就是把单词组合成句子的过程。在转换过程中会验证语法,语法如果有错的话,会抛出语法错误。
上述const a = 'hello world'经过语法分析后生成的AST如下:
{
"type": "Program",
"body": [
{
"type": "VariableDeclaration",
"declarations": [
{
"type": "VariableDeclarator",
"id": {
"type": "Identifier",
"name": "a"
},
"init": {
"type": "Literal",
"value": "hello world",
"raw": "'hello world'"
}
}
],
"kind": "const"
}
],
"sourceType": "script"
}
在拿到了AST后,我们就可以分析AST,在此基础上做一些自己的事情。比如最简单的将代码中的某一变量都替换成另一个名字。
实践
下面我们来实现将上述代码中定义的变量a替换成变量b。要实现这个需求,我们需要将源代码转换成AST,然后在此基础上进行一些操作,更改树的内容,之后再把AST转换成目标代码。也就是要经历解析 -> 转换 -> 生成的过程。
首先我们需要分析源代码生成的AST和目标代码生成的AST具体有何不同。 以下是const b = 'hello world'生成的AST:
{
"type": "Program",
"body": [
{
"type": "VariableDeclaration",
"declarations": [
{
"type": "VariableDeclarator",
"id": {
"type": "Identifier",
"name": "b" // 这里不同
},
"init": {
"type": "Literal",
"value": "hello world",
"raw": "'hello world'"
}
}
],
"kind": "const"
}
],
"sourceType": "script"
}
通过对比分析,发现唯一的不同就是type为Identifier的id的name属性值不一样。接下来就可以通过修改AST来实现我们的需求了。
我们需要安装estraverse(遍历AST)和escodegen(根据AST生成JS)这两个包。
const esprima = require('esprima');
const estraverse = require('estraverse');
const escodegen = require('escodegen');
const program = "const a = 'hello world'";
const ASTree = esprima.parseScript(program);
function changeAToB(node) {
if (node.type === 'Identifier') {
node.name = 'b';
}
}
estraverse.traverse(ASTree, {
enter(node) {
changeAToB(node);
}
});
const ASTreeAfterChange = escodegen.generate(ASTree);
console.log(ASTreeAfterChange); // const b = 'hello world'
看,是不是很容易就可以实现。掌握了AST的知识后,我们能做很多事情,各种babel的插件也是这么产生的,只不过用的库不一样。
如何实现一个babel插件可以参考官方Babel 插件手册