TypeORM嵌入式实体完全指南：告别数据冗余，让代码更优雅高效

TypeORM嵌入式实体完全指南：告别数据冗余，让代码更优雅高效

【免费下载链接】typeormTypeScript & JavaScript ORM for Node.js — supports PostgreSQL, MySQL, MariaDB, SQLite, SQL Server, Oracle, and more.项目地址: https://gitcode.com/GitHub_Trending/ty/typeorm

TypeORM是一个功能强大的TypeScript & JavaScript ORM框架，支持PostgreSQL、MySQL、SQL Server等多种数据库。在TypeORM中，嵌入式实体（Embedded Entity）是一种强大的数据建模工具，它能帮助开发者消除代码冗余，创建更清晰、更高效的数据结构。本文将深入探讨嵌入式实体的概念、使用方法和最佳实践，带你掌握这一提升代码质量的关键技巧。

什么是嵌入式实体？

嵌入式实体是一种可以被嵌入到其他实体中的特殊类，它允许你将多个相关字段组合成一个独立的可重用单元。与普通实体不同，嵌入式实体没有自己的数据库表，而是作为宿主实体表中的列存在。这种设计模式特别适合处理具有重复字段结构的数据模型，例如用户地址、产品规格等。

为什么使用嵌入式实体？

✅ 消除代码重复

嵌入式实体允许你定义一次字段结构，然后在多个实体中重复使用，避免了在不同实体中复制粘贴相同的字段定义。

✅ 提高代码可维护性

将相关字段组织成嵌入式实体，使代码结构更加清晰，修改时只需在一个地方进行，减少了出错的可能性。

✅ 优化数据库设计

嵌入式实体将相关字段组合在一起，使数据库表结构更加合理，减少了表的数量和复杂性。

如何创建和使用嵌入式实体？

1. 定义嵌入式实体类

首先，创建一个嵌入式实体类。嵌入式实体类不需要使用@Entity装饰器，只需定义相关字段即可：

// src/entity/FooChildMetadata.ts import { Column } from "../../../src/decorator/columns/Column" export class FooChildMetadata { @Column({ nullable: true }) something: number @Column({ nullable: true }) somethingElse: number }

2. 在其他类中嵌入实体

使用@Column(() => EmbeddedClass)语法将嵌入式实体嵌入到其他类中：

// src/entity/FooMetadata.ts import { Column } from "../../../../src/decorator/columns/Column" import { FooChildMetadata } from "./FooChildMetadata" export class FooMetadata { @Column({ nullable: true }) bar: number @Column(() => FooChildMetadata) child?: FooChildMetadata }

3. 在主实体中使用嵌入式实体

最后，在主实体中使用嵌入式实体：

// src/entity/Foo.ts import { Entity } from "../../../../src/decorator/entity/Entity" import { PrimaryGeneratedColumn } from "../../../../src/decorator/columns/PrimaryGeneratedColumn" import { Column } from "../../../../src/decorator/columns/Column" import { FooMetadata } from "./FooMetadata" @Entity() export class Foo { @PrimaryGeneratedColumn() id: number @Column() name: string @Column(() => FooMetadata) metadata?: FooMetadata }

嵌入式实体的高级用法

嵌套嵌入式实体

TypeORM支持嵌入式实体的嵌套，你可以在一个嵌入式实体中嵌入另一个嵌入式实体，形成更复杂的数据结构：

// 示例：FooMetadata中嵌入FooChildMetadata @Column(() => FooMetadata) metadata?: FooMetadata // FooMetadata类中 @Column(() => FooChildMetadata) child?: FooChildMetadata

处理可空嵌入式实体

从TypeORM的更新日志可以看到， nullable嵌入式实体功能在#10289中引入，允许嵌入式实体的所有字段都为null。当嵌入式实体的所有列值都为null时，数据库查询会将嵌入式属性返回为null，这在处理可选的复杂数据结构时非常有用。

// 可空嵌入式实体示例 @Column(() => FooMetadata) metadata?: FooMetadata

查询嵌入式实体字段

查询嵌入式实体的列时，需要按照定义的层次结构进行。例如，要查询Foo实体中metadata嵌入式实体的bar字段，可以这样写：

const loadedFoo = await connection .getRepository(Foo) .findOneBy({ "metadata.bar": 1 })

嵌入式实体的最佳实践

1. 保持嵌入式实体的单一职责

每个嵌入式实体应该只负责表示一个特定的概念或数据结构，避免创建过于庞大或复杂的嵌入式实体。

2. 合理使用可空性

根据业务需求，合理设置嵌入式实体及其字段的可空性，使数据模型更加准确。

3. 注意查询性能

虽然嵌入式实体可以简化数据模型，但过度使用嵌套嵌入式实体可能会影响查询性能，特别是在进行复杂查询或排序时。

总结

嵌入式实体是TypeORM中一个强大而灵活的功能，它为开发者提供了一种优雅的方式来组织和重用数据结构。通过合理使用嵌入式实体，你可以显著提高代码的可维护性，减少冗余，并优化数据库设计。无论是处理简单的地址信息，还是构建复杂的嵌套数据结构，嵌入式实体都能帮助你创建更加清晰、高效的TypeORM应用。

如果你想深入了解TypeORM的更多功能，可以查阅官方文档或探索项目源码，开始你的TypeORM进阶之旅吧！

【免费下载链接】typeormTypeScript & JavaScript ORM for Node.js — supports PostgreSQL, MySQL, MariaDB, SQLite, SQL Server, Oracle, and more.项目地址: https://gitcode.com/GitHub_Trending/ty/typeorm