0

0

怎样获取JS函数参数名 ?用AST获取js函数参数名的方法分析

不言

不言

发布时间:2018-09-18 15:03:58

|

3050人浏览过

|

来源于php中文网

原创

本篇文章给大家带来的内容是关于怎样获取js函数参数名 ?用ast获取js函数参数名的方法分析,有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助。

写在最前

最近项目有个需求,获取函数参数名,听起来很简单,但有了ES6,参数和函数写法千奇百怪,在github上大概看了几个库,基本上都是正则,
对通用的写法能够覆盖,稍微越过边界,往往无法正确匹配。

于是就有了使用AST去进行覆盖查找的想法。

概念

抽象语法树(abstract syntax tree或者缩写为AST),或者语法树(syntax tree),是源代码的抽象语法结构的树状表现形式

为什么要用AST

通过AST,我们可以对代码进行查找,看起来好像正则表达式也可以做到,那么为什么要用AST而不用正则?

就说从函数获取参数名,夸张点,如果有以下表达式:

function x(a=5,b="a",c=function(x=1,y){console.log(x=function(i=8,j){})},d={x:1,y:2,z:'x=6'},e=x=>7,f=['3=5','x.1','y,2',1],g=(x,y)=>{let z=(i,j=6)=>{}},h){}

参数是[a,b,c,d,e,f,g,h]

你确定还想用正则去匹配参数名称吗...

AST是从代码的意义去编辑,而正则只能从代码的字面去编辑。

以上夸张的函数,使用AST去分析,可以很轻松获取它的参数名

Esprima

我们使用esprima,一个可以将Javascript代码解析成抽象树的库。

首先我们需要安装它:

npm install esprima

接着调用:

const esprima=require('require'')

接下来就是分析的时候了

一个简单的AST例子

先来个简单的例子:
function a(b){}

通过esprima解析后,生成结构图如下:

{
    "type": "Program",
    "body": [
        {   // 这个type表示这是一个函数表达式
            "type": "FunctionDeclaration",
            "id": {
                "type": "Identifier",
                "name": "a"
            },
            "params": [
                {
                    // 参数数组内的Identifier代表参数
                    "type": "Identifier",
                    "name": "b"
                }
            ],
            "body": {
                "type": "BlockStatement",
                "body": []
            },
            "generator": false,
            "expression": false,
            "async": false
        }
    ],
    "sourceType": "script"
}

思路:

1、FunctionDeclaration说明是一个函数表达式,进入params属性。

2、判断params中每一个的type是否为Identifier,在params属性下的Identifier就代表是参数。

3、找出name属性的值,结果为['b']。

根据以上思路,我们可以写出一个简单的获取参数的方法了。

function getParams(fn){
  // 此处分析的代码必须是字符串
  let astEsprima=esprima.parseScript(fn.toString())
  let funcParams = []
  let node = astEsprima.body[0]
  // 找到type,进入params属性
  if (node.type === "FunctionDeclaration") funcParams = node.params
  let validParam=[]
  funcParams.forEach(obj=>{
    if(obj.type==="Identifier")
      validParam.push(obj.name)
  })
  return validParam
}

测试一番,获取结果["b"],庆祝收工。

好吧,别高兴太早了,要知道函数的创建方法不下10种,而参数写法又有好几种...

以下是一部分的函数创建方法和参数写法

function a(x){}

// 注意:第二条和第三条在AST中意义不同
let a=function(x=1){}

a=function(...x){}

let a=([x]=[1])=>{}

async function a(x){}

function *a(x){}

class a{
constructor(x){}
}

new Function ('x','console.log(x)')

(function(){return function(x){}})()

eval("(function(){return function(a,b){}})()")

有什么想法?如果你有发出"我K"的想法,那说明我这个装逼还算成功- -...

其实只需要分几种情况(很多写法的type都是一致的),就可以完全渗入到以上所有的参数对象内部,再进行参数获取就是循环+判断解决的事了。

靠岸学术
靠岸学术

一款集翻译,阅读,文献管理于一体的英文文献阅读器

下载

由于篇幅问题,这里不一一分析,只是将AST分析树所用的type和一些注意点。

函数结构

变量声明语句和表达式语句

上面注释中let a=function(x=1){}和a=function(...x){}是两种意义。

其中let a=function(x=1){}指的是变量声明语句,

对应的type是VariableDeclaration,需要进入它的初始值init就可以获取到函数所在的语法对象,它的type是FunctionExpression函数表达式,再去params中查找即可。

变量声明语句:

├──VariableDeclaration....init
        ├──FunctionExpression.params

而a=function(...x){}是表达式语句,

对应的type是ExpressionStatement,需要进入它的表达式expression获取到表达式内部,这时我们要进入赋值表达式(type为AssignmentExpression)的右边(right属性),
获取函数所在的语法对象,它的type同样也是FunctionExpression函数表达式。

表达式语句:

├──ExpressionStatement.expression
        ├──AssignmentExpression.right
                ├──FunctionExpression.params

class声明和Function构造函数

class声明对应的type有ClassDeclaration(class xx{...})或者ClassExpression(let x=class{...}),他们一个是声明一个是表达式,处理方式是相同的,
进入对象内部,找到kind为constructor的对象,获取参数数据。

class声明语句:

├──ClassDeclaration...body...
        ├──{kind:constructor}
                ├──FunctionExpression.params

Function构造函数对应的type是NewExpression或者ClassExpression,参数在属性arguments内部,但是Function的参数都是字符串,
而且最后一个参数一定是函数内部语句,因此对于Function构造函数,就是对字符串进行处理。

Function构造函数

├──NewExpression.arguments
        ├──{value:<String>}
         ---->对字符串进行处理,分割参数

箭头函数

箭头函数type是ArrowFunctionExpression,也仅仅是名称不同,内部结构几乎一致。

函数结构的type就到此。

参数结构

参数的type有以下:

Identifier:最终我们需要获取的参数值的type

Property:当存在解构参数,例如[a,b] or {x,y}

ArrayPattern:存在解构参数并且是数组,例如[a,b]

ObjectPattern:存在解构参数并且是对象,例如{x,y}

RestElement:存在扩展运算符,例如(...args)

我们只需要设置一个递归循环,思路和上面一样,一层进入另一层,在内部进行查找。

总结

篇幅有限,就写这么多,接着做一个总结。

这篇讲的主旨只有1个,通过对AST树中每一个对象的type分析,type表示的是对应的代码的意义,也是代码的语义,例如

VariableDeclaration内部一定会有init,为什么,因为变量声明是有初始值的,如果你不设置,那么就为undefined

type远不止这次说的这么多,官网(或者Google)上有详细介绍。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

46

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

178

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

51

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

92

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

102

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

227

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

532

2026.03.04

AI安装教程大全
AI安装教程大全

2026最全AI工具安装教程专题:包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好,附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新,收藏这一篇就够了,让AI安装不再报错!

171

2026.03.04

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
前端系列快速入门课程
前端系列快速入门课程

共4课时 | 0.4万人学习

React 教程
React 教程

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号