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

发表于 1年以前  | 总阅读数:293 次

简介

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

——维基百科

在前端基建中,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的话,结果大概如下

[
  {type: 关键字, value: const}, 
  {type: 标识符, value: a},
  {type: 赋值操作符, value: =},
  {type: 常数, value: 1},
  {type: 运算符, value: +}, 
  {type: 常数, value: 1},
]

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文件的项目进行打包,进行如下配置。

// webpack.config.js
const path = require('path');

module.exports = {
  // ...
  module: {
    rules: [{ 
      test: /.ts$/,
      use: 'babel-loader',
      options: {
            presets: [
              '@babel/typescript'
            ]
      }
    }],
  },
};

配置的含义则是:当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插件。

就如同上文中的配置

const path = require('path');

module.exports = {
  module: {
    rules: [{ 
      test: /.ts$/,
      use: 'babel-loader',
      options: {
            presets: [
              // presets也就是已经配置好的插件集合,也就是“预设”
              '@babel/preset-typescript'
            ]
      }
    }],
  },
};

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

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

Hello plugin!

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

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

https://astexplorer.net/

function a() {};
const b = function() {
}
const c = () => {};

ast:(删除部分结构后)

 [
    {
        "type": "FunctionDeclaration",
        "id": {
            "type": "Identifier",

            "name": "a"
        }
    },
    {
        "type": "VariableDeclaration",
        "declarations": [
            {
                "type": "VariableDeclarator",
                "id": {
                    "type": "Identifier",
                    "name": "b"
                },
                "init": {
                    "type": "FunctionExpression",
                }
            }
        ],
        "kind": "const"
    },
    {
        "type": "VariableDeclaration",
        "declarations": [
            {
                "type": "VariableDeclarator",
                "id": {
                    "type": "Identifier",
                    "name": "c"
                },
                "init": {
                    "type": "ArrowFunctionExpression",
                }
            }
        ],
        "kind": "const"
    }
]

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

// my-plugin.js
module.exports = () => ({
    visitor: {
        // 对一种ast节点进行访问
        FunctionDeclaration: {
            enter: enterFunction,
            // 在babel对ast进行深度优先遍历时,
            // 我们有enter和exit两次机会访问同一个ast节点。 
            exit: exitFunction
        },
        // 对多种ast节点进行访问
        "FunctionDeclaration|FunctionExpression|ArrowFunctionExpression": {
            enter: enterFunction
        }
        // 使用“别名”进行访问
        Function: enterFunction
    }
})

function enterFunction() {
    console.log('hello plugin!')
};
function exitFunction() {};

接入插件

// .babelrc
{
    "plugins": [
        './my-plugin.js'
    ]
}

实践

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

代码:


async function a() {
    function b() {
        for (let i = 0; i < 10000000; i += Math.random()) {}
    }
    b();
    await new Promise(resolve => {
        setTimeout(resolve, 1000);
    })
}

运行效果:

b cost: 219 // 函数b耗时219毫秒
anonymous cost: 0 // promise中的匿名函数耗时0毫秒
a cost: 1222 // 函数a耗时1222毫秒

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

新增&插入节点

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

  1. @babel/types

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

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

import * as t from 'babel-types';

function functionEnter(path, state) {
    const node = path.node;
    const fnName = node.name || node.id?.name || 'anonymous';
    // 新建一个变量声明
    const ast = t.variableDeclarator(
        // 变量名
        t.identifier(`${fnName}_start_time`),
        // Date.now()
        t.callExpression(
            t.memberExpression(
                t.identifier('Date'),
                t.identifier('now')
            ),
            // 参数为空
            []
        )
    );
}

2 . @babel/template

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

import template from "babel-template";

const varName = `${fnName}_start_time`;
// 直接通过代码生成
const ast = template(`const ${varName} = Date.now()`)();
// 或者
const ast = template('const fnName = Date.now()')({
    fnName: t.identifier(varName)
})

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

function functionEnter(path, state) {
    const node = path.node;
    const fnName = node.name || node.id?.name || 'anonymous';
    const varName = `${fnName}_start_time`;
    const start = template(`const ${varName} = Date.now()`)();
    const end = template(
        `console.log('${fnName} cost:', Date.now() - ${varName})`
    )();

    if (!node.body) {
        return;
    }
    // 插入到容器中,函数的第一行添加const fnName_start_time = Date.now()
    path.get('body').unshiftContainer('body', start);
    path.get('body').pushContainer('body', end);
}

module.exports = () => ({
    visitor: {
        Function: enterFunction
    }
})

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

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

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

function a() {
    if (Math.random() > 0.5) {
        // 需要逮出来的return
        return 'a';
    }
    function b() {
        // 需要跳过的return
        return 'b';
    }
}

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

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

function functionEnter(path, state) {
    // 主动遍历
    path.traverse({
        // 访问遍历到子函数,则跳过子函数及其的子节点遍历
        Function(innerPath) {
            innerPath.skip();
        },
        // 访问类型为ReturnStatement的子节点
        ReturnStatement: returnEnter
        // 传递状态
    }, { fnName })
}

function returnEnter(path, state) {
    // 读取状态
    const { fnName } = state;

    // 代码为resutn xxx; 新建 const fnName_result = xxx 的节点
    const resultVar = t.identifier(`${fnName}_result`);
    const returnResult = template(`const RESULT_VAR = RESULT`)({
        RESULT_VAR: resultVar,
        RESULT: path.node.argument || t.identifier('undefined')
    })

    // 插入兄弟节点
    path.insertBefore(returnResult);

    // 修改return xxx为
    // return (console.log('耗时'), fnName_result)
    const varName = `${fnName}_start_time`;
    const end = template(
        `console.log('${fnName} cost:', Date.now() - ${varName})`
    )();
    const ast = t.sequenceExpression([
        end.expression,
        resultVar
    ]);
    path.node.argument = ast;
}

最终效果

// 原代码
function a() {
    function b() {
        for (let i = 0; i < 10000000; i += Math.random()) {}
        function c() {
            for (let i = 0; i < 10000000; i += Math.random()) {}
        }
        return c();
    }
    b();
    for (let i = 0; i < 10000000; i += Math.random()) {}
}
// 经过babel编译的代码
function a() {
  var a_start_time = Date.now();
  function b() {
    var b_start_time = Date.now();
    for (var i = 0; i < 10000000; i += Math.random()) {}
    function c() {
      var c_start_time = Date.now();
      for (var _i = 0; _i < 10000000; _i += Math.random()) {}
      console.log('c cost:', Date.now() - c_start_time);
    }
    var b_result = c();
    return console.log('b cost:', Date.now() - b_start_time), b_result;
    console.log('b cost:', Date.now() - b_start_time);
  }
  b();
  for (var i = 0; i < 10000000; i += Math.random()) {}
  console.log('a cost:', Date.now() - a_start_time);
}
// 运行后控制台打印结果
c cost: 290
b cost: 603
a cost: 895

❤️ 谢谢支持

以上便是本次分享的全部内容,希望对你有所帮助^_^

喜欢的话别忘了 分享、点赞、收藏 三连哦~。

本文由哈喽比特于1年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/tDIIZUV4sDZ0lkPX0FPAHQ

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:6月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:6月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:6月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:6月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:6月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:6月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:6月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:6月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:6月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:6月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:6月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:6月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:6月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:6月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:6月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:6月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:6月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:6月以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  236811次阅读
vscode超好用的代码书签插件Bookmarks 1年以前  |  6657次阅读
 目录