利用 Hapi.js 和 MongoDB 创建 RESTful API-JavaScript中文网-JavaScript教程资源分享门户

前言

RESTful API 在 Web 开发中已经变得非常普遍，它允许客户端通过 HTTP 协议访问服务器上的资源，实现前后端分离，使得 Web 应用程序更加可扩展、灵活、易于维护。而 Hapi.js 和 MongoDB 是目前前端领域中广受欢迎的两个技术。Hapi.js 是一个强大、可靠的 Node.js Web 应用程序框架，而 MongoDB 是一种非关系型数据库，具有高性能、易扩展等特点。本文将结合实例，介绍如何利用 Hapi.js 和 MongoDB 创建 RESTful API。

准备工作

在开始编写代码之前，我们需要先安装所需的库和工具。请确保你已经安装以下软件：

Node.js：用于运行 JavaScript 应用程序；
npm：用于 Node.js 应用程序的包管理器；
MongoDB：非关系型数据库。

安装完 Node.js 后，我们可以使用以下命令安装 Hapi.js：

npm install --save hapi

同样可以使用以下命令安装 MongoDB：

npm install --save mongodb

创建 RESTful API

在开始创建 RESTful API 之前，我们假设你已经熟悉了 Hapi.js 和 MongoDB。现在，我们来看一个简单的示例。在这个示例中，我们将创建一组 RESTful API 来管理用户数据。

连接数据库

首先，我们需要连接到 MongoDB 数据库。我们可以在项目的根目录中创建一个名为 db.js 的文件，并编写以下代码：

-- -------------------- ---- -------
----- ----------- - -------------------------------
----- --- - ----------------------------
----- ------ - --------

------------------------ - ---------------- ---- -- -------- ----- ------- -
  -- ----- ----- ----
  ---------------------- -- ------- -- ---------
  ----- -- - ------------------
  ---------------------------------------------- ----- ------ -
    -- ----- ----- ----
    ------------------ --- -------- ----- -- --- ------------
  ---
---

上面的代码创建了一个 MongoDB 的连接，并打印出数据库中用户的数量。其中，url 指定要连接的 MongoDB 实例的地址和端口号，dbName 指定要使用的数据库名称。我们还调用了 MongoClient 的 connect() 方法来建立连接。注意，我们在这里使用了回调函数来处理连接结果。由于 MongoDB 的连接是异步的，因此你需要保证在连接成功后才开始处理数据。

创建路由

接下来，我们需要创建路由来处理客户端的请求。我们可以在项目的根目录中创建一个名为 routes.js 的文件，并编写以下代码：

-- -------------------- ---- -------
---------------- - -------- -------- -------- ----- -
  --------------
    -
      ------- ------
      ----- ---------
      -------- -------- --------- ------ -
        -- ----- ------
      -
    --
    -
      ------- ------
      ----- --------------
      -------- -------- --------- ------ -
        -- ----- --------
      -
    --
    -
      ------- -------
      ----- ---------
      -------- -------- --------- ------ -
        -- ----- ----
      -
    --
    -
      ------- ------
      ----- --------------
      -------- -------- --------- ------ -
        -- ----- --------
      -
    --
    -
      ------- ---------
      ----- --------------
      -------- -------- --------- ------ -
        -- ----- --------
      -
    -
  ---
  -------
--

--------------------------- - - ----- -------- --

上面的代码为每个路由指定了 HTTP 请求方法、URL 路径和处理函数。请求方法分别为 GET、POST、PUT 和 DELETE，对应 HTTP 协议中的 CRUD 操作。我们还需要注意的一点是，在处理函数中，我们只写了 Todo 代表需要完善的代码。在后续的部分中，我们将补充完整这些处理函数。

创建模型

接下来，我们需要创建一个模型来表示用户数据。在项目的根目录中创建一个名为 user.js 的文件，并编写以下代码：

-- -------------------- ---- -------
----- -------- - --------------------

----- ---------- - --- -----------------
  --------- - ----- ------- --------- ---- --
  --------- -------
  ------ -------
  ----------- - ----- ----- -------- -------- -
---

-------------- - ---------------------- ------------

上面的代码定义了一个名为 User 的模型，我们可以通过 User 对象来访问到 MongoDB 中的用户数据。具体来说，我们定义了一个名为 UserSchema 的 mongoose.Schema 对象，在其中定义了用户的各种属性，包括用户名、密码、邮箱和创建时间。我们还使用了 mongoose.model() 方法将 UserSchema 和 User 绑定在一起，使得我们可以通过 User 来进行 CRUD 操作。

实现处理函数

接下来，我们需要实现代码中 Todo 所代表的处理函数。首先是获取用户列表的处理函数。在 user.js 文件中，我们可以加入以下代码：

exports.list = function (request, reply) {
  User.find(function (err, users) {
    if (err) return reply(err);
    reply(users);
  });
};

