Sequelize多态关联深度解析：实现灵活数据关系模型-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01170/article/details/148755666

Sequelize多态关联深度解析：实现灵活数据关系模型

sequelize-docs-Zh-CN 项目地址: https://gitcode.com/gh_mirrors/se/sequelize-docs-Zh-CN

什么是多态关联？

多态关联是一种特殊的数据关联方式，它允许一个模型通过单一外键与多个其他模型建立关系。在实际开发中，我们经常会遇到需要将某个模型（如评论、标签）关联到多种不同类型模型（如图片、视频）的情况。

为什么需要多态关联？

传统的一对一或一对多关联在某些场景下会显得不够灵活。例如：

评论系统：希望评论既可以关联到图片，也可以关联到视频
标签系统：希望标签可以应用到不同类型的资源上

使用传统方法会导致数据库中出现多个外键字段（如imageId、videoId），这不仅浪费存储空间，还会使数据模型变得复杂。

一对多多态关联实现

基础模型定义

让我们以评论系统为例，构建图片(Image)、视频(Video)和评论(Comment)的多态关联：

class Image extends Model {}
Image.init({
  title: DataTypes.STRING,
  url: DataTypes.STRING
}, { sequelize, modelName: 'image' });

class Video extends Model {}
Video.init({
  title: DataTypes.STRING,
  text: DataTypes.STRING
}, { sequelize, modelName: 'video' });

class Comment extends Model {
  getCommentable(options) {
    if (!this.commentableType) return Promise.resolve(null);
    const mixinMethodName = `get${this.commentableType[0].toUpperCase()}${this.commentableType.substr(1)}`;
    return this[mixinMethodName](options);
  }
}
Comment.init({
  title: DataTypes.STRING,
  commentableId: DataTypes.INTEGER,
  commentableType: DataTypes.STRING
}, { sequelize, modelName: 'comment' });

关联配置关键点

禁用约束：由于一个外键要引用多个表，必须设置constraints: false
关联作用域：为不同类型设置不同的作用域条件
抽象访问方法：提供统一的getCommentable()方法获取关联对象

Image.hasMany(Comment, {
  foreignKey: 'commentableId',
  constraints: false,
  scope: { commentableType: 'image' }
});

Comment.belongsTo(Image, { 
  foreignKey: 'commentableId', 
  constraints: false 
});

Video.hasMany(Comment, {
  foreignKey: 'commentableId',
  constraints: false,
  scope: { commentableType: 'video' }
});

Comment.belongsTo(Video, { 
  foreignKey: 'commentableId', 
  constraints: false 
});

钩子处理

使用afterFind钩子统一处理查询结果，提供一致的抽象接口：

Comment.hooks.addListener("afterFind", findResult => {
  if (!Array.isArray(findResult)) findResult = [findResult];
  for (const instance of findResult) {
    if (instance.commentableType === "image" && instance.image !== undefined) {
      instance.commentable = instance.image;
    } else if (instance.commentableType === "video" && instance.video !== undefined) {
      instance.commentable = instance.video;
    }
    // 清理具体字段，避免混淆
    delete instance.image;
    delete instance.dataValues.image;
    delete instance.video;
    delete instance.dataValues.video;
  }
});

多对多多态关联实现

标签系统示例

考虑标签(Tag)可以应用到图片(Image)和视频(Video)上的场景：

class Tag extends Model {
  async getTaggables(options) {
    const images = await this.getImages(options);
    const videos = await this.getVideos(options);
    return images.concat(videos);
  }
}
Tag.init({ name: DataTypes.STRING }, { sequelize, modelName: 'tag' });

class Tag_Taggable extends Model {}
Tag_Taggable.init({
  tagId: { type: DataTypes.INTEGER, unique: 'tt_unique_constraint' },
  taggableId: { 
    type: DataTypes.INTEGER,
    unique: 'tt_unique_constraint',
    references: null 
  },
  taggableType: { 
    type: DataTypes.STRING,
    unique: 'tt_unique_constraint' 
  }
}, { sequelize, modelName: 'tag_taggable' });

关联配置

Image.belongsToMany(Tag, {
  through: {
    model: Tag_Taggable,
    unique: false,
    scope: { taggableType: 'image' }
  },
  foreignKey: 'taggableId',
  constraints: false
});

Tag.belongsToMany(Image, {
  through: {
    model: Tag_Taggable,
    unique: false
  },
  foreignKey: 'tagId',
  constraints: false
});

Video.belongsToMany(Tag, {
  through: {
    model: Tag_Taggable,
    unique: false,
    scope: { taggableType: 'video' }
  },
  foreignKey: 'taggableId',
  constraints: false
});

Tag.belongsToMany(Video, {
  through: {
    model: Tag_Taggable,
    unique: false
  },
  foreignKey: 'tagId',
  constraints: false
});