NodeJS address already in use 문제 해결

npm run 명령어를 사용하여 NodeJS를 사용한 웹서비스를 실행하려 할 때 다음과 같은 에러 메시지가 나타나며 진행되지 않는 경우가 있습니다.

Error: listen EADDRINUSE: address already in use :::5000
     at Server.setupListenHandle [as _listen2] (net.js:1300:14)
     at listenInCluster (net.js:1348:12)
     at Server.listen (net.js:1436:7)
     at Application.listen (/Users/username/MyProject/node_modules/koa/lib/application.js:80:19)
     at /Users/username/MyProject/src/server/index.js:28:9
     at tryCatcher (/Users/username/MyProject/node_modules/bluebird/js/release/util.js:16:23)
     at Promise._settlePromiseFromHandler (/Users/username/MyProject/node_modules/bluebird/js/release/promise.js:547:31)
     at Promise._settlePromise (/Users/username/MyProject/node_modules/bluebird/js/release/promise.js:604:18)
     at Promise._settlePromise0 (/Users/username/MyProject/node_modules/bluebird/js/release/promise.js:649:10)
     at Promise._settlePromises (/Users/username/MyProject/node_modules/bluebird/js/release/promise.js:729:18)
     at _drainQueueStep (/Users/username/MyProject/node_modules/bluebird/js/release/async.js:93:12)
     at _drainQueue (/Users/username/MyProject/node_modules/bluebird/js/release/async.js:86:9)
     at Async._drainQueues (/Users/username/MyProject/node_modules/bluebird/js/release/async.js:102:5)
     at Immediate.Async.drainQueues (/Users/username/MyProject/node_modules/bluebird/js/release/async.js:15:14)
     at processImmediate (internal/timers.js:439:21)
 Emitted 'error' event on Server instance at:
     at emitErrorNT (net.js:1327:8)
     at processTicksAndRejections (internal/process/task_queues.js:80:21) {
   code: 'EADDRINUSE',
   errno: 'EADDRINUSE',
   syscall: 'listen',
   address: '::',
   port: 5000
 }
 [nodemon] app crashed - waiting for file changes before starting...
 > Using external babel configuration
 > Location: "/Users/username/MyProject/.babelrc"
 npm ERR! code ELIFECYCLE
 npm ERR! errno 130
 npm ERR! [email protected] server: `cross-env NODE_PATH=src nodemon src/server`
 npm ERR! Exit status 130
 npm ERR!
 npm ERR! Failed at the [email protected] server script.
 npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

 npm ERR! A complete log of this run can be found in:
 npm ERR!     /Users/username/.npm/_logs/2019-12-25T04_03_24_451Z-debug.log
[0] npm run client exited with code 0
 npm run server exited with code 130

내용이 길지만 위쪽 부분을 자세히 보시면 Error: listen EADDRINUSE: address already in use :::5000라는 내용이 있습니다.

NodeJS address already in use 문제

이는 5000번 포트가 현재 다른 프로세스에서 사용 중이기 때문에 해당 포트를 사용하는 현재 서비스를 시작할 수 없다는 에러 메시지입니다. (에러의 포트 번호가 5000이 아닐 수도 있습니다.) 이는 정말로 다른 프로세스가 사용 중이거나, NodeJS 프로세스가 이전에 비정상적으로 종료된 경우 나타나는 흔한 증상인데요.

이를 해결하기 위해서는 5000번 포트를 사용하는 프로세스를 먼저 찾고, 필요하지 않은 경우 종료(또는 강제 종료)를 해주어야 합니다. 가능한 빠른 방법은 GUI로 제공되는 프로세스 탐지 프로그램(윈도우를 예로 들자면 작업 관리자)을 사용하는 겁니다. 하지만 프로세스 탐지 프로그램에서는 특정 포트 번호를 사용하는 프로세스를 나타내지 않기 때문에 좀 더 정확히 해결하려면 아래 방법을 사용해보아야 합니다.

윈도우에서 포트를 사용하는 프로세스 찾기

윈도우는 명령 프롬프트(이하 cmd)를 열어 netstat 명령어를 통해 포트를 사용 중인 프로세스를 확인할 수 있습니다. 여기에 -a(모든 포트 표시) -n(IP:PORT 형식으로 표시), -o(PID 표시) 옵션을 붙인 명령어를 입력합니다: netstat -ano

위 사진에서처럼 5000번 포트를 사용하는 프로세스의 ID인 PID 값이 13048임을 확인할 수 있습니다. 이후 작업 관리자를 열고 세부 정보 탭(윈도우 10 기준)을 클릭한 뒤, PID를 정렬하여 13048번을 찾아보면 ‘node.exe’ 프로세스가 점유하고 있음을 알 수 있습니다. 이제 이 프로세스를 클릭한 후 하단의 ‘작업 끝내기’를 클릭하여 프로세스를 강제로 종료시킬 수 있습니다.

macOS 및 Linux에서 포트를 사용하는 프로세스 찾기

리눅스와 맥OS에서는 터미널에서 간단히 프로세스를 확인하고 종료할 수 있습니다. 여기서는 lsof라는 명령어를 사용합니다. lsof는 터미널에서 활성화된 프로세스 리스트를 출력할 수 있도록 돕는 명령어입니다. -i 옵션을 사용하면 특정 포트를 사용 중인 프로세스만 보여주게 됩니다. 이제 lsof -i 명령어를 사용해보겠습니다.

$ lsof -i TCP:5000

다음과 같이 출력 결과가 나타날 것입니다.

COMMAND   PID    USER   FD   TYPE             DEVICE SIZE/OFF NODE NAME
node    16559 user   22u  IPv6 0xe0174112e5d2e5f1      0t0  TCP *:commplex-main (LISTEN)

가장 왼쪽의 node는 프로세스 이름, 바로 우측의 16559는 프로세스의 PID값입니다. 즉 node 프로세스가 5000번 포트를 점유하고 있는 것입니다.

이제 이 프로세스를 kill 명령어를 사용하여 강제로 종료시켜보겠습니다. kill -9 16559 명령어(-9는 kill의 강제 종료 시그널인 9번을 사용한다는 의미)를 사용하여 프로세스를 종료합니다.

이제 모든 것이 완료되었습니다! npm run 명령을 다시 실행하여 문제가 해결되었는지 확인해보세요.

macOS Monterey 이후 버전에서 그래도 안되는 경우

macOS의 최근 버전부터는 가끔 특정 프로세스가 5000번과 7000번 포트를 계속해서 사용하고 있는 경우가 있습니다. 웹 개발에 5000번 포트가 주로 사용되기 때문에 개발 환경을 시작할 때 마다 문제가 발생할 수 있습니다.

$ lsof -i TCP:5000
COMMAND    PID USER   FD   TYPE             DEVICE SIZE/OFF NODE NAME
ControlCe 7136  user   10u  IPv4 0xb13956fe76f3c8f2      0t0  TCP *:commplex-main (LISTEN)
ControlCe 7136  user   11u  IPv6 0xcdc31120927294e0      0t0  TCP *:commplex-main (LISTEN)

위와 같이 다시 한번 lsof 명령어를 사용해보면 COMMAND의 내용에 ControlCenter.app 프로세스가 해당 포트를 사용하고 있음을 보여줍니다. 이는 macOS의 AirPlay를 수신 받기 위해 사용하는 포트입니다.

이를 위해서는 AirPlay 수신 모드를 꺼야 합니다. macOS의 설정에서 ‘일반 – AirDrop 및 Handoff’ 설정을 클릭합니다.