30分钟开发Vue 3插入客制化脚本插件_vue3 插件式开发-优快云博客

本文链接：https://blog.youkuaiyun.com/dlcxycg/article/details/136454657

1. 引言

嘿，大家好，我是星辰编程理财，今天要和大家聊聊一个让我颇有心得的话题：Vue组件的客制化方式之前-“埋点”。或许你也曾为埋点这个问题烦恼过，在历史的包袱下加上技术债，我们需要实现一套客制化的脚本，埋点成了我们选择的方向。

为什么要进行 Vue 组件的埋点？

曾经，我们在没有引入Vue框架是，代码里面到处都是埋点，随着业务的增长和技术迭代，需要向Vue框架下过度。于是，在这个痛点的驱使下，开始对迁移和兼容代码。通过我们统计分析发现，会有一部分公共埋点的位置。如果每个文件都去加上通用埋点代码，工作量大并和业务代码耦合。于是采用编译时插入代码的方式实现。

为何使用AST？

最初，我们尝试了简单的字符串匹配，想着解决问题应该不难。但是，特征字符串太少，简单匹配往往事倍功半，不好扩展，而且容易翻车。于是AST算是一个稳妥，虽然不太熟悉开发时间要长一些。

2. AST 技术调研

首先，我开始进行了 AST 技术的调研，由于技术上我们使用Vite作为开发及打包工具。于是直接问GTP：

Q: 开发vite插件，如何在插件中用ast分析代码？请简要回答。
A:
在Vite插件中使用AST（抽象语法树）来分析代码可以通过以下步骤完成：

安装依赖：首先，在你的插件项目中安装 @babel/parser 或其他适用的AST解析器。
npm install @babel/parser --save-dev
引入解析器：在你的插件代码中引入AST解析器。
const parser = require('@babel/parser');
解析代码：使用解析器来解析你感兴趣的代码文件。

const code = fs.readFileSync('path/to/your/file.js', 'utf-8');
const ast = parser.parse(code, {
   
   
    sourceType: 'module',
    plugins: ['jsx']  // 如果你的代码中包含JSX
});

遍历AST：通过遍历AST节点，你可以获取代码中的各种信息。

traverse(ast, {
   
   
    // 在这里添加处理不同类型节点的逻辑
});

你可能需要使用 @babel/traverse 这个插件来实现遍历。

通过上面回答，已了解需要@babel/parser与@babel/traverse实现。我们再向文心一言侧面印证一下常规方案是不是采用@babel/parser与@babel/traverse即可。

3. 具体需求描述

既然已经确认用@babel/parser、@babel/traverse作为AST解析和处理库。接下来就是整理具体的需求描述，需求描述一定要整理好，因为我并不打算直接开发。而是直接基于需求问GTP。

Q：在开发Vite插件时，使用@babel/traverse遍历AST如何找到选项式API的mounted方法？如何找到组合式API的setup方法中直接包含的最后一个return语句，需要忽略setup方法内部的子方法的return语句。
A：
在开发Vite插件时，使用@babel/traverse遍历AST可以找到选项式API的mounted方法和组合式API的setup方法中直接包含的最后一个return语句。下面是具体的步骤：

找到选项式API的mounted方法：
在AST遍历过程中，可以通过匹配对象方法节点中键名为mounted的节点来找到选项式API的mounted方法。具体步骤如下：

traverse(ast, {
     
     
    ObjectMethod(path) {
     
     
        if (
            path.node.key.type === 'Identifier' &&
            path.node.key.name === 'mounted'
        ) {
     
     
            // 处理选项式API的mounted方法逻辑
            // path.node 包含了该方法的完整信息
        }
    }
});

找到组合式API的setup方法中的最后一个return语句：
对于组合式API的setup方法，需要在遍历过程中找到最后一个return语句，但要忽略setup方法内部的子方法的return语句。可以通过递归遍历ReturnStatement节点来实现。具体步骤如下：
```
traverse(ast, {
     
     
    ObjectMethod</
```