AST实现函数错误的自动上报(原理到实践)，微信web开发者工具

Babel 的运行主要分三个阶段，请牢记：解析->转换->生成，后面会用到。

本文我们将会写一个 Babel plugin 的 npm 包，用于编译时将代码进行改造。

babel-plugin 环境搭建

---

这里我们使用 yeoman 和 generator-babel-plugin 来构建插件的脚手架代码。安装：

$ npm i -g yo

$ npm i -g generator-babel-plugin

然后新建文件夹：

$ mkdir babel-plugin-function-try-actch

$ cd babel-plugin-function-try-actch

生成npm包的开发工程：

$ yo babel-plugin

此时项目结构为：

babel-plugin-function-try-catch

├─.babelrc

├─.gitignore

├─.npmignore

├─.travis.yml

├─README.md

├─package-lock.json

├─package.json

├─test

| ├─index.js

| ├─fixtures

| | ├─example

| | | ├─.babelrc

| | | ├─actual.js

| | | └expected.js

├─src

| └index.js

├─lib

| └index.js

这就是我们的 Babel plugin，取名为 babel-loader-function-try-catch（为方便文章阅读，以下我们统一简称为plugin！）。

至此，npm 包环境搭建完毕，代码地址。

调试 plugin 的 ast

---

开发工具

本文前面说过 Babel 的运行主要分三个阶段：解析->转换->生成，每个阶段 babel 官方提供了核心的 lib：

• babel-core。Babel 的核心库，提供了将代码编译转化的能力。

• babel-types。提供 AST 树节点的类型。

• babel-template。可以将普通字符串转化成 AST，提供更便捷的使用

在 plugin 根目录安装需要用到的工具包：

npm i @babel/core @babel/parser babel-traverse @babel/template babel-types -S

打开 plugin 的 src/index.js 编辑：

const parser = require(“@babel/parser”);

// 先来定义一个简单的函数

let source = `var fn = function (n) {

console.log(111)

}`;

// 解析为 ast

let ast = parser.parse(source, {

sourceType: “module”,

plugins: [“dynamicImport”]

});

// 打印一下看看，是否正常

console.log(ast);

终端执行 node src/index.js 后将会打印如下结果：这就是 fn 函数对应的 ast，第一步解析完成！

获取当前节点的 AST

然后我们使用 babel-traverse 去遍历对应的 AST 节点，我们想要寻找所有的 function 表达可以写在 FunctionExpression 中：

打开 plugin 的 src/index.js 编辑：

const parser = require(“@babel/parser”);

const traverse = require(“babel-traverse”).default;

// mock 待改造的源码

let source = `var fn = function() {

console.log(111)

}`;

// 1、解析

let ast = parser.parse(source, {

sourceType: “module”,

plugins: [“dynamicImport”]

});

// 2、遍历

+ traverse(ast, {

+   FunctionExpression(path, state) { // Function 节点

+     // do some stuff

+   },

+ });

所有函数表达都会走到 FunctionExpression 中，然后我们可以在里面对其进行修改。其中参数 path 用于访问到当前的节点信息 path.node，也可以像 DOM 树访问到父节点的方法 path.parent。

修改当前节点的 AST

好了，接下来要做的是在 FunctionExpression 中去劫持函数的内部代码，然后将其放入 try 函数内，并且在 catch 内加入错误上报 sdk 的代码段。

获取函数体内部代码

上面定义的函数是

var fn = function() {

console.log(111)

}

那么函数内部的代码块就是 console.log(111)，可以使用 path 拿到这段代码的 AST 信息，如下：

const parser = require(“@babel/parser”);

const traverse = require(“babel-traverse”).default;

// mock 待改造的源码

let source = `var fn = function(n) {

console.log(111)

}`;

// 1、解析

let ast = parser.parse(source, {

sourceType: “module”,

plugins: [“dynamicImport”]

});

// 2、遍历

traverse(ast, {

FunctionExpression(path, state) { // 函数表达式会进入当前方法

+    // 获取函数当前节点信息

+    var node = path.node,

+        params = node.params,

+        blockStatement = node.body,

+        isGenerator = node.generator,

+        isAsync = node.async;

+    // 可以尝试打印看看结果

+    console.log(node, params, blockStatement);

}，

});

终端执行 node src/index.js，可以打印看到当前函数的 AST 节点信息。

创建 try/catch 节点（两步骤）

创建一个新的节点可能会稍微陌（fu）生（za）一点，不过我已经为大家总结了我个人的经验（仅供参考）。首先需要知道当前新增代码段它的声明是什么，然后使用 @babel-types 去创建即可。

第一步：

