Sequelize 核心概念：模型验证与约束详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00534/article/details/148755677

Sequelize 核心概念：模型验证与约束详解

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

引言

在数据库应用开发中，数据验证是确保数据完整性和一致性的关键环节。Sequelize 作为 Node.js 中流行的 ORM 框架，提供了强大的验证和约束机制。本文将深入解析 Sequelize 中的验证与约束功能，帮助开发者更好地理解和应用这些特性。

验证与约束的基本概念

验证（Validations）

验证是在 JavaScript 层面执行的检查，由 Sequelize 在将数据发送到数据库之前完成。验证失败时，不会执行任何 SQL 查询。验证器可以非常灵活，既可以使用内置验证器，也可以自定义验证逻辑。

约束（Constraints）

约束是在数据库层面定义的规则，由数据库引擎直接执行。当约束检查失败时，数据库会返回错误，Sequelize 会将其转换为 JavaScript 异常。常见的约束包括唯一约束、非空约束等。

唯一约束的实现

唯一约束确保字段值在表中是唯一的。在 Sequelize 中，可以通过以下方式定义：

username: {
  type: DataTypes.TEXT,
  allowNull: false,
  unique: true  // 唯一约束
}

当尝试插入重复的用户名时，Sequelize 会抛出 SequelizeUniqueConstraintError 异常。

非空约束与验证

allowNull 配置

allowNull 是 Sequelize 中唯一同时涉及验证和约束的特性：

username: {
  type: DataTypes.TEXT,
  allowNull: false  // 不允许为 null
}

这种行为体现在两个层面：

JavaScript 层面：尝试设置 null 值会立即抛出 ValidationError
数据库层面：同步后会生成 NOT NULL SQL 约束

自定义非空错误消息

可以通过验证器自定义非空错误提示：

name: {
  type: DataTypes.STRING,
  allowNull: false,
  validate: {
    notNull: {
      msg: '请输入你的名字'
    }
  }
}

强大的验证器系统

Sequelize 提供了丰富的内置验证器，主要基于 validator.js 库实现。

常用内置验证器

validate: {
  isEmail: true,            // 邮箱格式
  isUrl: true,              // URL格式
  isIP: true,               // IP地址
  isAlpha: true,            // 仅字母
  isAlphanumeric: true,     // 字母数字
  isNumeric: true,          // 仅数字
  isInt: true,              // 整数
  isFloat: true,            // 浮点数
  isLowercase: true,        // 小写字母
  isUppercase: true,        // 大写字母
  len: [2,10],              // 长度范围
  isUUID: 4,                // UUIDv4
  isDate: true,             // 日期
  isAfter: "2011-11-05",    // 指定日期之后
  isBefore: "2011-11-05",   // 指定日期之前
  max: 23,                  // 最大值
  min: 23,                  // 最小值
  isCreditCard: true        // 信用卡号
}

自定义验证器

除了内置验证器，还可以定义完全自定义的验证逻辑：

hashedPassword: {
  type: DataTypes.STRING(64),
  validate: {
    isEven(value) {
      if (parseInt(value) % 2 !== 0) {
        throw new Error('Only even values are allowed!');
      }
    },
    isGreaterThanOtherField(value) {
      if (parseInt(value) <= parseInt(this.otherField)) {
        throw new Error('当前字段必须大于otherField');
      }
    }
  }
}

验证器错误消息定制

可以为验证器提供自定义错误消息：

isIn: {
  args: [['en', 'zh']],
  msg: "必须为英文或中文"
}

模型范围验证

除了字段级别的验证，Sequelize 还支持模型范围的验证，用于检查多个字段之间的关系：

class Place extends Model {}
Place.init({
  // 字段定义...
}, {
  sequelize,
  validate: {
    bothCoordsOrNone() {
      if ((this.latitude === null) !== (this.longitude === null)) {
        throw new Error('必须同时提供或同时不提供经纬度!');
      }
    }
  }
})

这种验证在需要检查跨字段逻辑时非常有用。