利用 Hapi.js 实现 API 参数校验 - 避免参数缺失、参数格式不正确引发的 bug-JavaScript中文网-JavaScript教程资源分享门户

在现代网站开发中，API 是不可或缺的组件之一。而如何保证 API 的参数正确性，是一个重要的问题。本文将介绍如何使用 Hapi.js 实现 API 参数校验，避免参数缺失、参数格式不正确引发的 bug。

Hapi.js 介绍

Hapi.js 是一个 Node.js 框架，用于构建可伸缩的 Web 应用程序。在 Hapi.js 中，通过路由配置和插件机制，实现了良好的模块化和可扩展性，使得开发者能够快速构建高质量的 Web 应用程序。

参数校验的意义

在编写 API 时，参数校验是一个非常重要的问题。如果没有对参数进行校验，可能会导致以下问题：

参数缺失：对于需要的参数缺失，应该返回错误。
参数格式不正确：对于参数格式不符合规范的请求，应该返回错误。

通过参数校验，我们可以保证 API 的正确性，防止请求数据的错误格式，保障 API 的灵活性和安全性。

Hapi.js 实现参数校验

Hapi.js 提供了一个非常简单的方式来实现参数校验，通过配置路由规则时加入 Joi 插件即可。

Joi 是一个 Node.js 的数据验证库，用于验证和处理复杂数据。它提供了丰富的数据验证方法，包括数据类型、字符串长度、邮件、手机号码等等。你可以进入 Joi 的官方网站学习更多内容。

以下是 Hapi.js 的路由规则样例代码，利用 Joi 设置参数验证规则：

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

const server = new Hapi.Server({
    port: 8080,
    host: 'localhost'
});

const init = async () => {
    server.route({
        method: 'GET',
        path: '/articles/{id}',
        handler: (request, reply) => {
            const id = request.params.id;
            return "article id is " + id;
        },
        config: {
            validate: {
                params: Joi.object({
                    id: Joi.number().integer().min(1).required()
                })
            }
        }
    });

    await server.start();
    console.log(`Server running on ${server.info.uri}`);
};

init();

在当前示例中，我们为路由规则配置了 validate 对象，进行了参数校验设置，该对象中的 params 是一个包含参数校验规则的对象。在本例中，我们要求 id 必须是一个整数，值大于等于 1。

当API 的参数格式有问题时，Hapi.js 会自动生成错误响应。下面是一个返回请求参数有误的样例响应：

http://localhost:8080/articles/test 
{"statusCode":400,"error":"Bad Request","message":"\"id\" must be a number","validation":{"source":"params","keys":["id"]}}

通过以上的简单实例，我们可以发现，Hapi.js 提供了简单易用的参数校验机制，大大简化了参数校验的工作。

总结

本文介绍了如何使用 Hapi.js 实现 API 参数校验，能够帮助 Web 开发者保证 API 的正确性。我们通过配置路由规则时加入 Joi 插件，使用其提供的验证方法，可以有效地避免参数缺失、参数格式不正确引发的 bug。

通过这个例子，我们看到 Hapi.js 真的是一个非常易于使用且功能强大的 Node.js 框架，对于复杂的 Web 应用程序开发，相信它能够帮助我们更好地完成工作。

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