如何通过 Reflect.ownKeys 获取包含所有非枚举属性的对象完整业务契约列表

小伟大大_1554

小伟大大_1554

2026-05-02

270人浏览

原创

reflect.ownkeys仅返回对象自身键名数组,不含类型、约束或业务含义等契约信息;业务契约需通过typescript接口、json schema或$contract元数据等方式显式定义。

如何通过 reflect.ownkeys 获取包含所有非枚举属性的对象完整业务契约列表

Reflect.ownKeys 只能获取对象自身的所有键(包括可枚举和不可枚举的),但它**不区分属性是否可枚举,也不提供属性描述符、类型、用途等业务语义信息**。因此,它本身无法直接生成“完整业务契约列表”——业务契约需要的是字段名、类型、是否必填、取值范围、含义、校验规则等元数据,这些必须由开发者显式定义或从其他来源(如 TypeScript 接口、JSON Schema、注释、配置)提取。

为什么 Reflect.ownKeys 不够用

它返回的只是字符串或 Symbol 类型的键名数组,例如:

const obj = { a: 1 };
Object.defineProperty(obj, 'b', { value: 2, enumerable: false });
Reflect.ownKeys(obj); // ['a', 'b'] —— 仅键名,无类型、无约束、无业务含义

这里你不知道 a 是用户 ID 还是时间戳,b 是内部缓存还是敏感字段,更不清楚它是否允许为空、是否需加密、是否参与审计日志。

真正构建业务契约的可行路径

  • 用 TypeScript + JSDoc 或装饰器标注契约:在接口或类中声明字段类型与业务注释,再通过工具(如 ts-json-schema-generator 或自定义 AST 解析)导出结构化契约。
  • 基于 JSON Schema 管理契约:将业务规则写成标准 Schema 文件,运行时加载并校验;Reflect.ownKeys 可用于比对实际对象键是否符合 schema 的 required 和 properties 字段,但不能替代 Schema 本身。
  • 约定对象上挂载 $contract 元数据:手动或通过构造函数/工厂注入契约描述,例如:
    obj.$contract = {
      a: { type: 'string', required: true, description: '用户手机号' },
      b: { type: 'number', required: false, description: '上次登录毫秒时间戳' }
    };
    此时可用 Reflect.ownKeys(obj).filter(key => key !== '$contract') 获取业务键,再查 obj.$contract[key] 补全契约。

如果坚持用 Reflect.ownKeys 辅助契约检查

它可以作为**完整性校验的起点**,比如确认运行时对象没有遗漏必需字段、也没有意外多出未声明字段:

  • 先定义契约键集合(如从 Schema 或元数据中提取):const expectedKeys = ['userId', 'orderAmount', 'createdAt'];
  • 获取实际键:const actualKeys = Reflect.ownKeys(obj);
  • 对比差异:
    const missing = expectedKeys.filter(k => !actualKeys.includes(k));
    const unexpected = actualKeys.filter(k => typeof k === 'string' && !expectedKeys.includes(k));

注意:Symbol 键需单独处理,且该检查仍不涉及字段含义或规则——它只是“键存在性”的快照验证。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2989

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2248

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1138

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2078

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3300

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14775

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习