造轮子利器：AST与前端编译

作者:匿名更新于： 2022-12-07 16:17:35

　　为了补充这些缺少的部分，接下来移动到下一个单词，生成token，并且将其转换成子节点，添加进现有的ast中，然后重复这个 移动&生成 的递归的过程。

　　本文为来自 字节教育-成人与创新前端团队 成员的文章，已授权 ELab 发布。

　　简介

　　在计算机科学中，抽象语法树是源代码语法结构的一种抽象表示。它以树状的形式表现编程语言的语法结构，树上的每个节点都表示源代码中的一种结构。之所以说语法是“抽象”的，是因为这里的语法并不会表示出真实语法中出现的每个细节。

　　——维基百科

　　在前端基建中，ast可以说是必不可少的。对ast进行操作，其实就相当于对源代码进行操作。

　　ast的应用包括：

　　1.开发辅助：eslint、prettier、ts检查

　　2.代码变更：压缩、混淆、css modules

　　3.代码转换：jsx、vue、ts转换为js

　　ast的生成

　　通过词法分析和语法分析，可以得出一颗ast。

　　1.词法分析

　　词法分析的过程是将代码喂给有限状态机，结果是将代码单词转换为令牌(token)，一个token包含的信息包括其的种类、属性值等。

　　例如将 ​​const a = 1 + 1​​ 转换为token的话，结果大概如下

　　复制

　　1.  [

　　2.  {type: 关键字, value: const},

　　3.  {type: 标识符, value: a},

　　4.  {type: 赋值操作符, value: =},

　　5.  {type: 常数, value: 1},

　　6.  {type: 运算符, value: +},

　　7.  {type: 常数, value: 1},

　　8.  ]

　　2.语法分析

　　面对一串代码，先通过词法分析，获得第一个token，为其建立一个ast节点，此时的ast节点的属性以及子节点都不完整。

　　为了补充这些缺少的部分，接下来移动到下一个单词，生成token，并且将其转换成子节点，添加进现有的ast中，然后重复这个 移动&生成 的递归的过程。

　　让我们来看看const a = 1是怎么变成一颗ast的。

　　1.读取const，生成一个VariableDeclaration节点

　　2.读取a，新建VariableDeclarator节点

　　3.读取=

　　4.读取1，新建NumericLiteral节点

　　5.将NumericLiteral赋值给VariableDeclarator的init属性

　　6.将VariableDeclarator赋值给VariableDeclaration的declaration属性

　　前端编译

　　随着前端技术和理念的不断进步，涌现了各种新奇的代码以及带来了新的项目组织方式。

　　但在这些新技术中，有许多代码不能在浏览器中直接执行，比如typescript、jsx等，这种情况下我们的项目就需要通过编译、打包，将其转换为可以直接在浏览器中执行的代码。

　　以webpack为例，打包工具作用就是基于代码的import、export、require构建依赖树，将其做成一个或多个bundles。它解决的是模块化的问题，但它自带的能力只能支持javascript以及json文件，而平时我们遇到的ts、jsx、vue文件，则需要先经过编译工具的编译。例如如果我们想用webpack对含有ts文件的项目进行打包，进行如下配置。

　　复制

　　1.  // webpack.config.js

　　2.  const path = require('path');

      3.

　　4.  module.exports = {

　　5.  // ...

　　6.  module: {

　　7.  rules: [{

　　8.  test: /.ts$/,

　　9.  use: 'babel-loader',

　　10.  options: {

　　11.  presets: [

　　12.  '@babel/typescript'

　　13.  ]

　　14.  }

　　15.  }],

　　16.  },

　　17.  };

　　配置的含义则是：当webpack解析到.ts文件时，先使用babel-loader进行转换，再进行打包。

　　操作ast进行代码编译

　　​编译工具​

　　常见的编译工具有这几种

　　1.babel：目前最主流的编译工具，使用javascript编写。

　　2.esbuild：使用Go语言开发的打包工具(也包含了编译功能), 被Vite用于开发环境的编译。

　　3.swc：使用rust编写的编译工具。

