AdonisJS Core 中 BelongsTo 关系查询返回 null 的问题分析

问题背景

在使用 AdonisJS Core 5.8.0 版本时，开发者遇到了一个关于 BelongsTo 关系查询的异常情况。具体表现为：即使数据库中存在有效的外键关联，通过 BelongsTo 关系查询时却返回了 null 值。

问题现象

在业务逻辑中，系统需要根据名人(Celebrity)关联的业务(Business)获取对应的子分类(Subsegment)。开发者设计了以下模型关系：

1. Subsegment 模型：表示业务子分类
2. SubsegmentsBusinesses 模型：表示业务与子分类的关联
3. Celebrity 模型：表示名人，通过多对多关系与业务关联

在 Celebrity 模型中，开发者定义了一个计算属性 allowedSubsegments，用于获取名人允许的所有子分类。这个属性通过遍历名人的关联业务，然后获取每个业务对应的子分类来实现。

问题表现

在查询过程中，部分业务的子分类关系返回了 null，即使：

1. 数据库中存在有效的外键关联(subsegment_id)
2. 外键字段在数据库中被正确设置为非空
3. 查询使用了正确的数据库连接

深入分析

通过进一步排查，发现问题实际上是由于软删除机制导致的。在 Subsegment 模型中，开发者实现了软删除功能：

@column.dateTime({ serializeAs: null })
public deletedAt: DateTime

@beforeFind()
@beforeFetch()
public static ignoreDeleted(query: ModelQueryBuilderContract<typeof Subsegment>) {
    query.whereNull('deleted_at')
}

当子分类被软删除后，虽然业务记录仍然保留着对它的外键引用，但由于查询时自动添加了 whereNull('deleted_at') 条件，导致被软删除的子分类无法被查询到，从而返回 null。

解决方案

针对这个问题，开发者可以考虑以下几种解决方案：

1. 修改业务逻辑：如果子分类被软删除，应该视为无效关联，从结果中排除这些业务记录。

2. 特殊处理软删除记录：如果需要保留这些关联，可以临时禁用软删除过滤：

   .preload('allowedBusinesses', (builder) => {
     builder.preload('subsegment', (subsegmentQuery) => {
       subsegmentQuery.withTrashed() // 如果框架支持
     })
   })
   

3. 修改计算属性逻辑：在计算属性中显式处理 null 情况：

   @computed()
   public get allowedSubsegments() {
     const allowedSubsegmentsObject: Record<number, Subsegment> = []
     for (const business of this.allowedBusinesses) {
       if (business.subsegment) { // 显式检查
         allowedSubsegmentsObject[business.subsegmentId] = business.subsegment
       }
     }
     return Object.values(allowedSubsegmentsObject)
   }
   

最佳实践建议

1. 明确软删除的语义：在设计软删除功能时，应该明确其在整个系统中的含义。是被删除的数据完全不可见，还是部分场景可见。

2. 文档记录：对于重要的模型关系，特别是涉及软删除的，应该在文档中明确说明其行为。

3. 统一处理策略：在整个项目中保持对软删除数据的一致处理方式，避免不同模块采用不同策略。

4. 考虑使用视图或派生表：对于复杂的关联查询，可以考虑使用数据库视图或派生表来简化应用层逻辑。

总结

这个问题展示了在使用 ORM 时，特别是结合软删除功能时可能遇到的陷阱。AdonisJS 的 Lucid ORM 提供了强大的关系管理功能，但在使用时需要特别注意各种钩子和作用域对查询结果的影响。通过理解框架的行为和合理设计数据模型，可以避免这类问题的发生。