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

本文为来自 字节教育-成人与创新前端团队 成员的文章，已授权 ELab 发布。,在计算机科学中，抽象语法树是源代码语法结构的一种抽象表示。它以树状的形式表现编程语言的语法结构，树上的每个节点都表示源代码中的一种结构。之所以说语法是“抽象”的，是因为这里的语法并不会表示出真实语法中出现的每个细节。,——维基百科,在前端基建中，ast可以说是必不可少的。对ast进行操作，其实就相当于对源代码进行操作。,ast的应用包括：,通过词法分析和语法分析，可以得出一颗ast。,词法分析的过程是将代码喂给有限状态机，结果是将代码单词转换为令牌（token），一个token包含的信息包括其的种类、属性值等。,例如将 ​​const a = 1 + 1​​ 转换为token的话，结果大概如下,面对一串代码，先通过词法分析，获得第一个token，为其建立一个ast节点，此时的ast节点的属性以及子节点都不完整。,为了补充这些缺少的部分，接下来移动到下一个单词，生成token，并且将其转换成子节点，添加进现有的ast中，然后重复这个 移动&生成 的递归的过程。,随着前端技术和理念的不断进步，涌现了各种新奇的代码以及带来了新的项目组织方式。,但在这些新技术中，有许多代码不能在浏览器中直接执行，比如typescript、jsx等，这种情况下我们的项目就需要通过编译、打包，将其转换为可以直接在浏览器中执行的代码。,以webpack为例，打包工具作用就是基于代码的import、export、require构建依赖树，将其做成一个或多个bundles。它解决的是模块化的问题，但它自带的能力只能支持javascript以及json文件，而平时我们遇到的ts、jsx、vue文件，则需要先经过编译工具的编译。例如如果我们想用webpack对含有ts文件的项目进行打包，进行如下配置。,配置的含义则是：当webpack解析到.ts文件时，先使用babel-loader进行转换，再进行打包。,常见的编译工具有这几种,在对外提供直接操作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插件。,就如同上文中的配置,除了以上将typescript转换为javscript的插件外，日常中我们还会用到许多其他的插件/预设，例如,babel在将代码转换为ast后，会对ast进行遍历，在遍历时，会应用插件所提供的访问者对相应的ast节点进行访问，以达到修改ast的目的。,我们在编写插件时，首先我们需要知道我们想要访问的ast节点对应的类型是什么。假如我们要对函数类型的ast节点进行修改，先来看看这一段代码经过babel的转换以后会生成什么样的ast。,https://astexplorer.net/,ast：（删除部分结构后）,新建my-plugin.js，在其中编写如下代码，对外暴露出访问者，babel在遍历到对应节点时会调用相应的访问者。,接入插件,接下来我们来通过编写一个完整的babel插件来看看如何对ast进行修改：打印出函数的执行时间,代码：,运行效果：,实现思路：在函数的第一行，插入一个ast节点，定义一个变量记录刚开始执行函数的时间。在函数的的最后一行，以及return时，打印出当前时间与开始时间的差。,除了手写一个ast节点以外我们可以通过两种babel为我们提供的辅助工具生成ast节点,@babel/types,一个工具集，可以用来新建、校验节点等。,在这里我们需要新建一个 var fnName_start_time = Date.now()的ast节点。,@babel/template,通过模板的方式，可以直接将代码转换成ast，也可以替换掉模版中的节点，方便快捷。,在生成了我们想要的ast节点后，我们可以将其插入到我们现有的节点中。,主动遍历&停止遍历&状态,虽然我们在函数的第一行和最后一行添加了相应的代码，但是还是不能完整的实现我们需要的功能——如果函数在执行最后一行之前进行了return，则不能打印出耗时数据。,找出该函数进行return的ast节点，在return之前，先把函数的耗时打印出来。,通过主动遍历的方法，我们把returnStatement的访问者放到Function的访问者中。,当我们进行主动遍历时，需要跳过子节点中的函数节点的遍历，因为我们的目的只是在遍历函数a节点时，访问其return，而不想去修改子函数节点的return。,最终效果