　　在对外提供直接操作ast的能力上，babel和swc使用的是访问者模式，插件编写上有较多的共通之处，最大的区别就是语言不同。esbuild没有对外提供直接操作ast的能力，但是可以通过接入其他的编译工具达到操作ast的效果。

　　编译过程

　　代码编译的过程分为三步，接(parse)、化(transform)、发(generate)

　　parse的过程则是上文中提到的，将代码从字符串转化为树状结构的ast。

　　transform则是对ast节点进行遍历，遍历的过程中对ast进行修改。

　　generate则是将被修改过的ast，重新生成为代码。

　　编译插件

　　一般我们提起babel，就会想到是用来将新标准的js转化为兼容性更高的旧标准js。

　　如果babel默认的编译效果不能满足我们的需求，那我们要如何插手编译过程，将ast修改成我们想要的ast呢。此时就需要用到babel plugin，也就是babel插件。

　　就如同上文中的配置

　　复制

　　1.  const path = require('path');

      2.

　　3.  module.exports = {

　　4.  module: {

　　5.  rules: [{

　　6.  test: /.ts$/,

　　7.  use: 'babel-loader',

　　8.  options: {

　　9.  presets: [

　　10.  // presets也就是已经配置好的插件集合,也就是“预设”

　　11.  '@babel/preset-typescript'

　　12.  ]

　　13.  }

　　14.  }],

　　15.  },

　　16.  };

　　除了以上将typescript转换为javscript的插件外，日常中我们还会用到许多其他的插件/预设，例如

• 　　@babel/react 转换react文件
• 　　react-refresh/babel 热刷新
• 　　babel-plugin-react-css-modules css模块化 避免样式污染
• 　　istanbul 收集代码覆盖率
• 　　......

　　Hello plugin!

　　babel在将代码转换为ast后，会对ast进行遍历，在遍历时，会应用插件所提供的访问者对相应的ast节点进行访问，以达到修改ast的目的。

　　我们在编写插件时，首先我们需要知道我们想要访问的ast节点对应的类型是什么。假如我们要对函数类型的ast节点进行修改，先来看看这一段代码经过babel的转换以后会生成什么样的ast。

　　https://astexplorer.net/

　　复制

　　1.  function a() {};

　　2.  const b = function() {

　　3.  }

　　4.  const c = () => {};

　　ast：(删除部分结构后)

　　复制

　　1.  [

　　2.  {

　　3.  "type": "FunctionDeclaration",

　　4.  "id": {

　　5.  "type": "Identifier",

      6.

　　7.  "name": "a"

　　8.  }

　　9.  },

　　10.  {

　　11.  "type": "VariableDeclaration",

　　12.  "declarations": [

　　13.  {

　　14.  "type": "VariableDeclarator",

　　15.  "id": {

　　16.  "type": "Identifier",

　　17.   "name": "b"

　　18.  },

　　19.   "init": {

　　20.  "type": "FunctionExpression",

　　21.  }

　　22.  }

　　23.  ],

　　24.  "kind": "const"

　　25.  },

　　26.  {

　　27.  "type": "VariableDeclaration",

　　28.  "declarations": [

　　29.  {

　　30.  "type": "VariableDeclarator",

　　31.  "id": {

　　32.  "type": "Identifier",

　　33.  "name": "c"

　　34.  },

　　35.  "init": {

　　36.  "type": "ArrowFunctionExpression",

　　37.  }

　　38.  }

　　39.  ],

　　40.  "kind": "const"

　　41.  }

　　42.  ]

　　新建my-plugin.js，在其中编写如下代码，对外暴露出访问者，babel在遍历到对应节点时会调用相应的访问者。

　　复制

　　1.  // my-plugin.js

