Sequelize create方法配置include时未返回关联Build模型问题

问题现象 #

已完成数据库迁移、模型定义与查询逻辑编写，数据库内外键配置、关联关系校验正常，但返回的iteration实例中始终无法获取关联的build属性。

相关代码 #

SequelizeBuildModel.ts #

@Table({
  tableName: 'playablebuild',
  underscored: true,
})
export class SequelizeBuildModel extends Model<
  BuildModelAttributes,
  BuildModelCreationAttributes
> {
  public id!: number;

  ...

  @HasMany(() => SequelizeIterationModel)
  public iterations!: SequelizeIterationModel[];

  ...
}

SequelizeIterationModel.ts #

import {
  BelongsTo,
  Column,
  ForeignKey,
  Model,
  Table,
} from 'sequelize-typescript';
import { SequelizeBuildModel } from './SequelizeBuildModel';
import { DataTypes, Optional } from 'sequelize';

export interface IterationModelAttributes {
  id: number;
  buildId: number;
  config: Record<string, unknown>;
}

export type IterationModelCreationAttributes = Optional<
  IterationModelAttributes,
  'id'
>;

@Table({
  tableName: 'iteration',
  underscored: true,
})
export class SequelizeIterationModel extends Model<
  IterationModelAttributes,
  IterationModelCreationAttributes
> {
  @BelongsTo(() => SequelizeBuildModel, { foreignKey: 'build_id' })
  public build!: SequelizeBuildModel;

  @ForeignKey(() => SequelizeBuildModel)
  @Column
  public buildId!: number;

  @Column({ type: DataTypes.JSONB })
  public config!: Record<string, unknown>;
}

SequelizeIterationRepository 实现 #

import { Iteration } from '../../../domain/entities/Iteration';
import { IterationRepository } from '../../../domain/ports/IterationRepository';
import {
  IterationModelCreationAttributes,
  SequelizeIterationModel,
} from '../models/SequelizeIterationModel';
import { InjectModel } from '@infra';
import { IterationMapper } from '../mappers/IterationMapper';
import { SequelizeBuildModel } from '../models/SequelizeBuildModel';

export class SequelizeIterationRepository implements IterationRepository {
  constructor(
    @InjectModel('SequelizeIterationModel')
    private readonly iterationModel: typeof SequelizeIterationModel,
    @InjectModel('SequelizeBuildModel')
    private readonly buildModel: typeof SequelizeBuildModel,
  ) {}

  public async save(iteration: Iteration): Promise<Iteration> {
    const parsedIteration = IterationMapper.toPersistence(iteration);
    return this.create(parsedIteration);
  }

  private async create(
    iteration: IterationModelCreationAttributes,
  ): Promise<Iteration> {
    const rawIteration = await this.iterationModel.create(iteration, {
      include: [{ model: this.buildModel, required: true }],
    });
    return IterationMapper.toDomain(rawIteration);
  }
}

核心异常点：无论如何调整create方法中的include配置，返回的rawIteration实例始终不包含关联build数据：

include: [{ model: this.buildModel, required: true }],

根因分析 #

问题由两个配置错误共同导致：

• 外键映射配置冲突：模型开启了underscored: true自动驼峰转下划线配置，但@BelongsTo装饰器手动指定外键为build_id，标记了@ForeignKey的buildId字段没有显式声明映射的数据库列，框架自动映射时出现字段错位，关联匹配逻辑失效。
• create方法include参数用法错误：Sequelize中create方法的include参数作用是在创建当前记录的同时级联创建关联记录，不会在创建完成后自动查询已存在的关联数据。当前场景仅传入已存在build对应的buildId，没有传入要级联创建的build完整数据，include配置完全不生效。

修复方案 #

• 第一步：统一外键映射配置，去掉重复的手动外键声明，显式指定字段映射关系，避免配置冲突：

  // 修正SequelizeIterationModel中的关联定义
  @ForeignKey(() => SequelizeBuildModel)
  // 显式指定映射到数据库的build_id列，字段类型和主键对齐
  @Column({ field: 'build_id', type: DataTypes.INTEGER })
  public buildId!: number;
  
  // 去掉手动指定的foreignKey配置，框架会自动关联到上方标记了@ForeignKey的字段
  @BelongsTo(() => SequelizeBuildModel)
  public build!: SequelizeBuildModel;
  

• 第二步：调整创建逻辑，创建完iteration后单独携带关联条件查询对应记录，拿到关联的build数据：

  private async create(
    iteration: IterationModelCreationAttributes,
  ): Promise<Iteration> {
    const createdIteration = await this.iterationModel.create(iteration);
    // 携带关联条件查询刚创建的记录
    const rawIteration = await this.iterationModel.findByPk(createdIteration.id, {
      include: [{ model: this.buildModel, required: true }],
    });
    return IterationMapper.toDomain(rawIteration!);
  }
  

补充说明：如果业务场景是创建iteration的同时需要新建关联的build记录，才需要在create方法中传入include配置，同时要在入参中带上build的完整创建属性，不能仅传buildId。

内容的提问来源于stack exchange，提问作者A Mehmeto