如何在 JOI 17 中添加自定义验证器？

Question

我在 JOI 14 上，似乎找不到升级指南来升级到 17。我看到有人为 JOI 16 发布类似的问题，但最后一次更新是 3 个月前。 根据我在如何在 Joi 中添加自定义验证器 function type .

我正在查看https://joi.dev/api/?v=17.3.0#extensions并且type的描述是The type of schema. Can be a string, or a regular expression that matches multiple types. The type of schema. Can be a string, or a regular expression that matches multiple types. .

我试过这样的事情：

    const snakeAlpha = joi => {
      return {
        type: 'object',
        name: 'snakeAlpha',
        base: joi.string().regex(/^[a-z]+(_[a-z]+)*$/)
      };
    };
    
    const customJoi = Joi.extend({
      type: 'object',
      rules: {
        snakeAlpha
      }
    });

它给了我这个错误：

    ValidationError: {
      "type": "object",
      "rules": {
        "snakeAlpha" [1]: "[joi => {\n  return {\n    type: 'object',\n    name: 'snakeAlpha',\n    base: joi.string().regex(/^[a-z]+(_[a-z]+)*$/)\n  };\n}]"
      }
    }
    
    [1] "rules.snakeAlpha" must be of type object

自从说object以来，我很困惑。 我也尝试了string ，因为这就是基础，但它有相同的错误消息。

更新我还意识到原始示例仅涵盖了一个不引用 joi（正则表达式）的简单规则。 我也有引用其他自定义验证器的验证器，如下所示。 解决此案的奖励积分也是如此。

const arrayKebabAlpha = joi => {
  return {
    type: 'string',
    name: 'arrayKebabAlpha',
    base: joi.array().items(joi.kebabAlpha())
  };
};

Answer 1

对于这样一个有用的功能，Joi 扩展的文档令人失望。 幸运的是，Joi 的许多核心都是使用扩展编写的，因此可以从查看源代码中学到很多东西。

如果我把你的规则写成一个扩展，它会是这样的：

const customJoi = Joi.extend(joi => ({
    type: 'string',
    base: joi.string(),
    messages: {
        'string.snakeAlpha': '{{#label}} must be snake case'
    },
    rules: {
        snakeAlpha: {
            validate(value, helpers)
            {
                if (!/^[a-z]+(_[a-z]+)*$/.test(value))
                {
                    return helpers.error('string.snakeAlpha', { value });
                }

                return value;
            }
        }
    }
}));

可以像这样使用：

customJoi.object().keys({
    foo: customJoi.string().snakeAlpha()
});

更新

这是否是使用依赖扩展的正确方法，我不确定，但这是我通常处理它们的方式......

我首先在一个数组中定义我的扩展，确保首先定义依赖扩展。 然后，我将重复使用先前的customJoi实例来遍历数组，以便下一个扩展包含在它之前定义的那些。 一个简单的工作示例可能比我能用语言解释得更好！

（我还简化了扩展，使其更符合您习惯使用它们的方式）

const Joi = require('joi');

let customJoi = Joi;

const extensions = [
    joi => ({
        type: 'snakeAlpha',
        base: joi.string().regex(/^[a-z]+(_[a-z]+)*$/)
    }),
    // this instance of 'joi' will include 'snakeAlpha'
    joi => ({
        type: 'kebabAlpha',
        base: joi.string().regex(/^[a-z]+(-[a-z]+)*$/)
    }),
    // this instance of 'joi' will include 'snakeAlpha' and 'kebabAlpha'
    joi => ({
        type: 'arrayKebabAlpha',
        base: joi.array().items(joi.kebabAlpha())
    })
];

extensions.forEach(extension =>
    customJoi = customJoi.extend(extension));

customJoi.assert([ 'hello-world' ], customJoi.arrayKebabAlpha());