　　2.  module.exports = () => ({

　　3.  visitor: {

　　4.  // 对一种ast节点进行访问

　　5.  FunctionDeclaration: {

　　6.  enter: enterFunction,

　　7.  // 在babel对ast进行深度优先遍历时，

　　8.  // 我们有enter和exit两次机会访问同一个ast节点。

　　9.  exit: exitFunction

　　10.  },

　　11.  // 对多种ast节点进行访问

　　12.  "FunctionDeclaration|FunctionExpression|ArrowFunctionExpression": {

　　13.  enter: enterFunction

　　14.  }

　　15.  // 使用“别名”进行访问

　　16.  Function: enterFunction

　　17.  }

　　18.  })

      19.

　　20.  function enterFunction() {

　　21.  console.log('hello plugin!')

　　22.  };

　　23.  function exitFunction() {};

　　接入插件

　　复制

　　1.  // .babelrc

　　2.  {

　　3.  "plugins": [

　　4.  './my-plugin.js'

　　5.  ]

　　6.  }

　　实践

　　接下来我们来通过编写一个完整的babel插件来看看如何对ast进行修改：打印出函数的执行时间

　　代码：

　　复制

　　1.  async function a() {

　　2.  function b() {

　　3.  for (let i = 0; i < 10000000; i += Math.random()) {}

　　4.  }

　　5.  b();

　　6.  await new Promise(resolve => {

　　7.  setTimeout(resolve, 1000);

　　8.  })

　　9.  }

　　运行效果：

　　复制

　　1.  b cost: 219 // 函数b耗时219毫秒

　　2.  anonymous cost: 0 // promise中的匿名函数耗时0毫秒

　　3.  a cost: 1222 // 函数a耗时1222毫秒

　　实现思路：在函数的第一行，插入一个ast节点，定义一个变量记录刚开始执行函数的时间。在函数的的最后一行，以及return时，打印出当前时间与开始时间的差。

　　新增&插入节点

　　除了手写一个ast节点以外我们可以通过两种babel为我们提供的辅助工具生成ast节点

　　@babel/types

　　一个工具集，可以用来新建、校验节点等。

　　在这里我们需要新建一个 var fnName_start_time = Date.now()的ast节点。

　　复制

　　1.  import * as t from 'babel-types';

      2.

　　3.  function functionEnter(path, state) {

　　4.  const node = path.node;

　　5.  const fnName = node.name || node.id?.name || 'anonymous';

　　6.  // 新建一个变量声明

　　7.  const ast = t.variableDeclarator(

　　8.  // 变量名

　　9.  t.identifier(`${fnName}_start_time`),

　　10.  // Date.now()

　　11.  t.callExpression(

　　12.  t.memberExpression(

　　13.  t.identifier('Date'),

　　14.  t.identifier('now')

　　15.  ),

　　16.  // 参数为空

　　17.  []

　　18.  )

　　19.  );

　　20.  }

　　@babel/template

　　通过模板的方式，可以直接将代码转换成ast，也可以替换掉模版中的节点，方便快捷。

　　复制

　　1.  import template from "babel-template";

      2.

　　3.  const varName = `${fnName}_start_time`;

　　4.  // 直接通过代码生成

　　5.  const ast = template(`const ${varName} = Date.now()`)();

　　6.  // 或者

　　7.  const ast = template('const fnName = Date.now()')({

　　8.  fnName: t.identifier(varName)

　　9.  })

　　在生成了我们想要的ast节点后，我们可以将其插入到我们现有的节点中。

　　复制

　　1.  function functionEnter(path, state) {

　　2.  const node = path.node;

　　3.  const fnName = node.name || node.id?.name || 'anonymous';

　　4.  const varName = `${fnName}_start_time`;

　　5.  const start = template(`const ${varName} = Date.now()`)();

　　6.  const end = template(

　　7.  `console.log('${fnName} cost:', Date.now() - ${varName})`

　　8.  )();

      9.

　　10.  if (!node.body) {

　　11.  return;

　　12.  }

　　13.  // 插入到容器中，函数的第一行添加const fnName_start_time = Date.now()

　　14.  path.get('body').unshiftContainer('body', start);

　　15.  path.get('body').pushContainer('body', end);

　　16.  }

      17.

　　18.  module.exports = () => ({

　　19.  visitor: {

　　20.  Function: enterFunction

　　21.  }

　　22.  })

