2016-04-11

Nodejs检测端口是否被占用

开启本地服务时，有这么一种情况：当前端口已经被另一个项目使用了，导致服务开启失败。
那么接下来，我们通过简简单单的十行代码来检测端口是否已经被占用。

思路

想要知道端口是否被占用，我们可以开启一个新的服务并监听该端口，若开启成功则说明端口未被占用，反之该端口已经被其他程序使用了。
基本思路有了，下面我们开始编写代码。

基础代码

portIsOccupied.js

var net = require('net')

// 检测端口是否被占用
function portIsOccupied (port) {
  // 创建服务并监听该端口
  var server = net.createServer().listen(port)

  server.on('listening', function () { // 执行这块代码说明端口未被占用
    server.close() // 关闭服务
    console.log('The port【' + port + '】 is available.') // 控制台输出信息
  })

  server.on('error', function (err) {
    if (err.code === 'EADDRINUSE') { // 端口已经被使用
      console.log('The port【' + port + '】 is occupied, please change other port.')
    }
  })
}

// 执行
portIsOccupied(1987)

测试

执行 node portIsOccupied.js，正常情况下会输出 The port【1987】 is available.

使用ssr将当前目录设置成静态服务器，关于ssr的使用可以在这里找到 https://github.com/jaywcjlove/ssr，
ssr默认会开启 1987 端口。

这时，再次执行 node portIsOccupied.js，输出 The port【1987】 is occupied, please change other port.

让程序更加完美

到这里为止，我们已经能够检测端口是否被占用。
但是，假如我要检测另外一个端口，每次都得更改文件的端口号，相当的麻烦。
那么有没有更加完美的实现方法呢？当然有！

Nodejs中，有这么一个好玩的东西 process.argv，它是一个数组，前两个值分别是node程序所在位置和当前运行的文件所在位置。
神奇的是，我们运行程序时，所传的参数可以通过 process.argv 得到。
比如这样子 node portIsOccupied.js -p 1987，那么会将 -p 和 1987 添加到 process.argv 数组的末尾。
知道了原理，下面我们来编写更加完美的程序吧。

控制台给程序传参

修改 portIsOccupied(1987) 为：

var port = 80 // 默认检测80端口
if (process.argv[2] === '-p') {
  port = parseInt(process.argv[3])
}

portIsOccupied(port)

执行

node portIsOccupied.js -p [port]

其中 [port] 是你想要检测的端口。

我的博客

欢迎在我的博客浏览本篇文章，地址 http://ansenhuang.github.io/