TypeORM Polymorphic 关系管理扩展包使用教程

TypeORM Polymorphic 关系管理扩展包使用教程

typeorm-polymorphic Typeorm polymorphic relationship management 项目地址: https://gitcode.com/gh_mirrors/ty/typeorm-polymorphic

1. 项目介绍

TypeORM Polymorphic 是一个为 TypeORM 设计的开源扩展包，用于处理多态关系的管理、声明和仓库查询。这个包提供了一种方便的方式来定义和操作多态关联，使得在数据库中存储和检索与不同实体类型相关联的实体变得更加简单。

2. 项目快速启动

在开始使用 TypeORM Polymorphic 之前，确保你已经安装了 Node.js 和 TypeORM。以下是一个快速启动的指南：

首先，安装 TypeORM Polymorphic 包：

yarn add typeorm-polymorphic

你还需要安装 typeorm 和 reflect-metadata（如果尚未安装）：

yarn add typeorm reflect-metadata

接下来，定义你的实体和关系。这里是一个简单的例子：

import { Entity, PrimaryGeneratedColumn, Column, PolymorphicChildren } from 'typeorm';
import { PolymorphicParent } from 'typeorm-polymorphic';

@Entity('users')
export class UserEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @PolymorphicChildren(() => AdvertEntity)
  adverts: AdvertEntity[];
}

@Entity('adverts')
export class AdvertEntity implements PolymorphicChildInterface {
  @PrimaryGeneratedColumn()
  id: number;

  @PolymorphicParent(() => [UserEntity])
  owner: UserEntity;

  @Column()
  entityId: number;

  @Column()
  entityType: string;
}

然后，创建一个继承自 AbstractPolymorphicRepository 的自定义仓库：

import { AbstractPolymorphicRepository } from 'typeorm-polymorphic';

@PolymorphicRepository(UserEntity)
export class UserRepository extends AbstractPolymorphicRepository<UserEntity> {
  // 仓库方法可以在这里定义
}

最后，你可以使用这个自定义仓库来操作多态关系：

const userRepository = AbstractPolymorphicRepository.createRepository(dataSource, UserRepository);
const user = userRepository.create({ adverts: [] });
userRepository.save(user);

确保你已经配置了 TypeORM 数据源 dataSource。

3. 应用案例和最佳实践

• 声明多态关系：使用 @PolymorphicChildren 和 @PolymorphicParent 装饰器来声明多态关系。
• 管理多态关系：通过继承 AbstractPolymorphicRepository 创建自定义仓库，利用其方法来管理多态关系。
• 避免直接操作数据库：尽可能使用仓库方法来操作数据，这样可以确保多态关系的正确处理。

4. 典型生态项目

• TypeORM：TypeORM 是一个流行的 ORM，用于 Node.js，它与 Polymorphic 扩展包无缝集成，提供强大的多态关系管理能力。
• Class-Transformer：这是一个用于转换和修饰类属性的工具，可以与 TypeORM Polymorphic 结合使用，以简化多态关系的序列化和反序列化。

以上就是关于 TypeORM Polymorphic 的基本介绍和使用指南。希望这个教程能够帮助你快速上手并有效地使用这个扩展包。

typeorm-polymorphic Typeorm polymorphic relationship management 项目地址: https://gitcode.com/gh_mirrors/ty/typeorm-polymorphic