将 JSON 转换为 TypeORM 方案!

输入 JSON 并将其转换为 TypeORM 方案!支持 TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS。
JSON
结果
 

将 JSON 转换为 TypeORM 方案!

把 JSON 数据转换成 TypeORM 实体类:一个带主键的 @Entity() 类,其余每个 key 都成为 @Column() 属性,并带有 TypeScript 类型、可空性以及 class-validator 装饰器。

在 NestJS + TypeORM 应用中为 TypeOrmModule.forFeature([...]) 创建第一个实体,或者给 Express 项目加上 TypeORM DataSource、需要与现有数据对应的实体时,都可以用它。

使用方法

  1. 把要存储的记录以对象形式粘贴进来,多条记录则用数组。某些记录中缺失的字段会成为可空列。
  2. 在 模型名 中输入实体类名(默认 MyModel);support ticket 会变成 SupportTicket。
  3. 保存为 support-ticket.entity.ts,然后加到 DataSource 的 entities 数组中,或加到 NestJS 模块的 TypeOrmModule.forFeature([SupportTicket]) 里。

示例

输入 (JSON)
[
  { "subject": "Login fails on Safari", "priority": 2, "assignee": "jdoe", "closed": false, "opened_at": "2024-06-03T08:12:00Z" },
  { "subject": "Export CSV is empty", "priority": 1, "closed": true, "opened_at": "2024-06-04T14:40:00Z" }
]
输出 (TypeORM)
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
import { IsNotEmpty, IsOptional } from 'class-validator';

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

  @Column()
  @IsNotEmpty()
  subject: string;

  @Column()
  @IsNotEmpty()
  priority: number;

  @Column({ nullable: true })
  @IsOptional()
  assignee: string | null;

  @Column()
  @IsNotEmpty()
  closed: boolean;

  @Column({ name: 'opened_at' })
  @IsNotEmpty()
  openedAt: Date;
}

第二个工单没有 assignee,所以该列是 @Column({ nullable: true }),类型为 string | null。opened_at 变成了类型为 Date 的 openedAt 属性,并通过 name: 'opened_at' 保留原来的列名。

支持的功能

  • 根据数据决定主键:没有 id key 或 id 为整数 → @PrimaryGeneratedColumn() id: number;id 超出 32 位范围 → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string;id 为 UUID 等字符串 → @PrimaryColumn() id: string。
  • 列类型:整数使用默认的 @Column(),小数加上 type: 'double precision' 以免小数部分被截断,bigint 和只有日期的 date 列类型为 string(TypeORM 以文本形式返回它们),日期时间为 Date。
  • 对象和数组变成 simple-json 列,类型为 Record<string, unknown> 或 string[] 这样的类型化数组。
  • "007" 这样带引号的数字仍是 string 列。
  • 属性名使用 camelCase;只要 JSON key 不同,就会加上 @Column({ name: 'opened_at' })。
  • 值为 null 或缺失的字段会得到 nullable: true、| null 和 @IsOptional();其余字段得到 @IsNotEmpty()。

使用场景

在 `nest g resource` 之后立即补全实体

用这里的输出替换 nest g resource tickets 生成的空 ticket.entity.ts,实体就与前端一直在用的 mock 数据一致,Repository<SupportTicket> 也可以直接使用。

生成迁移的起点

创建实体后,typeorm migration:generate 会把它与数据库对比,写出包括列名和可空性在内的 CREATE TABLE 迁移。

注意事项与限制

  • simple-json 把 JSON 存成文本,因此无法按其中的值过滤。如果需要查询,PostgreSQL 上请改用 type: 'jsonb',MySQL 上改用 type: 'json'。
  • double precision 是浮点类型;价格请使用 @Column('decimal', { precision: 10, scale: 2 }),TypeORM 会以字符串返回。
  • 不会推断关系。实际上是其他实体的嵌套对象,应改为 @ManyToOne 或 @OneToMany 关系。

常见问题

实体对应哪个表名?

@Entity() 没有指定名称,所以 TypeORM 的默认命名会把类名转成 snake_case:support_ticket。对于已有的表,请传入表名,例如 @Entity('tickets')。

如果关闭了 emitDecoratorMetadata 会怎样?

不带选项的 @Column() 从反射元数据读取类型,所以 TypeORM 会报数据类型错误。请在 tsconfig 中开启它,或为每列写明类型,如 @Column('varchar')。

Date 属性会对应什么数据库类型?

MySQL 上是 datetime,PostgreSQL 上是 timestamp without time zone。在 PostgreSQL 上如果时区很重要,请改为 @Column('timestamptz')。