那么我们如何知道它的表达声明type是什么呢？这里我们可以 使用 astexplorer 查找它在 AST 中 type 的表达。如上截图得知，try/catch 在 AST 中的 type 就是 TryStatement！

第二步：

然后去 @babel-types 官方文档查找对应方法，根据 API 文档来创建即可。如文档所示，创建一个 try/catch 的方式使用 t.tryStatement(block, handler, finalizer)。

创建新的ast节点一句话总结：使用 astexplorer 查找你要生成的代码的 type，再根据 type 在 @babel-types 文档查找对应的使用方法使用即可！

那么创建 try/catch 只需要使用 t.tryStatement(try代码块, catch代码块) 即可。

• try代码块 表示 try 中的函数代码块，即原先函数 body 内的代码 console.log(111)，可以直接用 path.node.body 获取；

• catch代码块 表示 catch 代码块，即我们想要去改造进行错误收集上报的 sdk 的代码 ErrorCapture(error)，可以使用 @babel/template 去生成。

代码如下所示：

const parser = require(“@babel/parser”);

const traverse = require(“babel-traverse”).default;

const t = require(“babel-types”);

const template = require(“@babel/template”);

// 0、定义一个待处理的函数（mock）

let source = `var fn = function() {

console.log(111)

}`;

// 1、解析

let ast = parser.parse(source, {

sourceType: “module”,

plugins: [“dynamicImport”]

});

// 2、遍历

traverse(ast, {

FunctionExpression(path, state) { // Function 节点

var node = path.node,

params = node.params,

blockStatement = node.body, // 函数function内部代码，将函数内部代码块放入 try 节点

isGenerator = node.generator,

isAsync = node.async;

+    // 创建 catch 节点中的代码

+    var catchStatement = template.statement(ErrorCapture(error))();

+    var catchClause = t.catchClause(t.identifier(‘error’),

+          t.blockStatement(

+            [catchStatement] //  catchBody

+          )

+        );

+    // 创建 try/catch 的 ast

+    var tryStatement = t.tryStatement(blockStatement, catchClause);

}

});

创建新函数节点，并将上面定义好的 try/catch 塞入函数体：

const parser = require(“@babel/parser”);

const traverse = require(“babel-traverse”).default;

const t = require(“babel-types”);

const template = require(“@babel/template”);

// 0、定义一个待处理的函数（mock）

let source = `var fn = function() {

console.log(111)

}`;

// 1、解析

let ast = parser.parse(source, {

sourceType: “module”,

plugins: [“dynamicImport”]

});

// 2、遍历

traverse(ast, {

FunctionExpression(path, state) { // Function 节点

var node = path.node,

params = node.params,

blockStatement = node.body, // 函数function内部代码，将函数内部代码块放入 try 节点

isGenerator = node.generator,

isAsync = node.async;

// 创建 catch 节点中的代码

var catchStatement = template.statement(ErrorCapture(error))();

var catchClause = t.catchClause(t.identifier(‘error’),

t.blockStatement(

[catchStatement] //  catchBody

)

);

// 创建 try/catch 的 ast

var tryStatement = t.tryStatement(blockStatement, catchClause);

+    // 创建新节点

+    var func = t.functionExpression(node.id, params, t.BlockStatement([tryStatement]), isGenerator, isAsync);

+    // 打印看看是否成功

+    console.log(‘当前节点是:’, func);

+    console.log(‘当前节点下的自节点是:’, func.body);

}

});

此时将上述代码在终端执行 node src/index.js：可以看到此时我们在一个函数表达式 body 中创建了一个 try 函数（TryStatement）。最后我们需要将原函数节点进行替换：

const parser = require(“@babel/parser”);

const traverse = require(“babel-traverse”).default;

const t = require(“babel-types”);

const template = require(“@babel/template”);

// 0、定义一个待处理的函数（mock）

let source = `var fn = function() {…

// 1、解析

let ast = parser.parse(source, {…

// 2、遍历

traverse(ast, {
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数前端工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：前端）

最后

给大家分享一些关于HTML的面试题，有需要的朋友可以戳这里免费领取，先到先得哦。

eb前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**

[外链图片转存中…(img-mU9wbYmB-1712084663239)]

[外链图片转存中…(img-IE4hmK3N-1712084663241)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！

[外链图片转存中…(img-12r1l4KO-1712084663241)]

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：前端）

最后

给大家分享一些关于HTML的面试题，有需要的朋友可以戳这里免费领取，先到先得哦。

[外链图片转存中…(img-whZA7hFn-1712084663242)]
[外链图片转存中…(img-EHbDFLdQ-1712084663242)]