Hapi 框架中使用 hapi-boom-decorators 实现响应装饰器

前言

在开发 Web 应用程序时，我们通常需要对请求做出响应。Hapi 是一款流行的 Node.js Web 框架，它提供了一系列强大的功能，使得开发者可以轻松地构建高效、可维护和可扩展的 Web 应用程序。在 Hapi 中，我们可以使用 hapi-boom-decorators 模块来实现响应装饰器，从而使得我们的代码更加简洁、易读和易维护。

什么是 hapi-boom-decorators？

hapi-boom-decorators 是一个 Hapi 插件，它提供了一系列装饰器，用于简化响应的处理。这些装饰器基于 Boom 模块，它是 Hapi 中处理错误和响应的标准模块。使用 hapi-boom-decorators 可以让我们更加方便地处理响应，同时也可以提高代码的可读性和可维护性。

如何使用 hapi-boom-decorators？

在使用 hapi-boom-decorators 之前，我们需要先安装它。可以使用 npm 命令来安装：

npm install hapi-boom-decorators

安装完成后，在 Hapi 项目中引入 hapi-boom-decorators：

// www.javascriptcn.com code example
const Hapi = require('@hapi/hapi');
const Boom = require('@hapi/boom');
const HapiBoomDecorators = require('hapi-boom-decorators');

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

async function init() {
    await server.register(HapiBoomDecorators);
    // ...
}

init();

在注册插件后，我们就可以使用 hapi-boom-decorators 提供的装饰器了。

hapi-boom-decorators 的装饰器

hapi-boom-decorators 提供了多个装饰器，用于处理不同类型的响应。下面是一些常用的装饰器：

@Created()

用于返回 201 Created 响应。它接受一个可选的参数，用于指定响应的消息体。

const { Created } = require('hapi-boom-decorators');

@Created()
public async create(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@BadRequest()

用于返回 400 Bad Request 响应。它接受一个可选的参数，用于指定响应的消息体。

const { BadRequest } = require('hapi-boom-decorators');

@BadRequest()
public async update(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@Unauthorized()

用于返回 401 Unauthorized 响应。它接受一个可选的参数，用于指定响应的消息体。

const { Unauthorized } = require('hapi-boom-decorators');

@Unauthorized()
public async login(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@Forbidden()

用于返回 403 Forbidden 响应。它接受一个可选的参数，用于指定响应的消息体。

const { Forbidden } = require('hapi-boom-decorators');

@Forbidden()
public async delete(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@NotFound()

用于返回 404 Not Found 响应。它接受一个可选的参数，用于指定响应的消息体。

const { NotFound } = require('hapi-boom-decorators');

@NotFound()
public async get(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@MethodNotAllowed()

用于返回 405 Method Not Allowed 响应。它接受一个可选的参数，用于指定响应的消息体。

const { MethodNotAllowed } = require('hapi-boom-decorators');

@MethodNotAllowed()
public async post(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@Conflict()

用于返回 409 Conflict 响应。它接受一个可选的参数，用于指定响应的消息体。

const { Conflict } = require('hapi-boom-decorators');

@Conflict()
public async create(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@InternalServerError()

用于返回 500 Internal Server Error 响应。它接受一个可选的参数，用于指定响应的消息体。

const { InternalServerError } = require('hapi-boom-decorators');

@InternalServerError()
public async create(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@NotImplemented()

用于返回 501 Not Implemented 响应。它接受一个可选的参数，用于指定响应的消息体。

const { NotImplemented } = require('hapi-boom-decorators');

@NotImplemented()
public async create(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@ServiceUnavailable()

用于返回 503 Service Unavailable 响应。它接受一个可选的参数，用于指定响应的消息体。

const { ServiceUnavailable } = require('hapi-boom-decorators');

@ServiceUnavailable()
public async create(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

@BoomResponse()

用于返回自定义的 Boom 响应。它接受一个 Boom 对象作为参数。

const { BoomResponse } = require('hapi-boom-decorators');
const Boom = require('@hapi/boom');

@BoomResponse(Boom.notFound('The resource was not found.'))
public async get(request: Hapi.Request, h: Hapi.ResponseToolkit) {
    // ...
}

示例代码

下面是一个使用 hapi-boom-decorators 的示例代码：

// www.javascriptcn.com code example
const Hapi = require('@hapi/hapi');
const Boom = require('@hapi/boom');
const HapiBoomDecorators = require('hapi-boom-decorators');

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

async function init() {
    await server.register(HapiBoomDecorators);

    server.route({
        method: 'GET',
        path: '/',
        @BadRequest()
        async handler(request, h) {
            return 'Hello, World!';
        }
    });

    server.route({
        method: 'GET',
        path: '/users/{id}',
        @NotFound()
        async getUser(request, h) {
            const { id } = request.params;
            const user = await getUserById(id);
            if (!user) {
                throw Boom.notFound(`User with ID ${id} not found.`);
            }
            return user;
        }
    });

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

init();

在上面的代码中，我们使用了 @BadRequest() 和 @NotFound() 装饰器来处理响应。这样可以使我们的代码更加简洁、易读和易维护。

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