Hapi.js 学习笔记：使用 joi 进行参数校验-JavaScript中文网-JavaScript教程资源分享门户

在 Hapi.js 中，joi 是一款非常流行的参数校验工具。它可以用来验证请求参数的类型、长度、格式等等，帮助我们更加准确地捕获错误和异常，提高应用程序的健壮性和可靠性。本文将介绍如何在 Hapi.js 中使用 joi 进行参数校验，并提供示例代码。

安装 joi

在开始之前，我们需要先安装 joi。可以使用 npm 进行安装：

npm install joi

基本用法

在 Hapi.js 中使用 joi 进行参数校验非常简单。我们只需要在路由定义中添加一个 validate 选项，并指定一个 joi 的校验规则对象即可。例如：

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

const server = new Hapi.Server();
server.connection({ port: 3000 });

server.route({
  method: 'GET',
  path: '/hello/{name}',
  handler: function (request, reply) {
    reply('Hello, ' + request.params.name + '!');
  },
  config: {
    validate: {
      params: {
        name: Joi.string().min(3).max(10)
      }
    }
  }
});

server.start(function () {
  console.log('Server running at:', server.info.uri);
});

在上面的例子中，我们定义了一个 GET 请求的路由，路径为 /hello/{name}，其中 {name} 是一个参数。我们使用了 joi.string() 方法来指定参数类型为字符串，同时使用了 min() 和 max() 方法来指定参数的长度范围。这样，当请求的参数长度不符合要求时，joi 就会抛出一个错误，我们可以在 catch 块中捕获并处理这个错误。

高级用法

除了基本的参数校验之外，joi 还支持更多的高级用法，例如：

多个参数的校验

有时候，我们需要对多个参数进行校验，这时可以使用 joi.object() 方法来指定一个对象，然后对对象的属性进行校验。例如：

config: {
  validate: {
    query: {
      name: Joi.string().min(3).max(10),
      age: Joi.number().integer().min(0).max(120)
    }
  }
}

在上面的例子中，我们定义了一个 query 对象，包含两个属性 name 和 age，分别用来校验请求参数中的名称和年龄。

自定义错误信息

当校验失败时，默认的错误信息可能不符合我们的需求，这时可以使用 joi 的 error() 方法来指定自定义的错误信息。例如：

config: {
  validate: {
    params: {
      id: Joi.number().integer().required().error(new Error('Invalid ID'))
    }
  }
}

在上面的例子中，我们指定了一个自定义的错误信息，当请求参数中的 id 不是一个整数时，就会抛出这个错误。

异步校验

有时候，我们需要进行异步的参数校验，例如从数据库中查询某个值是否存在。这时可以使用 joi 的 async() 方法来指定异步校验函数。例如：

// javascriptcn.com 代码示例
config: {
  validate: {
    params: {
      id: Joi.number().integer().required().async().validate(async function (value, options) {
        const result = await db.query('SELECT COUNT(*) FROM users WHERE id = ?', [value]);
        if (result[0]['COUNT(*)'] !== 1) {
          throw new Error('Invalid ID');
        }
      })
    }
  }
}

在上面的例子中，我们使用了 async() 方法来指定一个异步的校验函数，这个函数可以异步地从数据库中查询某个值是否存在。如果查询结果不符合要求，就会抛出一个错误。

总结

使用 joi 进行参数校验是 Hapi.js 中的一项非常重要的技术。它可以帮助我们更加准确地捕获错误和异常，提高应用程序的健壮性和可靠性。本文介绍了 joi 的基本用法和高级用法，并提供了示例代码。希望本文能够对大家有所帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6505aa5f95b1f8cacd204e4f