使用Ajv+ajv-errors时，如何为单个字段的type校验设置自定义错误消息？

我之前也碰到过一模一样的情况——明明按预期写法加了自定义消息，要么不生效要么直接报Schema错误。其实问题出在两个关键地方：Ajv实例的配置细节和errorMessage的正确编写方式，下面一步步给你解决：

第一步：确保Ajv实例正确加载插件并配置关键参数 #

首先必须开启allErrors: true（否则Ajv只会返回第一个错误，ajv-errors无法正常替换消息），并且正确注册ajv-errors插件：

const Ajv = require('ajv');
const ajvErrors = require('ajv-errors');

// 初始化Ajv时一定要开启allErrors
const ajv = new Ajv({ allErrors: true });
// 加载ajv-errors插件，让Ajv识别errorMessage关键字
ajvErrors(ajv);

第二步：正确编写Schema的errorMessage #

针对单个字段的type校验，你需要把errorMessage放在字段的Schema配置内，若要指定特定校验规则的消息，推荐用对象结构（避免和其他规则的消息冲突）：

标准写法（支持多规则自定义） #

{
  "type": "object",
  "properties": {
    "foo": {
      "type": "integer",
      // 用对象明确指定type规则的自定义消息
      "errorMessage": {
        "type": "foo must be an Integer"
      }
    }
  },
  // 如果foo是必填字段，记得加上required约束
  "required": ["foo"]
}

简化写法（仅当该字段只有type校验时） #

如果这个字段只需要校验类型，也可以直接写字符串：

{
  "type": "object",
  "properties": {
    "foo": {
      "type": "integer",
      "errorMessage": "foo must be an Integer"
    }
  },
  "required": ["foo"]
}

第三步：测试校验逻辑 #

用上面的Schema编译校验函数，测试错误场景：

const validate = ajv.compile(yourSchema);
const testData = { foo: "not-a-number" }; // 不符合integer类型
const isValid = validate(testData);

if (!isValid) {
  console.log(validate.errors);
  // 此时输出的第一条错误消息就是你自定义的"foo must be an Integer"
}

常见坑点排查 #

如果还是出现Schema错误或者消息不生效，检查这两点：

• 是不是忘记加载ajv-errors插件？没注册的话，Ajv会把errorMessage当成非法Schema关键字抛出错误。
• 有没有开启allErrors: true？没开的话，ajv-errors无法替换默认的错误消息。

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