MikroORM中JSON类型字段插入问题的分析与解决方案

问题背景

在使用MikroORM进行数据库操作时，开发者可能会遇到JSON类型字段的特殊处理问题。具体表现为：当通过QueryBuilder的insert()方法插入包含JSON类型字段的记录时，JSON数据会被错误地存储为转义字符串而非有效的JSON对象，导致后续查询时无法正确解析。

问题现象

假设我们有一个ReportDAO实体，其中包含一个reportContent字段，其类型定义为JSON数组：

@Entity({ tableName: "reports" })
export class ReportDAO {
    @PrimaryKey()
    reportId: string;
 
    @Property({ columnType: "jsonb", type: "json" })
    reportContent: Array<Content> = [];
}

当使用以下方式插入数据时：

await em.qb(ReportDAO).insert(
    new ReportDAO({
        reportId: "asdffg-1234",
        reportContent: reportContentPayload
    })
).execute();

数据库实际存储的是转义后的字符串，而非有效的JSON对象，导致后续查询时无法正确解析。

问题原因

这个问题源于MikroORM的QueryBuilder在处理实体对象时的序列化机制。当直接传递实体对象给insert()方法时，内部序列化过程会对JSON字段进行额外的转义处理，而不是保持其原始JSON结构。

解决方案

方案一：使用wrap().toObject()方法

const report = new ReportDAO({
    reportId: "asdffg-1234",
    reportContent: reportContentPayload
});

await em.qb(ReportDAO)
    .insert(wrap(report).toObject())
    .execute();

这种方法通过wrap()函数将实体包装后调用toObject()，可以正确地序列化JSON字段。

方案二：直接使用EntityManager的insert方法

const report = new ReportDAO({
    reportId: "asdffg-1234",
    reportContent: reportContentPayload
});

await em.insert(report);

EntityManager的insert()方法内部处理了正确的序列化逻辑，能够保持JSON字段的原始结构。

技术原理分析

MikroORM在处理JSON类型字段时，需要区分两种情况：

1. 当通过EntityManager操作时，ORM会识别@Property装饰器中指定的type: "json"，并自动进行正确的序列化/反序列化。

2. 当通过QueryBuilder直接操作时，需要开发者明确处理JSON字段的序列化，因为QueryBuilder更接近原始SQL操作，提供的抽象层级较低。

wrap().toObject()方法之所以有效，是因为它调用了实体内部的序列化逻辑，保持了与EntityManager一致的行为。

最佳实践建议

1. 对于简单的CRUD操作，优先使用EntityManager的方法（如insert、update等），它们提供了更高层次的抽象和更安全的类型处理。

2. 当需要使用QueryBuilder进行复杂查询或批量操作时，对于JSON类型字段：

   • 确保正确使用wrap().toObject()
   • 或者手动序列化JSON字段为字符串

3. 在定义实体时，明确指定JSON字段的类型：

   @Property({ columnType: "jsonb", type: "json" })
   reportContent: Array<Content> = [];
   

总结

MikroORM作为一款强大的TypeScript ORM，在处理JSON类型字段时提供了灵活的选项。理解不同操作方法背后的序列化机制，可以帮助开发者避免类似问题。对于大多数场景，使用EntityManager的高级API是更简单安全的选择，而在需要更精细控制时，QueryBuilder配合适当的序列化方法也能很好地完成任务。