如何从 TypeORM 属性装饰器获取值

在 TypeORM 中，属性装饰器常用来定义数据库表的模型属性，如 @Column, @PrimaryGeneratedColumn 等，它们不仅定义了字段和数据类型，还可以包含其他元数据。如果你想获取这些装饰器中定义的值，你需要使用反射（Reflection）技术，这通常涉及到使用 Reflect-metadata 库，这是 TypeScript 装饰器元数据的一个标准库。

步骤解析

1. 安装必要的库： 首先，确保项目中安装了 reflect-metadata 和 typeorm。

   bash
   npm install reflect-metadata typeorm

   并在项目的入口文件中导入 reflect-metadata：

   typescript
   import "reflect-metadata";

2. 使用装饰器定义模型： 定义模型时，利用 TypeORM 的装饰器来装饰类的属性。

   typescript
   import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";
   
   @Entity()
   class User {
       @PrimaryGeneratedColumn()
       id: number;
   
       @Column()
       name: string;
   }

3. 通过 Reflect-metadata 获取装饰器元数据： 获取装饰器中的元数据需要使用 Reflect 提供的 API。例如，获取 @Column 装饰器的信息：

   typescript
   import { getMetadataArgsStorage } from "typeorm";
   
   function getColumnDecorators(entity: Function) {
       const columns = getMetadataArgsStorage().columns.filter(column => column.target === entity);
       columns.forEach(column => {
           console.log(`Property: ${column.propertyName}, Type: ${column.options.type || 'default'}`);
       });
   }
   
   getColumnDecorators(User);

示例说明

在上面的例子中，我们定义了一个简单的 User 实体，并使用 @Entity 和 @Column 装饰器来标注其属性。使用 getMetadataArgsStorage() 函数从 TypeORM 获取所有装饰器的元数据，然后过滤出属于特定实体的列信息，并打印出每个列的属性名称和类型。

注意事项

• 获取装饰器元数据是在运行时完成的，因此，确保在使用此技术时，应用已正确设置并加载了所有必要的模块和库。
• TypeORM 的 getMetadataArgsStorage() 方法提供了对内部装饰器元数据的广泛访问，你可以通过它获取更多关于实体和装饰器的信息。

通过这种方式，你可以在需要时查看或修改由 TypeORM 装饰器定义的数据库模型的各种属性和配置，这对于动态生成数据库模式或执行元数据驱动的操作非常有用。