javaScript无原生注解语法,但可通过函数属性、高阶函数、symbol元数据及Reflect API模拟。1. 直接添加自定义属性如func.author = ‘John’;2. 用高阶函数实现装饰器行为,如@log需Babel/typescript支持;3. 使用Symbol避免属性冲突,私有存储元数据;4. 借助reflect-metadata库结合Reflect.defineMetadata实现类与方法的元信息管理,广泛用于angular、Nestjs等框架。

javascript 本身没有“注解”(Annotation)这种语法,像 Java 或 TypeScript 中的装饰器(Decorator)那样的注解功能,在原生 JS 中并不存在。但你提到的“JS 注解自定义属性”,可能是想表达:如何在 JavaScript 中模拟类似注解的行为,或如何给函数、对象添加自定义元数据(即自定义属性),用于后续处理。
下面介绍几种常见的实现方式,帮助你在 JS 中定义和使用“自定义属性”,达到类似“注解”的效果。
1. 给函数或对象直接添加自定义属性
JavaScript 是动态语言,允许随时给函数或对象添加属性,这是最简单的“自定义注解”方式。
示例:
function getUser() { return { id: 1, name: 'Alice' }; } // 添加自定义属性,模拟“注解” getUser.author = 'John'; getUser.version = '1.0'; getUser.description = '获取用户信息接口'; // 使用这些“注解”属性 console.log(getUser.author); // 输出: John console.log(getUser.description); // 输出: 获取用户信息接口
这种方式简单直接,适合在框架或工具中为函数打标签、记录元信息。
2. 使用高阶函数模拟注解行为
通过封装一个函数来“装饰”目标函数,并附加元数据或逻辑,是更接近“注解”概念的做法。
示例:创建一个 @log 注解模拟
function log(target) { target.shouldLog = true; return target; } @log function fetchData() { if (fetchData.shouldLog) { console.log('正在调用 fetchData...'); } return 'data'; }
注意:上面的 @log 语法属于 JavaScript 装饰器提案,目前尚未正式纳入标准,需要借助 Babel 或 TypeScript 支持才能运行。
3. 使用 Symbol 存储私有元数据
为了避免自定义属性名冲突,可以使用 Symbol 来作为唯一的属性键。
const Metadata = Symbol('metadata'); function setMetadata(target, data) { target[Metadata] = data; } function getMetadata(target) { return target[Metadata]; } function apiRoute(path) { return function(target) { setMetadata(target, { type: 'api', path }); return target; }; } const getUser = apiRoute('/user')(function() { return { id: 1 }; }); console.log(getMetadata(getUser)); // { type: 'api', path: '/user' }
这样可以安全地附加元信息,不会污染对象原有属性。
4. 结合 Reflect 和 proxy 实现高级元数据管理
使用 Reflect.defineMetadata 需要引入第三方库如 reflect-metadata,常见于 TypeScript 装饰器开发。
安装:
使用示例:
import 'reflect-metadata'; function Route(path: string) { return function(target: any, propertyKey: string | symbol) { Reflect.defineMetadata('route:path', path, target, propertyKey); }; } class UserController { @Route('/users') list() {} } const path = Reflect.getMetadata('route:path', UserController.prototype, 'list'); console.log(path); // 输出: /users
这种方式广泛应用于 Angular、NestJS 等框架中,实现依赖注入和路由映射。
基本上就这些常见的做法。虽然原生 JS 没有真正的注解语法,但通过属性扩展、装饰器函数、Symbol 和元数据反射机制,完全可以实现类似“自定义注解属性”的功能。