Node.js API 函数的类型

2025 年 2 月 21 日 | 阅读 5 分钟

Node.js 是一个异步、事件驱动的语言。它广泛用于构建大型服务器端应用程序。其主要用途之一是构建和运行API(应用程序编程接口)。 重要的是要注意,API 使各种软件系统能够进行交互和交换信息。在 Node.js 中,可以根据 API 函数的性质、用途以及它们操作的数据对其进行划分。Node.js 提供了许多 API 函数,可以帮助在最短的时间内创建各种应用程序。根据功能和目标,这些 API 可以分为几类。以下是 Node.js 中各种 API 函数的详细信息,以及每种函数的分类。本文涵盖了 Node.js 中不同类别的 API 函数,以帮助理解它们的属性和应用。

HTTP API 函数

HTTP API 或应用程序编程接口是各种软件应用程序通过 Internet 使用 HTTP 交换数据的机制。它们使不同的应用程序能够共享数据和功能,而无需了解其他应用程序的内部工作原理。

GET

  • 目的:从服务器获取数据。
  • 用途:检索文档,例如网页及其组件,包括 HTML 文件、JSON 文档以及任何文件和图像等。
  • 用例示例

客户端:客户端必须请求服务器提供有关某些用户的信息。

服务器:服务器以 JSON 格式发送用户信息。

POST

  • 目的:将数据传输到服务器以创建资源。
  • 用途:进行支付、填写注册表、附加文件等。
  • 用例:客户端发送包含用户数据的注册表,服务器在数据库中创建一个新用户。

PUT

  • 目的:涉及更新服务器上的现有资源。
  • 用途:更新用户个人资料、更改产品上的特定信息等。
  • 用例:客户端传输新的用户详细信息,服务器修改数据库中指定用户的记录。

DELETE

  • 目的:从服务器删除文件。
  • 用途:无论是删除用户帐户、更改设置、永久删除博客文章,还是其他类似情况。
  • 用例:例如,客户端发送请求删除用户,服务器从数据库中删除该用户。

PATCH

  • 目的:仅更新服务器上资源的某一部分。
  • 用途:允许您更改记录的选定字段。
  • 用例:客户端仅更新用户的电子邮件,服务器仅修改用户表中记录的电子邮件。

WebSocket API 函数

连接

  • 目的:它具有客户端和服务器的持续连接。
  • 用途:建立 WebSocket 连接以实现实时解决方案。
  • 用例:客户端连接到此聊天服务器以实时接收消息。

发送

  • 目的:此方法涉及通过现有的 WebSocket 连接发送数据。
  • 用途:传达信息,例如新消息、更改或订单。
  • 用例:聊天应用程序是一个将消息从一个用户发送到另一个用户的应用程序。

接收

  • 目的:在监听范围内通过 WebSocket 连接接收数据。
  • 用途:处理从服务器或另一个客户端接收到的实际数据。
  • 用例:客户端会收到聊天中新消息的通知。

文件系统 API 函数

读取

  • 目的:从文件中读取数据。
  • 用途:检索内容以供分析或准备提供给用户。
  • 用例:使用配置文件读取应用程序配置。

写入

  • 目的:写入是将信息放入文件的过程。
  • 用途:构建或修改包含信息的 文件。
  • 用例:为了做到这一点,允许用户将其他用户生成的内容保存到文件中。

删除

  • 目的:从文件系统中删除文件。
  • 用途:清除不必要的文件、日志等。
  • 用例:删除长时间未使用的日志文件,以回收它们占用的磁盘空间。

监视

  • 目的:它跟踪文件中的更改。
  • 用途:它跟踪在实时环境中更新文件时所做的更改。
  • 用例:一个可以重新加载的开发服务器检测到源文件中的更改并重新启动应用程序。

数据库 API 函数

查询

  • 目的:从数据库获取信息。
  • 用途:运行 SQL 或 NoSQL 查询以检索信息。
  • 用例:获取数据库表中所有用户记录。

插入

  • 目的:它将新信息记录到数据存储库中。
  • 用途:它基本上是将新记录添加到数据库中的表或集合的操作。
  • 用例:将新用户注册记录写入数据库。

更新

  • 目的:更新数据库中的数据记录。
  • 用途:根据自定义参数修改字段。
  • 用例:更新数据库中用户的电子邮件。

删除

  • 目的:从数据库删除数据。
  • 用途:检查并从与条件匹配的表中删除记录。
  • 用例:如果用户选择停用其帐户,则删除用户的帐户信息。

流 API 函数

读取流

  • 目的:可用于将数据作为数据流从源读取。
  • 用途:将大文件或数据分批处理。
  • 用例:它可以在客户端播放视频文件,而无需在服务器内存中下载整个文件。

写入流

  • 目的:它以一种将数据作为永不结束的流推送到指定目的地的方式存储数据。
  • 用途:它以更少的设备空间存储大量数据输出。
  • 用例:它在事件发生时追加一个大的日志文件。

管道

  • 目的:它将可读流映射到可写流。
  • 用途:它将信息从一个管道移动到另一个管道。
  • 用例:将数据从文件读取流传递到 HTTP 响应,以更有效地提供文件。

错误处理 API 函数

捕获

  • 目的:它有助于捕获 API 操作中可能发生的错误。
  • 用途:在每个处理步骤中处理异常并根据其采取行动。
  • 用例:当遇到数据库错误时,向客户端返回 500 内部服务器错误。

Throw

  • 目的:它故意制造一个错误。
  • 用途:指向一个 API 流,该流指向特殊情况。
  • 用例:如果用户的输入与任何选项都不匹配,则会生成错误。

中间件错误处理

  • 目的:它用于纠正请求的各个阶段处理过程中可能发生的错误。
  • 用途:在错误处理中,设计中间件函数。
  • 用例:中间件接收错误,将其隐藏,然后向客户端返回一个通用的错误消息。

结论

总之,已提到和讨论的不同类型的函数,如HTTP、WebSocket、文件系统、数据库、流错误处理函数,有助于提供构建当今应用程序所需的工具,重点关注连接性。每个 API 类别都有其特定的用途,有助于数据传输、实时应用程序、文件操作、处理数据库以及处理错误。理解如何最好地利用这些 API 函数来构建复杂、可维护和全面集成的软件系统至关重要。