如何使用Sequelize TypeScript创建关联记录并查询关联？

一、关联创建错误排查 #

• 先检查模型关联定义是否匹配：
  • 确认关联类型（一对多、一对一等）是否正确，比如User hasMany Whisper，对应的Whisper必须belongsTo User，两边的foreignKey要一致（比如都设为userId）
  • 检查Whisper表是否存在对应的外键字段，且字段类型和User的主键类型完全匹配（比如User主键是INTEGER，外键就不能是STRING）
• 常见创建错误场景：
  • 没传正确的外键值：创建Whisper时要么通过User实例的关联方法创建，要么手动传入合法的userId（必须是User表中已存在的ID）
  • 关联方法参数错误：用user.createWhisper()时，直接传Whisper的属性对象就行，别嵌套多余结构
  • 数据库未同步：新添加关联后，要执行sequelize.sync({alter: true})更新表结构，或者用迁移脚本修改表

二、关联查询与创建的非类写法示例 #

假设是User（用户）和Whisper（低语）的一对多关联，以下是基于sequelize.define的写法：

模型定义 #

// user.ts
module.exports = (sequelize, DataTypes) => {
  const User = sequelize.define('User', {
    id: {
      type: DataTypes.INTEGER,
      primaryKey: true,
      autoIncrement: true
    },
    username: DataTypes.STRING
  });

  User.associate = (models) => {
    User.hasMany(models.Whisper, {
      foreignKey: 'userId',
      as: 'whispers' // 别名，查询时用这个关联
    });
  };

  return User;
};

// whisper.ts
module.exports = (sequelize, DataTypes) => {
  const Whisper = sequelize.define('Whisper', {
    id: {
      type: DataTypes.INTEGER,
      primaryKey: true,
      autoIncrement: true
    },
    content: DataTypes.TEXT,
    userId: DataTypes.INTEGER // 外键字段
  });

  Whisper.associate = (models) => {
    Whisper.belongsTo(models.User, {
      foreignKey: 'userId',
      as: 'author' // 别名，查询时用这个关联
    });
  };

  return Whisper;
};

关联查询示例 #

• 查询单个用户及其所有低语：

const userWithWhispers = await User.findByPk(1, {
  include: [{ model: Whisper, as: 'whispers' }]
});

• 查询单条低语及其作者：

const whisperWithAuthor = await Whisper.findByPk(1, {
  include: [{ model: User, as: 'author' }]
});

关联创建示例 #

• 通过用户实例创建低语（自动设置userId）：

const targetUser = await User.findByPk(1);
const newWhisper = await targetUser.createWhisper({
  content: '这是一条新低语'
});

• 直接创建低语并手动指定userId：

const newWhisper = await Whisper.create({
  content: '这是一条新低语',
  userId: 1
});

三、非类写法的关联资源 #

• Sequelize官方文档的「Models & Associations」章节里有完整的函数式模型关联示例，直接查看该章节即可
• GitHub上搜索sequelize functional associations example，能找到大量社区开源项目的示例，比如一些Node.js API项目、博客系统的模型定义
• Sequelize官方仓库的examples目录里，有不少基于函数式写法的关联实现案例

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