TypeORM中自定义实体字段迁移标记装饰器的实现方法咨询

完全可以实现该需求，方案和TypeORM本身的装饰器运行逻辑完全兼容，不需要破解框架内部机制。

实现思路 #

TypeORM本身基于reflect-metadata实现装饰器的元数据存储，我们可以复用这套能力编写自定义装饰器，把字段标记存在独立的元数据存储空间里，检索时直接从对应实体类上读取标记即可，全程不会干扰TypeORM本身的实体解析流程。

具体实现步骤 #

1. 定义@Migrate自定义装饰器 #

装饰器本质是给目标类的字段打上可检索的元数据标记，使用独立的Symbol作为元数据key，避免和TypeORM内部的元数据冲突：

// 自定义装饰器文件 migrate.decorator.ts
import 'reflect-metadata';

// 元数据存储的唯一标识，避免和其他库的元数据冲突
const MIGRATE_FIELD_METADATA = Symbol('CUSTOM_MIGRATE_FIELDS');

/**
 * 标记需要参与用户元数据迁移的实体字段
 */
export function Migrate() {
  return (target: object, propertyKey: string | symbol) => {
    // 读取实体类上已存的迁移字段列表，把当前字段追加进去
    const migratedFields = Reflect.getMetadata(
      MIGRATE_FIELD_METADATA,
      target.constructor
    ) || [];

    Reflect.defineMetadata(
      MIGRATE_FIELD_METADATA,
      [...migratedFields, propertyKey],
      target.constructor
    );
  };
}

2. 编写字段检索工具方法 #

封装通用方法，直接传入实体类就能返回所有标记过的迁移字段：

// 工具函数文件 migrate.util.ts
import { MIGRATE_FIELD_METADATA } from './migrate.decorator';

/**
 * 获取指定实体类下所有带@Migrate标记的字段列表
 * @param entityClass TypeORM实体类
 * @returns 需迁移的字段名数组
 */
export function getEntityMigrateFields(entityClass: Function): string[] {
  return Reflect.getMetadata(MIGRATE_FIELD_METADATA, entityClass) || [];
}

3. 对接原有实体代码 #

直接在你的User实体里引入自定义装饰器替换原来的写法即可：

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";
import { Migrate } from "./migrate.decorator";

@Entity()
export class User {
    @PrimaryGeneratedColumn()
    id!: number;

    @Column()
    name!: string;

    @Migrate()
    userValue!: string;
 
    @Migrate()
    specficValue!: string;
}

实际使用 #

在迁移逻辑、实体订阅器中直接调用工具方法就能拿到需要迁移的字段：

import { getEntityMigrateFields } from "./migrate.util";
import { User } from "./User.entity";

// 输出结果为 ['userValue', 'specficValue']
const userMigrateTargets = getEntityMigrateFields(User);

注意事项 #

• 项目入口确保已经引入了reflect-metadata，这是TypeORM的强制依赖项，常规TypeORM初始化项目时已经完成配置，不需要额外修改
• 如果后续需要给@Migrate装饰器加配置（比如迁移字段的转换规则、目标存储位置），只需要在装饰器工厂中把参数值存入对应字段的元数据，检索时同步取出即可，不需要调整整体逻辑
• 如果存在带继承关系的实体类，可以在收集元数据时同步遍历父类的元数据做合并，不用在子类重复标记公共迁移字段

内容的提问来源于stack exchange，提问作者C.Programming