　　主动遍历&停止遍历&状态

　　虽然我们在函数的第一行和最后一行添加了相应的代码，但是还是不能完整的实现我们需要的功能——如果函数在执行最后一行之前进行了return，则不能打印出耗时数据。

　　找出该函数进行return的ast节点，在return之前，先把函数的耗时打印出来。

　　复制

　　1.  function a() {

　　2.  if (Math.random() > 0.5) {

　　3.  // 需要逮出来的return

　　4.  return 'a';

　　5.  }

　　6.  function b() {

　　7.  // 需要跳过的return

　　8.   return 'b';

　　9.  }

　　10.  }

　　通过主动遍历的方法，我们把returnStatement的访问者放到Function的访问者中。

　　当我们进行主动遍历时，需要跳过子节点中的函数节点的遍历，因为我们的目的只是在遍历函数a节点时，访问其return，而不想去修改子函数节点的return。

　　复制

　　1.  function functionEnter(path, state) {

　　2.  // 主动遍历

　　3.  path.traverse({

　　4.  // 访问遍历到子函数，则跳过子函数及其的子节点遍历

　　5.  Function(innerPath) {

　　6.   innerPath.skip();

　　7.  },

　　8.  // 访问类型为ReturnStatement的子节点

　　9.  ReturnStatement: returnEnter

　　10.  // 传递状态

　　11.  }, { fnName })

　　12.  }

      13.

　　14.  function returnEnter(path, state) {

　　15.  // 读取状态

　　16.  const { fnName } = state;

      17.

　　18.  // 代码为resutn xxx; 新建 const fnName_result = xxx 的节点

　　19.  const resultVar = t.identifier(`${fnName}_result`);

　　20.  const returnResult = template(`const RESULT_VAR = RESULT`)({

　　21.  RESULT_VAR: resultVar,

　　22.  RESULT: path.node.argument || t.identifier('undefined')

　　23.  })

      24.

　　25.  // 插入兄弟节点

　　26.  path.insertBefore(returnResult);

      27.

　　28.  // 修改return xxx为

　　29.  // return (console.log('耗时'), fnName_result)

　　30.  const varName = `${fnName}_start_time`;

　　31.  const end = template(

　　32.  `console.log('${fnName} cost:', Date.now() - ${varName})`

　　33.   )();

　　34.  const ast = t.sequenceExpression([

　　35.  end.expression,

　　36.  resultVar

　　37.  ]);

　　38.  path.node.argument = ast;

　　39.  }

　　最终效果

　　复制

　　1.  // 原代码

　　2.  function a() {

　　3.  function b() {

　　4.  for (let i = 0; i < 10000000; i += Math.random()) {}

　　5.  function c() {

　　6.  for (let i = 0; i < 10000000; i += Math.random()) {}

　　7.  }

　　8.  return c();

　　9.  }

　　10.  b();

　　11.  for (let i = 0; i < 10000000; i += Math.random()) {}

　　12.  }

　　复制

　　1.  // 经过babel编译的代码

　　2.  function a() {

　　3.  var a_start_time = Date.now();

　　4.  function b() {

　　5.  var b_start_time = Date.now();

　　6.  for (var i = 0; i < 10000000; i += Math.random()) {}

　　7.  function c() {

　　8.  var c_start_time = Date.now();

　　9.  for (var _i = 0; _i < 10000000; _i += Math.random()) {}

　　10.  console.log('c cost:', Date.now() - c_start_time);

　　11.  }

　　12.  var b_result = c();

　　13.  return console.log('b cost:', Date.now() - b_start_time), b_result;

　　14.  console.log('b cost:', Date.now() - b_start_time);

　　15.  }

　　16.  b();

　　17.  for (var i = 0; i < 10000000; i += Math.random()) {}

　　18.  console.log('a cost:', Date.now() - a_start_time);

　　19.  }

　　20.  // 运行后控制台打印结果

　　21.  c cost: 290

　　22.  b cost: 603

　　23.  a cost: 895

　　来源： ELab团队

  　　>>>>>>点击进入编程语言专题