自动生成的Express-Validator错误消息

时间:2019-09-26 09:42:26

标签: javascript node.js typescript express express-validator

我想创建一个Express API并使用express-validator验证我的请求输入。当前这是我的验证中间件

protected validate = async (request: Request, response: Response, next: NextFunction): Promise<void> => {
    const validationErrors: Result<ValidationError> = validationResult(request);

    if (!validationErrors.isEmpty()) {
        response.status(422).json({ errors: validationErrors.array() });
    } else {
        next();
    }
};

我的基本验证设置如下

public persist = [
    body('username')
        .isString()
        .withMessage('username must be of type string.')
        .isLength({ min: 1 })
        .withMessage('username must be at least one character long.')
        .exists()
        .withMessage('username is required.'),
    body('password')
        .isString()
        .withMessage('password must be of type string.')
        .isLength({ min: 1 })
        .withMessage('password must be at least one character long.')
        .exists()
        .withMessage('password is required.'),
    this.validate,
];

当我致电POST /users创建新用户时,我收到无效输入的详细错误响应。当我删除所有自定义错误消息时,会收到此响应

[
    {
        "msg": "Invalid value",
        "param": "username",
        "location": "body"
    },
    {
        "msg": "Invalid value",
        "param": "password",
        "location": "body"
    }
]

是否可以获取自动生成的错误消息,或者我真的必须自己编写这些错误消息吗?

2 个答案:

答案 0 :(得分:2)

基本上,验证器试图告诉您它认为在哪里发现了错误,并且由于它没有自定义错误字符串,因此它依赖于(相当丑陋的)“元素/位置”方案。

方法1

最合理的方法是为每个字段提供自定义错误消息。 看到错误消息相当重复,将它们移出验证器定义是有意义的,并且可能会创建一个非常简单的“ getter”函数来执行一些基本的模板处理。然后,您的代码会变得更好一些:

const MSG_TYPE_STR = '{{field}} must be of type string.'

function getMessage(fieldName: string, msgID: string): string {
   // Templating magic happens here, Regex or whatever other method you prefer
}
...

body('username')
        .isString()
        .withMessage(getMessage('username', MSG_TYPE_STR)

....

这样,您仍然会收到格式正确的错误消息,并且不会一遍又一遍地复制粘贴相同的字符串

方法2

您可以可以想象将后处理添加到验证错误中(即获取难看的输出并进行一些计算,然后将其转换为更好的输出)。这将是一个相当困难的方法,因为您必须将规则分解为原子检查,并且您的验证方案变得很长,但这仍然是一个相当大的工作

方法3

这并不是建议,而是一种“方法”-您可以切换到其他验证器,例如Joi,该验证器具有更合理的错误消息默认逻辑

答案 1 :(得分:1)

我同意亚历克斯的建议,尤其是关于Joi部分的建议。

只想提一个机会。传递给客户端的错误密钥代码。 示例:

  

usernameTooShort

这可以在客户端中处理,如果您决定将本地化添加到您的应用中,则将很有用。您将在前端有一个键值对象,该对象将根据用户选择的语言来处理消息。

祝你好运!