用几行代码构建您自己的nodemon

目录

1. 简介
2. 设置项目
3. 服务器
4. 观察者
5. 将各个部分组合在一起
6. 参考资料

您可以在这里找到源代码：https://github.com/aelassas/watcher

介绍

在使用 Node.js 应用程序时，您经常需要在进行一些更改后重新启动服务器。好吧，如果每次对源代码进行一些修改时都必须手动重新启动服务器，这会很烦人。值得庆幸的是，有一些实用程序可以让您在检测到更改时自动重新启动服务器。而最著名的就是nodemon。 nodemon 是一个工具，可在检测到目录中的文件更改时自动重新启动节点应用程序，从而帮助开发基于 Node.js 的应用程序。本技巧的目的不是重新发明轮子，而是向您展示如何创建自己的实用程序来监视 Node.js 应用程序中的任何更改，并仅用几行代码即可自动重新启动服务器。

设置项目

第一步是初始化我们的 Node.js 项目：

npm init

然后，我们必须更新 package.json 以便通过将模块设置为 type:

来添加对 ES6 的支持

{
  "name": "watcher",
  "type": "module",
  "version": "1.0.0",
  "author": "Akram El Assas"
}

然后，我们将安装开发依赖项：

npm i -D @types/node

• @types/node：在 Visual Studio Code 中自动完成

服务器

我们将创建一个简单的网络服务器server.js，如下所示：

import { createServer } from 'http'

const PORT = 8888

createServer((_, res) => {
    res.writeHead(200, { 'Content-Type': 'text/plain' })
    res.write('Hello World!')
    res.end()
}).listen(PORT)

console.log('HTTP server is running on Port', PORT)

然后，我们将创建一个观察程序，以便每次通过以下命令在服务器的父文件夹及其子文件夹中检测到更改时重新启动服务器：

node watcher.js server.js

守望者

每次检测到更改时，观察者都会重新启动服务器。

首先也是最重要的，我们需要检索命令行参数。在 Node.js 中，我们可以通过 process.argv 访问命令行参数。 process.argv 属性返回一个数组，其中包含启动 Node.js 进程时传递的命令行参数。第一个元素是 execPath。第二个元素是正在执行的 JavaScript 文件的路径。其余元素将是任何附加的命令行参数。

如果我们运行以下命令：

node watcher.js server.js

process.argv 如下：

[
  'C:\Program Files\nodejs\node.exe',
  'C:\dev\watcher\src\watcher.js',
  'server.js'
]

第一个元素是 Node.js 可执行文件的路径。第二个元素是 watcher.js 的路径。最后一个元素是 server.js。因此，我们可以通过声明第一个和第三个元素来开始我们的代码，如下所示：

npm init

然后我们需要创建一个函数来启动一个子进程，该子进程使用指定文件作为参数启动 Node.js，在我们的例子中是 server.js。为此，我们将使用 child_process 模块中的 spawn 方法。 child_process.spawn() 方法使用给定命令生成一个新进程，并在 args 中使用命令行参数。使用spawn方法的优点是我们可以使用pipe方法将子进程的stdout和stderr重定向到父进程。 Pipe 方法用于将可写流附加到可读流，以便它随后切换到流动模式，然后将其拥有的所有数据推送到附加的可写流。我们函数的源代码如下所示：

{
  "name": "watcher",
  "type": "module",
  "version": "1.0.0",
  "author": "Akram El Assas"
}

首先，我们使用给定的文件参数生成一个 Node.js 子进程。然后，我们使用管道方法将子进程的stdout和stderr重定向到父进程。然后，当子进程关闭时，我们使用相同的退出代码退出父进程。 process.exit() 方法指示 Node.js 以代码的退出状态同步终止进程。如果省略 code，则 exit 使用成功代码 0 或 process.exitCode 的值（如果已设置）。在调用所有退出事件侦听器之前，Node.js 不会终止。最后，我们返回子进程。

现在，我们需要检测文件的父文件夹及其子文件夹的更改。每次检测到与 JavaScript 文件相关的更改时，我们都会终止子进程并再次生成子进程。为此，我们将使用 fs/promises 模块中的 watch 方法。 fs/promises.watch() 方法返回一个异步迭代器，用于监视文件名的更改，其中文件名是文件或目录。我们将在文件的父文件夹上创建一个观察程序。然后，我们将迭代观察者。我们将忽略 node_modules 文件夹，每次在 JavaScript 文件上检测到更改时，我们将终止子进程并再次生成它，如下所示：

npm i -D @types/node

subprocess.kill() 方法向子进程发送信号。如果没有给出参数，进程将被发送 SIGTERM 信号。 SIGKILL 信号无法被捕获、阻止或忽略，并且会强制子进程停止。请参阅 signal(7) 以获取可用信号的列表。

就是这样！我们只用几行代码就完成了我们自己的nodemon。

最后但并非最不重要的一点是，我们需要将启动和开发脚本添加到 package.json 中，如下所示：

import { createServer } from 'http'

const PORT = 8888

createServer((_, res) => {
    res.writeHead(200, { 'Content-Type': 'text/plain' })
    res.write('Hello World!')
    res.end()
}).listen(PORT)

console.log('HTTP server is running on Port', PORT)

要启动我们的应用程序，只需输入以下命令：

node watcher.js server.js

现在，如果我们运行应用程序并对 server.js 进行更改，服务器将自动重新启动。我们不再需要手动停止和启动服务器。

将各个部分组合在一起

我们只用几行代码就设置了自己的nodemon。现在，我们的 watcher.js 的整个源代码如下所示：

npm init

这只是一个简单的示例，但您可以想象其他情况，您监视视频文件的更改，并且每次检测到更改时，都会启动转换子进程（ffmpeg）。

您还可以实施其他选项，例如：

• 忽略特定文件或目录
• 观看特定目录
• 监控多个目录
• 指定扩展程序监视列表
• 延迟重启
• 运行 Node.js 以外的可执行文件，例如 Python、Ruby、make 等
• 等等...

参考

• nodemon
• child_process.spawn(命令[, args][, 选项])
• process.exit([代码])
• fsPromises.watch(文件名[, 选项])
• process.kill(pid[, signal])
• 信号(7)

以上是用几行代码构建您自己的nodemon的详细内容。更多信息请关注PHP中文网其他相关文章！