Node.js检测端口(port)是否被占用的简单示例

在开发基于Node.js的服务时，有时我们需要确保所选的端口未被其他进程占用，以避免启动服务失败的问题。本文将介绍如何使用Node.js编写一个简单的示例代码，以检测指定端口是否已被其他服务占用。 我们需要理解在TCP/IP协议栈中，端口的作用。端口是一个16位的数字，范围从0到65535，其中0到1023是系统保留端口，用于预定义的服务，如HTTP（80）、HTTPS（443）等。而1024到65535则可供用户进程自由分配。当我们创建一个网络服务器时，需要指定一个端口号，使得客户端可以通过该端口与服务器通信。 Node.js提供了一个名为`net`的内置模块，用于处理TCP和UDP网络通信。我们可以利用这个模块来检查端口的使用情况。以下是一个名为`probe`的函数，它尝试创建一个服务器监听指定的端口，并通过回调函数报告结果： ```javascript const net = require('net'); function probe(port, callback) { var server = net.createServer().listen(port); var calledOnce = false; var timeoutRef = setTimeout(function() { calledOnce = true; callback(false, port); }, 2000); timeoutRef.unref(); var connected = false; server.on('listening', function() { clearTimeout(timeoutRef); if (server) server.close(); if (!calledOnce) { calledOnce = true; callback(true, port); } }); server.on('error', function(err) { clearTimeout(timeoutRef); var result = true; if (err.code === 'EADDRINUSE') result = false; if (!calledOnce) { calledOnce = true; callback(result, port); } }); } ``` 在这个示例中，`probe`函数执行以下步骤： 1. 创建一个`net.Server`实例并尝试监听指定的`port`。 2. 设置一个2秒的超时，如果在此期间服务器没有成功监听，假设端口已被占用，然后调用回调函数返回`false`。 3. 如果`server`成功启动，说明端口可用，关闭服务器并调用回调函数返回`true`。 4. 当服务器在尝试监听时遇到错误，特别是当错误代码为`EADDRINUSE`（地址已被使用）时，表明端口已被占用，回调函数返回`false`。 接下来，定义一个名为`server`的函数，它接收一个可选的端口号`_port`，并使用`probe`函数检查该端口是否可用。如果端口被占用，函数会递归调用自身，尝试下一个端口： ```javascript function server(_port) { var pt = _port || __port; // 假设__port是默认端口号 probe(pt, function(bl, _pt) { if (bl === true) { // 如果端口可用，启动服务器 // ssr(_pt) // 这里假设ssr是一个服务启动函数 const server = http.createServer(connListener); server.listen(parseInt(_pt, 10)); console.log( "\n Static file server running at" + "\n\n=> http://localhost:" + _pt + '\n' ); } else { // 如果端口被占用，尝试下一个端口 server(_pt + 1); } }); } ``` 在这个例子中，如果找到可用端口，服务器将启动并打印出运行的URL。如果所有尝试的端口都被占用，程序将无休止地递归下去，这并不是一个理想的解决方案。在实际应用中，你可能需要设置一个最大尝试次数，或在找不到空闲端口时抛出错误。 总结来说，这个简单的Node.js示例展示了如何使用`net`模块检测端口是否被占用，以及在找到空闲端口后如何启动服务器。这个技巧对于开发需要自定义端口的应用非常有用，特别是在多项目共存的环境中。在实际项目中，你可能需要根据需求进行相应的调整，例如添加日志记录、错误处理或优化端口查找策略。