轻松搭建 RESTful API 服务：从 Express 到 Fastify-JavaScript中文网-JavaScript教程资源分享门户

RESTful API 是现代 Web 开发中不可或缺的一部分。它可以让我们通过 HTTP 协议访问和操作数据，为前端和后端之间的交互提供了标准化的接口。在前端开发中，我们通常需要通过调用 RESTful API 来获取数据和提交数据，因此掌握如何搭建 RESTful API 服务是非常重要的。

本文将介绍如何使用 Node.js 和两个流行的 Web 框架 Express 和 Fastify 来搭建 RESTful API 服务。我们将从 Express 开始，逐步深入地了解 RESTful API 的实现方式，并介绍 Fastify 的一些优化技巧，以帮助您更好地构建高效的 API 服务。

Express

Express 是 Node.js 中最流行的 Web 框架之一，它提供了一组简单易用的 API 来搭建 Web 应用程序。我们可以使用 Express 来快速创建一个 RESTful API 服务。

安装

首先，我们需要安装 Express。在命令行中运行以下命令：

npm install express

创建路由

在 Express 中，我们可以使用 app.get()、app.post()、app.put()、app.delete() 等方法来定义路由。路由是指当用户访问某个 URL 时，应该执行哪些操作。

下面是一个简单的 Express 应用程序，它定义了一个 GET 请求的路由，返回一条简单的消息：

// javascriptcn.com 代码示例
const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Hello, World!');
});

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在这个例子中，我们使用 app.get() 方法定义了一个路由，当用户访问根路径时，会执行回调函数并返回一条消息。然后，我们使用 app.listen() 方法来启动服务器并指定端口号。

处理请求

在处理 RESTful API 请求时，我们通常需要从请求中获取数据，并根据不同的请求类型执行不同的操作。在 Express 中，我们可以使用 req.params、req.query 和 req.body 等属性来获取请求中的数据。

req.params：获取 URL 中的参数。
req.query：获取查询字符串参数。
req.body：获取 POST 或 PUT 请求中的数据。

下面是一个使用 Express 处理 GET 请求的例子，它从查询字符串中获取参数并返回一条消息：

app.get('/hello', (req, res) => {
  const name = req.query.name || 'World';
  res.send(`Hello, ${name}!`);
});

在这个例子中，我们定义了一个路由，当用户访问 /hello 路径时，会执行回调函数并从查询字符串中获取 name 参数。如果没有传递 name 参数，则默认为 'World'。然后，我们使用 res.send() 方法返回一条消息。

处理错误

在 RESTful API 开发中，错误处理是非常重要的一部分。如果我们不正确地处理错误，可能会导致 API 服务无法正常工作，甚至可能泄露敏感信息。

在 Express 中，我们可以使用 next(err) 方法将错误传递给下一个中间件函数，并使用 app.use() 方法定义一个错误处理中间件来处理错误。下面是一个简单的错误处理例子：

// javascriptcn.com 代码示例
app.get('/error', (req, res, next) => {
  const err = new Error('Something went wrong');
  next(err);
});

app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('Something broke!');
});

在这个例子中，我们定义了一个路由，当用户访问 /error 路径时，会执行回调函数并抛出一个错误。然后，我们使用 app.use() 方法定义了一个错误处理中间件，它会打印错误堆栈并返回一个 500 状态码和一条错误消息。

Fastify

Fastify 是一个快速、低开销的 Web 框架，它专注于提高性能和安全性。与 Express 不同，Fastify 使用异步代码并支持 Promise 和 async/await，这使得它在处理高流量和高并发请求时表现更加优秀。

安装

首先，我们需要安装 Fastify。在命令行中运行以下命令：

npm install fastify

创建路由

在 Fastify 中，我们可以使用 fastify.get()、fastify.post()、fastify.put()、fastify.delete() 等方法来定义路由。与 Express 类似，路由是指当用户访问某个 URL 时，应该执行哪些操作。

下面是一个简单的 Fastify 应用程序，它定义了一个 GET 请求的路由，返回一条简单的消息：

// javascriptcn.com 代码示例
const fastify = require('fastify')();