上面的代码使用了 User.find() 方法来查询 MongoDB 中的所有用户数据，并将结果返回到客户端。注意，这里我们需要使用回调函数来处理查询结果。如果查询成功，我们将查询到的用户数据通过 reply() 函数返回到客户端，如果查询失败，则使用 reply() 函数返回错误信息。

接下来是获取指定用户信息的处理函数，在 user.js 文件中加入以下代码：

exports.get = function (request, reply) {
  User.findById(request.params.id, function (err, user) {
    if (err) return reply(err);
    if (!user) return reply({ message: 'User not found!' });
    reply(user);
  });
};

上面的代码使用了 User.findById() 方法来查询指定 ID 的用户数据，并将结果返回到客户端。如果查询成功，我们将查询到的用户数据通过 reply() 函数返回到客户端，如果查询失败，则使用 reply() 函数返回错误信息。如果查询到的用户数据为空，则返回提示信息。

接下来是新增用户数据的处理函数，在 user.js 文件中加入以下代码：

exports.create = function (request, reply) {
  const user = new User(request.payload);
  user.save(function (err, user) {
    if (err) return reply(err);
    reply(user);
  });
};

上面的代码使用了 User.save() 方法来将客户端提供的用户数据保存到 MongoDB 数据库中，并将结果返回到客户端。如果保存成功，我们将用户数据通过 reply() 函数返回到客户端，如果保存失败，则使用 reply() 函数返回错误信息。

接下来是更新指定用户信息的处理函数，在 user.js 文件中加入以下代码：

exports.update = function (request, reply) {
  User.findByIdAndUpdate(request.params.id, request.payload, function (err, user) {
    if (err) return reply(err);
    if (!user) return reply({ message: 'User not found!' });
    reply(user);
  });
};

上面的代码使用了 User.findByIdAndUpdate() 方法来更新指定 ID 的用户数据，并将结果返回到客户端。如果更新成功，我们将更新后的用户数据通过 reply() 函数返回到客户端，如果更新失败，则使用 reply() 函数返回错误信息。如果更新的用户数据为空，则返回提示信息。

接下来是删除指定用户信息的处理函数，在 user.js 文件中加入以下代码：

exports.remove = function (request, reply) {
  User.findByIdAndRemove(request.params.id, function (err, user) {
    if (err) return reply(err);
    if (!user) return reply({ message: 'User not found!' });
    reply({ message: 'User deleted successfully!' });
  });
};

上面的代码使用了 User.findByIdAndRemove() 方法来删除指定 ID 的用户数据，并将结果返回到客户端。如果删除成功，我们将提示信息通过 reply() 函数返回到客户端，如果删除失败，则使用 reply() 函数返回错误信息。如果删除的用户数据为空，则返回提示信息。

将路由和处理函数注册到 Hapi.js 中

最后，我们需要将路由和处理函数注册到 Hapi.js 中。在 index.js 文件中加入以下代码：

-- -------------------- ---- -------
----- ---- - ----------------
----- ------ - --------------------
----- ---- - ------------------

--------------------------------------------------- - ---------------- ---- ---

----- ------ - --- --------------
------------------- ----- ---- ---
---------------------------------- ------------------ - --------- ------ --- -------- ----- -
  -- ----- ----- ----
  --------------
    -------- - ----- --------------------- --
    ----- --------- - ---------
    ------- ---------
  ---
  --------------------- -- -
    ------------------- ------- --- ---------------------
  ---
---

--------------
  - ------- ------ ----- ---- -------- -------- --------- ------ - -------------------- - --
  - ------- ------ ----- ------------------- -------- - ---------- - ----- ---------- - - --
  - ------- ------ ----- --------- -------- --------- --
  - ------- ------ ----- -------------- -------- -------- --
  - ------- ------- ----- --------- -------- ----------- --
  - ------- ------ ----- -------------- -------- ----------- --
  - ------- --------- ----- -------------- -------- ----------- -
---

上面的代码中，我们首先创建了一个 Hapi.js 服务器，并在端口号 3000 上启动。然后，我们注册了 handlebars 模板引擎和静态资源目录，接着注册了我们之前定义的路由和处理函数。

最后，在 index.js 文件中导入了 user.js 和 routes.js 文件，并将处理函数与路由绑定在一起，方便在启动服务器时一并注册。这样，我们就可以通过访问 http://localhost:3000/users，来查看数据库中所有用户的数据了。

总结

本文简单介绍了如何利用 Hapi.js 和 MongoDB 创建 RESTful API。在实际开发中，我们需要考虑数据格式、安全性和错误处理等问题。但通过本文的示例，我们可以了解到 RESTful API 的基本原理和实现方式，有助于我们更好地理解和掌握这一技术。

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

利用 Hapi.js 和 MongoDB 创建 RESTful API

前言