npm 包 find-free-port 使用教程

npm 包 find-free-port 使用教程

前言

在前端开发中，我们常常需要运行本地服务器来进行调试或测试。然而，经常出现端口冲突的情况，导致我们无法正常启动本地服务器。这时候，我们可以利用 npm 包 find-free-port 来自动寻找一个未被占用的端口号，以解决端口冲突问题。

本篇文章将介绍 npm 包 find-free-port 的使用方法，并通过具体的示例代码来展示如何实现自动寻找空闲端口的功能。

安装

使用 npm 包管理器安装 find-free-port：

npm install find-free-port

使用方法

引入 find-free-port 模块：

const findFreePort = require('find-free-port');

find-free-port 模块提供了两种寻找空闲端口的方式，分别是 findFreePort() 和 getFreePort()。

findFreePort()

findFreePort() 方法是异步的，接收两个参数。第一个参数是要寻找空闲端口的起始端口号，第二个参数是一个回调函数。

findFreePort(startingPort, (err, freePort) => {
  if (err) {
    console.log('Error:', err);
    return;
  }
  console.log('Free port:', freePort);
})

示例代码解析：

• startingPort：要寻找空闲端口的起始端口号
• (err, freePort): 回调函数，如果找到空闲端口则返回 null 和空闲端口号；如果找不到则返回错误信息。
• console.log('Free port:', freePort);：输出空闲端口号。

getFreePort()

getFreePort() 方法是 Promise 格式的，接收一个数字作为参数，表示要寻找空闲端口的起始端口号。

getFreePort(startingPort)
  .then(freePort => console.log('Free port:', freePort))
  .catch(err => console.log('Error:', err));

示例代码解析：

• startingPort：要寻找空闲端口的起始端口号。
• .then(freePort => console.log('Free port:', freePort))：如果找到空闲端口，则输出该端口号。
• .catch(err => console.log('Error:', err))：如果出现错误，则输出错误信息。

使用建议

• 在开发前先确认要使用的端口是否已经被占用，如果被占用要先停掉占用该端口的服务；
• 尽量使用比较大的起始端口号，以提高寻找空闲端口的效率；
• 可以将寻找空闲端口的函数写入启动本地服务的流程中。

总结

本文介绍了 npm 包 find-free-port 的使用方法和注意事项，希望能对读者在开发过程中解决端口冲突问题提供帮助。

示例代码

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

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

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

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/find-free-port