在 Hapi 框架中使用 Joi: 数据验证实例教程-JavaScript中文网-JavaScript教程资源分享门户

数据验证是前端和后端开发中必不可少的一部分。在 Hapi 框架中，Joi 是一款非常优秀的数据验证插件，它提供了一系列的静态方法，可以用来验证和转换请求的数据。本文将介绍如何在 Hapi 框架中使用 Joi 进行数据验证。

安装 Joi

我们可以通过 npm 安装 Joi，打开终端并输入如下命令：

npm install @hapi/joi

基础用法

使用 Joi 进行数据验证非常简单，以下是一个使用 Joi 进行基础验证的示例代码：

// javascriptcn.com 代码示例
const Joi = require('@hapi/joi');

const schema = Joi.object({
    username: Joi.string().min(3).max(30).required(),
    password: Joi.string().pattern(new RegExp('^[a-zA-Z0-9]{3,30}$'))
});

const validateUser = (user) => {
    const { error, value } = schema.validate(user);
    if (error) {
        throw new Error(`Validation failed: ${error.message}`);
    }
    return value;
}

const user = validateUser({ username: 'foo', password: 'foo123' });
console.log(user);

上述代码中，我们先定义了一个 Joi 的验证规则，即我们希望 username 字段是一个字符串，长度在 3 和 30 之间，并且是必填项；password 字段也是一个字符串，长度在 3 和 30 之间，且只能包含大写字母、小写字母和数字。

接着创建了一个 validateUser 函数，用于验证传入的用户对象是否满足我们定义的 Joi 规则，并返回验证后的用户对象。如果验证失败，将抛出一个新的错误。

最后使用示例代码来演示如何使用 validateUser 函数进行数据验证。

定义复杂的验证规则

在应用中，我们通常需要定义复杂的验证规则。例如，在验证用户的地址时，我们想要确保地址包含 country、province、city、street 四个字段，且这些字段的取值范围和格式都是正确的，我们就需要使用更加复杂的验证规则。

在 Joi 中，我们可以使用 object 方法来定义一个对象的验证规则，并在其内部定义多个字段的验证规则。在这个例子中，我们可以定义一个名为 addressSchema 的对象，其中包含了 country、province、city、street 四个字段的验证规则。示例代码如下：

// javascriptcn.com 代码示例
const addressSchema = Joi.object({
    country: Joi.string().required(),
    province: Joi.string().required(),
    city: Joi.string().required(),
    street: Joi.string().required()
});

const userSchema = Joi.object({
    username: Joi.string().min(3).max(30).required(),
    password: Joi.string().pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')),
    address: addressSchema
});

const validateUser = (user) => {
    const { error, value } = userSchema.validate(user);
    if (error) {
        throw new Error(`Validation failed: ${error.message}`);
    }
    return value;
};

const user = {
    username: 'foo',
    password: 'foo123',
    address: {
        country: 'China',
        province: 'Jiangsu',
        city: 'Nanjing',
        street: 'xxx street'
    }
};

const validatedUser = validateUser(user);
console.log(validatedUser);

在上述代码中，我们定义了一个名为 addressSchema 的对象，其中包含了 country、province、city、street 四个字段的验证规则。接着，我们定义了一个名为 userSchema 的对象，包含了 username、password 和 address 等三个字段的验证规则，并通过 address 字段引入了 addressSchema 的验证规则。

在 user 对象中传入了一个满足以上验证规则的完整的用户信息，接着调用 validateUser 函数进行数据验证，最后将验证后的用户信息输出到控制台上。

转换验证过的数据

在验证数据的过程中，我们可能需要对特定的字段进行类型转换或格式化。Joi 提供了丰富的 schema 方法，可以用来处理和转换验证后的数据。比如，我们可以调用 number 方法将字符串类型的数字转换为数字类型，或者调用 regex 方法来对字符串进行正则匹配。

在下面的示例中，我们定义了一个 userSchema 对象，其中包含 username 和 age 两个字段，其中 age 是一个字符串类型的数字，我们需要将它转换为数字类型，并且限定取值范围在 18 到 65 岁之间。示例代码如下：

// javascriptcn.com 代码示例
const userSchema = Joi.object({
    username: Joi.string().min(3).max(30).required(),
    age: Joi.string().pattern(new RegExp('^[0-9]+$')).min(2).max(2).required().transform((value) => parseInt(value))
});

const user = {
    username: 'foo',
    age: '30'
};

const validatedUser = userSchema.validate(user);
console.log(validatedUser);

在上述代码中，我们通过调用 transform 方法将 age 字段从字符串类型的数字转换为数字类型。如果 age 字段不符合我们的规范，则将抛出一个新的错误。

总结

本文介绍了在 Hapi 框架中使用 Joi 进行数据验证的基础用法，包括定义基本的验证规则、定义复杂对象的验证规则以及转换验证过的数据。这些内容是前端开发人员必须掌握的知识点之一，并可以在项目开发中提高我们的编码效率和减少错误。使用 Joi 进行数据验证非常方便和易于使用，相信本文的内容可以帮助您更好的使用 Joi 进行数据验证。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/65406df47d4982a6eb9ed761