fastify.get('/', async (req, res) => {
  return 'Hello, World!';
});

fastify.listen(3000, () => {
  console.log('Server started on port 3000');
});

在这个例子中，我们使用 fastify.get() 方法定义了一个路由，当用户访问根路径时，会执行回调函数并返回一条消息。与 Express 不同的是，这里的回调函数是一个异步函数，并使用 return 语句返回结果。

处理请求

在 Fastify 中，我们可以使用 req.params、req.query 和 req.body 等属性来获取请求中的数据，与 Express 类似。

下面是一个使用 Fastify 处理 GET 请求的例子，它从查询字符串中获取参数并返回一条消息：

fastify.get('/hello', async (req, res) => {
  const name = req.query.name || 'World';
  return `Hello, ${name}!`;
});

在这个例子中，我们定义了一个路由，当用户访问 /hello 路径时，会执行回调函数并从查询字符串中获取 name 参数。如果没有传递 name 参数，则默认为 'World'。与 Express 不同的是，这里的回调函数是一个异步函数，并使用 return 语句返回结果。

处理错误

在 Fastify 中，我们可以使用 reply.code() 和 reply.send() 方法来处理错误。如果我们需要返回一个错误响应，我们可以使用 reply.code() 方法设置状态码，并使用 reply.send() 方法返回错误消息。

下面是一个简单的错误处理例子：

fastify.get('/error', async (req, res) => {
  const err = new Error('Something went wrong');
  res.code(500).send('Something broke!');
});

在这个例子中，我们定义了一个路由，当用户访问 /error 路径时，会执行回调函数并抛出一个错误。然后，我们使用 res.code() 方法设置状态码为 500，并使用 res.send() 方法返回一条错误消息。

优化

Fastify 专注于提高性能和安全性，因此它提供了一些优化技巧来提高 API 服务的性能。

插件

Fastify 允许我们使用插件来扩展框架的功能。插件可以用来添加路由、中间件、验证器等功能。使用插件可以使代码更加模块化，并且可以提高可重用性。

下面是一个简单的插件例子，它添加了一个 /ping 路由：

// javascriptcn.com 代码示例
const pingPlugin = (fastify, options, next) => {
  fastify.get('/ping', async (req, res) => {
    return 'pong';
  });

  next();
};

fastify.register(pingPlugin);

在这个例子中，我们定义了一个插件函数，它接受 Fastify 实例、选项和回调函数作为参数。然后，我们在插件函数中使用 fastify.get() 方法添加了一个 /ping 路由。最后，我们使用 next() 方法调用回调函数，以便 Fastify 知道插件已经完成加载。

路由前缀

Fastify 允许我们使用路由前缀来为路由分组，并且可以为每个前缀设置不同的中间件和选项。

下面是一个简单的路由前缀例子，它为 /api 前缀下的路由添加了一个认证中间件：

// javascriptcn.com 代码示例
fastify.register(require('fastify-auth'));

fastify.register((instance, opts, done) => {
  instance.addHook('preHandler', instance.authenticate);

  instance.register((subInstance, opts, done) => {
    subInstance.get('/', async (req, res) => {
      return 'Hello, World!';
    });

    done();
  }, { prefix: '/api' });

  done();
});

在这个例子中，我们首先使用 fastify-auth 插件添加了一个认证中间件。然后，我们使用 fastify.register() 方法注册一个路由前缀，将 /api 前缀下的路由添加到子实例中。最后，我们在子实例中使用 fastify.get() 方法添加了一个 / 路由，当用户访问 /api 路径时，会执行回调函数并返回一条消息。

总结

在本文中，我们学习了如何使用 Express 和 Fastify 框架来搭建 RESTful API 服务。我们了解了如何创建路由、处理请求和处理错误，并介绍了一些 Fastify 的优化技巧，如插件和路由前缀。

通过学习本文，您应该已经掌握了如何构建一个简单的 RESTful API 服务，并了解了如何使用 Fastify 框架来提高性能和安全性。在实际开发中，您可以根据需求选择适合的框架，并结合实际情况进行优化，以提高 API 服务的性能和可靠性。

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