在Sequelize关联表中实现复合主键遇到问题

我之前也踩过这个坑——Sequelize用belongsToMany自动生成的多对多关联表，默认会给你加一个自增的主键字段，而不是把user_id和project_id设为复合主键。要实现你要的效果，得手动定义关联表的模型，然后显式配置复合主键，再把它和User、Project模型关联起来。

下面是具体的实现步骤：

1. 手动创建user_has_project关联表模型 #

直接定义这个表的结构，把user_id和project_id都标记为主键，同时设置它们和User、Project表的外键关联：

module.exports = function(sequelize, Sequelize) {
  const UserHasProject = sequelize.define('user_has_project', {
    user_id: {
      type: Sequelize.INTEGER(11),
      primaryKey: true, // 标记为主键
      references: {
        model: 'user', // 关联到User模型
        key: 'id'
      },
      onUpdate: 'CASCADE', // 关联更新规则
      onDelete: 'CASCADE'  // 关联删除规则
    },
    project_id: {
      type: Sequelize.INTEGER(11),
      primaryKey: true, // 同样标记为主键，形成复合主键
      references: {
        model: 'project', // 关联到Project模型
        key: 'id'
      },
      onUpdate: 'CASCADE',
      onDelete: 'CASCADE'
    },
    // 如果你的关联表需要额外字段（比如关联创建时间），可以在这里添加
    created_at: {
      type: Sequelize.DATE,
      defaultValue: Sequelize.NOW
    }
  }, {
    timestamps: false, // 关闭Sequelize自动生成的createdAt/updatedAt字段
    tableName: 'user_has_project' // 指定表名，确保和数据库中一致
  });

  return UserHasProject;
};

2. 修改User模型的关联配置 #

在你的User模型里，关联Project时指定使用我们手动创建的关联表，而不是让Sequelize自动生成：

module.exports = function(sequelize, Sequelize) {
  const User = sequelize.define('user', {
    id: {
      autoIncrement: true,
      primaryKey: true,
      type: Sequelize.INTEGER(11)
    },
    // 你的其他用户字段...
    username: {
      type: Sequelize.STRING,
      allowNull: false
    }
  }, {
    tableName: 'user'
  });

  // 关联Project模型，通过自定义的user_has_project表
  User.belongsToMany(sequelize.models.project, {
    through: 'user_has_project', // 指定关联表的模型名
    foreignKey: 'user_id', // 当前模型在关联表中的外键字段
    otherKey: 'project_id' // 关联模型在关联表中的外键字段
  });

  return User;
};

3. 修改Project模型的关联配置 #

同样，在Project模型里做对应的关联配置：

module.exports = function(sequelize, Sequelize) {
  const Project = sequelize.define('project', {
    id: {
      autoIncrement: true,
      primaryKey: true,
      type: Sequelize.INTEGER(11)
    },
    // 你的其他项目字段...
    name: {
      type: Sequelize.STRING,
      allowNull: false
    }
  }, {
    tableName: 'project'
  });

  Project.belongsToMany(sequelize.models.user, {
    through: 'user_has_project',
    foreignKey: 'project_id',
    otherKey: 'user_id'
  });

  return Project;
};

几个需要注意的点 #

• 模型加载顺序：确保在初始化Sequelize时，user_has_project模型是在User和Project之后加载的，或者在索引文件里按正确顺序导入，不然Sequelize会找不到关联表。
• 旧表清理：如果之前已经用自动生成的方式创建过user_has_project表，记得先删掉旧表，再通过sequelize.sync()或者迁移脚本重新创建带复合主键的新表。
• 关联规则：onUpdate和onDelete的规则可以根据你的业务需求调整，比如改成RESTRICT（禁止删除关联的用户/项目）或者SET NULL（删除后外键设为null）。

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