Nodejs 随机免费 TCP 端口

问题描述 投票:0回答:8

每次实例化我的类的新实例时,我的项目都需要设置一个新端口。

在 Node.js 中,我如何找到一个空闲的 TCP 端口来在我的新套接字服务器中设置?或者检查我指定的端口是否已被使用。

node.js tcp port
8个回答
112
投票

您可以通过为端口指定

0
来绑定到操作系统分配的随机空闲端口。这样您就不会受到竞争条件的影响(例如,在有机会绑定到它之前检查开放端口和绑定到它的某些进程)。

然后你可以通过调用

server.address().port
来获取分配的端口。

示例:

var net = require('net');

var srv = net.createServer(function(sock) {
  sock.end('Hello world\n');
});
srv.listen(0, function() {
  console.log('Listening on port ' + srv.address().port);
});

27
投票

对于 Express 应用程序:

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

const server = app.listen(0, () => {
  console.log('Listening on port:', server.address().port);
});

19
投票

我使用这种紧凑的形式:

import net from "net"

async function getPortFree() {
    return new Promise( res => {
        const srv = net.createServer();
        srv.listen(0, () => {
            const port = srv.address().port
            srv.close((err) => res(port))
        });
    })
}

用途:

const PORT = await getPortFree()

6
投票

端口查找器库:

https://github.com/http-party/node-portfinder

我建议你使用

portfinder
库,它一周的下载量超过1000万次。

默认情况下

portfinder
库将从8000开始搜索并扫描直到达到最大端口号(65535)。

const portfinder = require('portfinder');

portfinder.getPort((err, port) => {
    //
    // `port` is guaranteed to be a free port
    // in this scope.
    //
});

5
投票

要查找打开的 TCP 端口,您可以使用模块 portastic

你可以找到这样的端口:

port = require('portastic');

options = {
    min : 8000,
    max : 8005
}

port.find(options, function(err, data){
    if(err)
        throw err;
    console.log(data);
});

1
投票

在构建本地运行的应用程序时,我曾多次使用已接受的答案 - 感谢@mscdex。然而,我最近有一个用例,如果可能的话,最好坚持使用给定的端口,但如果该端口被占用,仍然会回退到另一个端口。

这样做的原因是我想使用 localStorage 保存应用程序首选项,为了安全起见,它仅限于同一站点、同一端口。因此,我希望尽可能使用端口 3000,但如果需要,则回退到 3001 或 3002 等,直到有可用端口为止。如果使用的端口不是 3000,那么我会回退到用户硬盘上存储的应用程序首选项的副本。

我用这个模式来做:

const http = require('http');
const server = http.createServer(function(req,res){ ... })

const config = {
  port: 3000,
  launched: false,
};

serverListen(server, config.port);

function serverListen(server, port){
  server.on('error', e => {
    console.log(`port ${config.port} is taken`)
    config.port +=1;
    server.close();
    serverListen(server, config.port);
  }).listen(port, function() {
    if (config.launched){
      return;
    }
    console.log('Listening on port ' + server.address().port);
    launchBrowser();
    config.launched = true;
  });
}

launchBrowser()
只是启动浏览器到
'http://127.0.0.1:' + server.address().port

的功能

该应用程序是一个简单的本地服务器+浏览器应用程序。浏览器是 GUI,服务器对用户硬盘上的文件等进行修改。


0
投票

等待港口

对于那些尝试“同步”执行此操作的人,下游代码依赖于操作系统选择的

port
例如,在创建测试服务器并将端口传递给测试时),以下配方已提供我很好:

export const sleepForPort = async (httpServer: Server, ms: number): Promise<number> => {
  return new Promise<number>((resolve, reject) => {
    httpServer.listen(0, async () => {
      try{
        let addr = (httpServer.address() as AddressInfo | null)
        while(! (addr && addr.port) ) {
          await sleep(ms);
          addr = httpServer.address() as AddressInfo | null
        }
        resolve(addr.port);
      }catch(e){
        reject(e);
      }
    });
  });
}

const sleep = (ms: number) => {
  return new Promise(resolve => setTimeout(resolve, ms));
}

如果针对实时服务器运行集成测试,这使我们能够

await
端口号变得可用,并返回该端口号,以便我们的
testClient
可以在此端口上命中
localhost

export const setupTests = async () => {
  const app = createExpressApp(...);
  const httpServer = createServer(app);
  server.installSubscriptionHandlers(httpServer); // Testing graphql subscriptions
  const port = await sleepForPort(httpServer, 100);
  return {port}
}

describe("Http server test", () => {
  let port: number;
  beforeAll(async () => {
    {port} = await setupTests()
  })
  it("Hits the right port", () => {
    const res = await fetch(`http://localhost:${port}/testing`)
    expect(res).toBeDefined()
    expect(res.status).toEqual(200);
  }
})

0
投票

如果您需要n个免费端口。这是我实现的解决方案,基于@priolo的解决方案。

export async function getNFreePorts(n: number): Promise<number[]> {
  const servers = [...Array(n)].map((_d) => {
    return new Promise((res) => {
      const srv = net.createServer();
      srv.listen(0, () => {
        return res(srv);
      });
    });
  });

  const activeServers: any[] = await Promise.all(servers);
  const ports = activeServers.reduce((resutls, next) => {
    if (next) {
      const p = next.address().port;
      resutls.push(p);
      next.close();
    }
    return resutls;
  }, [] as number[]);

  return ports;
}

const ports = getNFreePorts(3);

输出将是这样的:[123,444,544]

© www.soinside.com 2019 - 2024. All rights reserved.