npm 包 get-server-port 使用教程

在前端开发中，经常需要启动本地服务器来测试代码，而本地服务器需要绑定一个可用的端口号。npm 包 get-server-port 可以帮助我们自动获取可用的端口号，避免手动设置端口号的繁琐过程。本文将详细介绍如何使用该包，并提供示例代码。

安装

在终端中执行以下命令安装 get-server-port：

npm install get-server-port

使用方法

引入包

在 JavaScript 文件中，使用 require 或 import 引入该包：

const getPort = require('get-server-port');
// or
import getPort from 'get-server-port';

获取端口号

使用 getPort() 方法，可以异步地获取一个未被占用的端口号：

getPort().then(port => {
  console.log(`Server started on port ${port}`);
});

如果想要指定端口号的范围，可以传入一个对象作为参数：

getPort({ port: 3000, stopPort: 4000 }).then(port => {
  console.log(`Server started on port ${port}`);
});

上面的代码表示从 3000 开始查找可用的端口号，直到 4000 结束。如果没有找到可用的端口号，会返回错误。

监听端口

获取到可用的端口号后，可以使用常见的 Node.js 服务器框架（如 Express）来监听它：

const express = require('express');
const app = express();

getPort().then(port => {
  app.listen(port, () => {
    console.log(`Server started on port ${port}`);
  });
});

错误处理

如果没有找到可用的端口号，getPort() 方法会返回一个错误。可以使用 catch 方法来捕获此错误：

getPort()
  .then(port => {
    // Do something with the port
  })
  .catch(error => {
    console.error('Could not find an available port:', error);
  });

深度解析

get-server-port 的实现原理比较简单：它通过创建一个 TCP 服务器并立即关闭它来查询系统中是否有可用的端口号。如果端口号已被占用，则继续查询下一个端口号，直到找到一个未被占用的端口号或达到指定的最大端口号。

学习意义

使用 get-server-port 可以方便地获取可用的端口号，避免手动设置端口号的繁琐过程，提高开发效率。同时，了解其实现原理也可以增加对网络编程和 TCP 协议的理解。

示例代码

完整示例代码如下：

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

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

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

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