Node.js Fastify装饰器：提升你的API性能与功能

news2024/12/26 5:24:44

在Node.js的世界中，Fastify以其卓越的性能和插件化架构脱颖而出，成为构建高效API的首选框架之一。Fastify的装饰器功能，允许开发者以声明式的方式增强和扩展核心对象，如请求（Request）和响应（Response）对象。本文将探讨Fastify装饰器的基本概念，并通过实例展示其如何提升API的性能与功能。
在这里插入图片描述

Fastify装饰器简介

Fastify装饰器是一种强大的工具，它允许你在Fastify的核心对象上添加自定义属性和方法。这些装饰器可以应用于服务器实例、请求和响应对象，提供了一种灵活的方式来扩展Fastify的功能，而无需修改其内部实现。

装饰器的作用

性能优化：通过预定义对象的形状，装饰器帮助JavaScript引擎优化对象的处理，从而提升性能。
功能扩展：装饰器可以在不修改核心代码的情况下，为Fastify对象添加新的方法和属性。
代码复用：装饰器支持在多个地方重用相同的逻辑，提高代码的可维护性。

使用Fastify装饰器实现请求日志记录

以下是一个使用Fastify装饰器实现请求日志记录功能的示例：

const Fastify = require('fastify');

const fastify = Fastify();

// 装饰器函数，用于日志记录
fastify.addHook('preHandler', (request, reply, done) => {
  console.log('Received request:', request.url);
  done();
});

// 装饰器，向请求对象添加自定义属性
fastify.decorateRequest('logger', {
  info: () => console.log('Info log from request object')
});

// 使用装饰器添加的属性
fastify.get('/', (request, reply) => {
  request.logger.info(); // 使用自定义的logger属性
  reply.send('Hello World!');
});

fastify.listen(3000, (err, address) => {
  if (err) throw err;
  console.log(`Server listening on ${address}`);
});

在这个例子中，我们首先使用addHook方法添加了一个preHandler钩子，它在处理每个请求之前记录请求的URL。然后，我们使用decorateRequest装饰器向请求对象添加了一个名为logger的自定义属性，该属性包含一个info方法，用于记录信息。最后，在路由处理函数中，我们调用了这个自定义的logger属性。

为了更好的说明nodejs fastify装饰器的作用，用以下是五个简单的示例，展示了Fastify装饰器在不同场景下的作用：

示例1：添加自定义方法 `add(x, y)`

const Fastify = require('fastify');
const fastify = Fastify();

// 装饰器，向Fastify实例添加自定义方法
fastify.decorate('add', function (x, y) {
  return x + y;
});

// 使用装饰器添加的方法
fastify.get('/add/:x/:y', (request, reply) => {
  const sum = request.server.add(Number(request.params.x), Number(request.params.y));
  reply.send({ result: sum });
});

fastify.listen(3000);

在这个示例中，我们使用decorate装饰器向Fastify服务器实例添加了一个add方法，用于计算两个数的和。然后，在路由处理函数中，我们调用这个方法来响应GET请求。

示例2：验证Token

const Fastify = require('fastify');
const fastify = Fastify();

// 装饰器，用于验证Token
fastify.decorate('authenticate', async (request, reply) => {
  const token = request.headers['authorization'];
  if (!token || token !== 'secret-token') {
    reply.status(401).send({ error: 'Unauthorized' });
    return false;
  }
  return true;
});

// 使用装饰器验证Token
fastify.get('/protected', async (request, reply) => {
  if (!await request.server.authenticate(request, reply)) {
    return;
  }
  reply.send({ content: 'This is protected content' });
});

fastify.listen(3000);

在这个示例中，我们创建了一个authenticate装饰器，用于检查请求头中的Authorization字段是否包含正确的token。如果验证失败，将返回401状态码。

示例3：记录请求日志

const Fastify = require('fastify');
const fastify = Fastify();

// 装饰器，向请求对象添加日志记录功能
fastify.decorateRequest('log', {
  requestLogger: (msg) => console.log(`Request Log: ${msg}`)
});

// 使用装饰器添加的日志记录功能
fastify.get('/log', (request, reply) => {
  request.log.requestLogger('Received a GET request on /log');
  reply.send({ message: 'Logged the request' });
});

fastify.listen(3000);

在这个示例中，我们使用decorateRequest装饰器向请求对象添加了一个log属性，其中包含一个requestLogger方法，用于记录请求日志。

示例4：设置响应时间头

const Fastify = require('fastify');
const fastify = Fastify();

// 装饰器，向响应对象添加设置响应时间头的功能
fastify.decorateReply('setResponseTime', function (time) {
  this.header('X-Response-Time', time);
});

// 使用装饰器添加的功能
fastify.get('/time', (request, reply) => {
  const startTime = Date.now();
  // 模拟一些异步操作
  setTimeout(() => {
    const responseTime = Date.now() - startTime;
    reply.setResponseTime(responseTime).send({ message: 'Response time set' });
  }, 1000);
});

fastify.listen(3000);

在这个示例中，我们使用decorateReply装饰器向响应对象添加了一个setResponseTime方法，用于设置响应头X-Response-Time，表示响应时间。

示例5：自定义错误处理

const Fastify = require('fastify');
const fastify = Fastify();

// 装饰器，向Fastify实例添加自定义错误处理
fastify.decorate('customError', function (msg) {
  throw new Error(msg);
});

// 使用装饰器添加的自定义错误处理
fastify.get('/error', (request, reply) => {
  request.server.customError('Something went wrong');
});

fastify.setErrorHandler((error, request, reply) => {
  reply.status(500).send({ error: error.message });
});

fastify.listen(3000);