0

0

TypeORM 中如何为实体添加嵌套对象数组字段(如 icons)

碧海醫心

碧海醫心

发布时间:2026-02-04 10:55:12

|

816人浏览过

|

来源于php中文网

原创

TypeORM 中如何为实体添加嵌套对象数组字段(如 icons)

在 typeorm 中,若需为实体存储结构化嵌套数组(如包含 icon 和 main 字段的对象列表),推荐使用 jsonb 类型(postgresql)或 json 类型(其他数据库),配合 typescript 接口定义类型安全的嵌套结构。

要在 TypeORM 实体中支持类似 icons: [{ icon: string; main: boolean }[]] 的嵌套对象数组,不建议强行拆分为一对多关系实体(除非需频繁按 icon 字段查询、索引或关联操作),因为这会显著增加模型复杂度与查询开销。更轻量、实用且符合语义的设计是:将 icons 作为内联 JSON 字段存储。

✅ 推荐方案:使用 jsonb(PostgreSQL)或 json 类型

TypeORM 支持原生 JSON 类型映射。以 PostgreSQL 为例,jsonb 提供高效查询、索引和类型化存储能力;MySQL 8.0+ 和 SQLite(通过 simple-json 插件)也支持 json 类型。

1. 定义 TypeScript 接口(确保类型安全)

// icons.interface.ts
export interface IconItem {
  icon: string;
  main: boolean;
}

2. 在实体中声明 JSON 字段

// item.entity.ts
import { Entity, PrimaryGeneratedColumn, Column, BaseEntity } from 'typeorm';
import { IconItem } from './icons.interface';

@Entity()
export class Item extends BaseEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  title: string;

  // ✅ PostgreSQL 推荐:jsonb + 默认空数组
  @Column({ type: 'jsonb', nullable: true, default: () => '[]' })
  icons: IconItem[];

  // ⚠️ 其他数据库适配示例(如 MySQL):
  // @Column({ type: 'json', nullable: true, default: () => '{}', transformer: {
  //   from: (value: string) => value ? JSON.parse(value) : [],
  //   to: (value: IconItem[]) => value ? JSON.stringify(value) : '[]'
  // }})
  // icons: IconItem[];
}
? 注意:default: () => '[]' 是关键——它确保数据库默认值为合法 JSON 数组(而非 NULL),避免运行时解析错误;若用 default: [],TypeORM 会尝试序列化空数组为字符串,可能引发异常。

3. 使用示例:创建与保存

const newItem = Item.create({
  title: 'Title text',
  icons: [
    { icon: 'icon-1.png', main: true },
    { icon: 'icon-2.png', main: false },
    { icon: 'icon-3.png', main: false }
  ]
});

await newItem.save();
// → 数据库 icons 字段存为:[{"icon":"icon-1.png","main":true}, ...]

4. 查询与类型保障

TypeORM 自动反序列化 jsonb/json 字段为对应 TypeScript 类型(IconItem[]),无需手动 JSON.parse():

CG Faces
CG Faces

免费的 AI 人物图像素材网站

下载
const item = await Item.findOneBy({ id: 1 });
console.log(item.icons[0].icon); // ✅ 类型安全,智能提示可用

⚠️ 注意事项与权衡

  • 查询限制:jsonb 支持路径查询(如 WHERE icons @> '[{"main": true}]'),但复杂过滤仍不如关系表高效;若需高频按 main = true 查询图标,应考虑拆分为独立 Icon 实体并建立 @OneToMany 关系。
  • 迁移兼容性:首次添加 jsonb 字段需生成迁移,并确认目标数据库版本支持(如 PostgreSQL ≥ 9.4)。
  • 验证与约束:JSON 字段无法在数据库层强制校验 icon 是否为非空字符串,建议在应用层结合 class-validator 做前置校验。
  • ORM 兼容性:SQLite 需启用 sqlite-json1 扩展或改用 simple-json transformer;SQL Server 推荐 nvarchar(max) + 自定义 transformer。

✅ 总结

对于“图标列表”这类低频查询、高读取密度、强结构化的嵌套数据,jsonb/json 字段是最简洁、可维护、性能友好的选择。配合接口定义与合理默认值,即可在保持 TypeORM 类型安全的同时,灵活支持任意深度的嵌套对象数组。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

813

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

330

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

351

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1366

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

365

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

963

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

581

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

427

2024.04.29

全国统一发票查询平台入口合集
全国统一发票查询平台入口合集

本专题整合了全国统一发票查询入口地址合集,阅读专题下面的文章了解更多详细入口。

37

2026.02.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 2.1万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 821人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号