deepkit/type 用于 TypeScript：完整指南与示例

\n\n

在 TypeScript 的世界中，存在一个根本性问题：类型仅在编译阶段存在。在转译为 JavaScript 后，所有类型信息都会消失。这使得运行时验证、动态序列化或构建依赖于类型元数据的复杂系统变得不可能。deepkit/type 库从根本上解决了这个问题——它将 TypeScript 的类型系统引入运行时，允许将类型作为数据进行操作。

\n\n

deepkit/type 的核心价值在于，它不需要编写重复的模式（如 Zod 或 Yup）。您只需用纯 TypeScript 描述一次类型，库就会自动在运行时提取它们。这使得您可以执行数据验证、序列化/反序列化、反射（获取属性、泛型、装饰器的信息），甚至基于类型生成代码。deepkit/type 不仅仅是一个验证器，而是一个完整的元编程框架。

\n\n

该库非常适合在各级别都需要严格类型化的项目：API 服务器（验证传入请求）、数据库（将类型映射到 SQL）、配置文件、RPC 系统和代码生成工具。通过与 deepkit/framework 的集成，它还可用于创建具有自动验证和序列化的高性能服务器应用程序。

\n\n

安装

\n\n

deepkit/type 是一个用于 TypeScript 的 npm 包。使用标准命令进行安装：

\n\n

npm install @deepkit/type reflect-metadata

\n\n

您还需要配置 tsconfig.json 以支持装饰器和 emit 元数据：

\n\n

{\n  "compilerOptions": {\n    "experimentalDecorators": true,\n    "emitDecoratorMetadata": true,\n    "strict": true,\n    "target": "ES2020",\n    "module": "commonjs",\n    "outDir": "./dist"\n  }\n}

\n\n

如果您使用 ts-node 运行，请确保它首先加载 reflect-metadata。在您的入口文件开头添加：

\n\n

import 'reflect-metadata';

\n\n

快速入门

\n\n

一个最小示例演示了如何声明一个类型并获取其运行时表示：

\n\n

import 'reflect-metadata';\nimport { typeOf, ReflectionClass } from '@deepkit/type';\n\n// 声明接口\ninterface User {\n  id: number;\n  name: string;\n  email?: string;\n}\n\n// 获取运行时类型\nconst userType = typeOf();\nconsole.log(userType); // ReflectionClass\n\n// 检查属性\nconst reflection = ReflectionClass.from(userType);\nconsole.log(reflection.getProperty('name').type); // ReflectionProperty\nconsole.log(reflection.getProperty('id').type.kind); // 'number'\n

\n\n

此代码将在控制台输出 User 类型的信息。请注意：我们没有编写任何模式——只有纯 TypeScript 接口。

\n\n

主要方法和函数

\n\n

以下是 deepkit/type 的关键功能。每个方法都提供了签名、简要说明和一个可运行的示例。

\n\n

1. typeOf

\n

签名： typeOf<T>(): ReflectionClass

\n

功能： 提取类型 T 的运行时表示。返回一个 ReflectionClass 对象，其中包含类型结构的完整信息：属性、属性类型、修饰符（可选、只读）、泛型和装饰器。

\n\n

import { typeOf } from '@deepkit/type';\n\ninterface Product {\n  id: number;\n  title: string;\n  price: number;\n}\n\nconst productType = typeOf();\nconsole.log(productType.getProperty('title').type.kind); // 'string'\nconsole.log(productType.getProperty('price').type.kind); // 'numb