Deno 中如何使用 Fastify 构建 Restful API？-JavaScript中文网-JavaScript教程资源分享门户

前言

Deno 是一个基于 V8 引擎的新型运行时环境，它旨在提供更安全、更简单的方式来编写和运行 JavaScript 和 TypeScript 应用程序。Deno 与 Node.js 相比有很多优势，其中之一是 Deno 内置了 TypeScript 支持，同时也支持 ES Modules（ECMAScript 模块）。Fastify 是一个高性能的 Web 框架，它使用了 Node.js 中的异步编程模型，并且支持 TypeScript。本文将介绍如何在 Deno 中使用 Fastify 构建 Restful API。

安装 Deno 和 Fastify

首先，需要安装 Deno 和 Fastify。可以通过以下命令来安装 Deno：

curl -fsSL https://deno.land/x/install/install.sh | sh

安装完成后，可以通过以下命令检查 Deno 版本：

deno --version

接着，可以使用以下命令安装 Fastify：

npm install fastify

创建一个简单的 Restful API

接下来，我们将创建一个简单的 Restful API。在项目文件夹中创建一个名为 index.ts 的文件，然后输入以下代码：

// javascriptcn.com 代码示例
import { FastifyInstance } from 'fastify';

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

fastify.get('/hello', async (request, reply) => {
  return { message: 'Hello World' };
});

const start = async () => {
  try {
    await fastify.listen(3000);
    console.log('Server is running on port 3000');
  } catch (err) {
    console.log(err);
    process.exit(1);
  }
};

start();

在上面的代码中，我们首先导入了 FastifyInstance 类型，这个类型定义了 Fastify 实例的接口。然后我们通过 require 方法导入了 Fastify 模块，创建了一个 Fastify 实例。接着，我们定义了一个 GET 请求处理程序，当客户端访问 /hello 路径时，会返回一个包含 message 属性的 JSON 对象。最后，我们通过 listen 方法启动了服务，并监听 3000 端口。

运行以下命令来启动服务：

deno run --allow-net index.ts

然后在浏览器中访问 http://localhost:3000/hello，可以看到返回的 JSON 对象。

使用路由和控制器

上面的代码虽然可以工作，但是它只是一个简单的示例。在实际应用中，我们通常需要使用路由和控制器来组织代码。下面是一个更完整的示例，它使用了路由和控制器来实现一个简单的用户管理系统。

首先，创建一个名为 UserController.ts 的文件，输入以下代码：

// javascriptcn.com 代码示例
import { FastifyRequest, FastifyReply } from 'fastify';

interface User {
  id: number;
  name: string;
}

let users: User[] = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, name: 'Charlie' },
];

export const getUsers = async (request: FastifyRequest, reply: FastifyReply) => {
  return { data: users };
};

export const getUserById = async (request: FastifyRequest, reply: FastifyReply) => {
  const id = parseInt(request.params.id, 10);
  const user = users.find(user => user.id === id);
  if (user) {
    return { data: user };
  } else {
    reply.code(404);
    return { message: 'User not found' };
  }
};

export const createUser = async (request: FastifyRequest, reply: FastifyReply) => {
  const user = request.body as User;
  user.id = users.length + 1;
  users.push(user);
  reply.code(201);
  return { data: user };
};

export const updateUser = async (request: FastifyRequest, reply: FastifyReply) => {
  const id = parseInt(request.params.id, 10);
  const userIndex = users.findIndex(user => user.id === id);
  if (userIndex !== -1) {
    const user = request.body as User;
    user.id = id;
    users[userIndex] = user;
    return { data: user };
  } else {
    reply.code(404);
    return { message: 'User not found' };
  }
};

export const deleteUser = async (request: FastifyRequest, reply: FastifyReply) => {
  const id = parseInt(request.params.id, 10);
  const userIndex = users.findIndex(user => user.id === id);
  if (userIndex !== -1) {
    const user = users[userIndex];
    users.splice(userIndex, 1);
    return { data: user };
  } else {
    reply.code(404);
    return { message: 'User not found' };
  }
};

在上面的代码中，我们定义了五个控制器方法，分别用于获取所有用户、获取指定用户、创建用户、更新用户和删除用户。每个控制器方法都接受 FastifyRequest 和 FastifyReply 参数，并返回一个包含 data 属性的 JSON 对象。其中，getUsers 方法返回所有用户，getUserById 方法根据用户 ID 返回指定用户，createUser 方法创建一个新用户，updateUser 方法更新指定用户，deleteUser 方法删除指定用户。

接着，创建一个名为 routes.ts 的文件，输入以下代码：

// javascriptcn.com 代码示例
import { FastifyInstance } from 'fastify';
import {
  getUsers,
  getUserById,
  createUser,
  updateUser,
  deleteUser,
} from './UserController';

export const routes = async (fastify: FastifyInstance) => {
  fastify.get('/users', getUsers);
  fastify.get('/users/:id', getUserById);
  fastify.post('/users', createUser);
  fastify.put('/users/:id', updateUser);
  fastify.delete('/users/:id', deleteUser);
};

在上面的代码中，我们定义了一个 routes 方法，它接受一个 FastifyInstance 实例作为参数，并注册了五个路由，分别对应上面定义的五个控制器方法。

最后，在 index.ts 文件中输入以下代码：

// javascriptcn.com 代码示例
import { FastifyInstance } from 'fastify';
import { routes } from './routes';

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

fastify.register(routes);

const start = async () => {
  try {
    await fastify.listen(3000);
    console.log('Server is running on port 3000');
  } catch (err) {
    console.log(err);
    process.exit(1);
  }
};

start();

在上面的代码中，我们首先导入了 FastifyInstance 类型和路由模块，然后创建了一个 Fastify 实例，并注册了路由。最后，启动服务并监听 3000 端口。

运行以下命令来启动服务：

deno run --allow-net --allow-read --allow-write index.ts

然后在浏览器中访问 http://localhost:3000/users，可以看到返回的 JSON 对象，其中包含了所有用户的信息。

总结

本文介绍了如何在 Deno 中使用 Fastify 构建 Restful API。我们首先创建了一个简单的示例，然后使用路由和控制器来组织代码，实现了一个简单的用户管理系统。这个示例演示了如何使用 Deno 和 Fastify 来构建高性能的 Web 应用程序，同时也为初学者提供了一个学习和参考的例子。

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