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

debugcn 发表于 Dev

戴夫·斯坦

我在JOI 14上，似乎找不到向17升级的指南。我看到人们对JOI 16发表类似的问题，但最近的更新是3个月前。type根据我在如何在Joi中添加自定义验证器功能中看到的内容，它看起来好像不是16年代必需的。。

我正在查看https://joi.dev/api/?v=17.3.0#extensions，而对typeis的描述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())
  };
};

安赫

令人失望的是，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());

本文收集自互联网，转载请注明来源。

如有侵权，请联系[email protected] 删除。