Dream of E&C - Wiki

이 문서는 읽기 전용입니다. 원본을 볼 수는 있지만 바꿀 수는 없습니다. 문제가 있다고 생각하면 관리자에게 문의하세요.
====== 🟢 Node.js ======

Node.js는 JavaScript를 사용하여 웹 서버나 다양한 네트워크 애플리케이션을 만들 수 있게 해주는 특별한 도구입니다. 웹 브라우저 밖에서도 JavaScript 코드를 실행할 수 있도록 해주어, 서버 개발에 매우 유용하게 사용됩니다.

===== 1. 정의 =====

**Node.js**는 Chrome의 V8 JavaScript 엔진을 기반으로 만들어진 **서버 사이드 JavaScript 런타임 환경**입니다. 여기서 ''V8 엔진''은 Google Chrome 웹 브라우저가 JavaScript 코드를 매우 빠르게 실행할 수 있도록 해주는 핵심 기술입니다. Node.js는 이 강력한 엔진을 활용하여, 웹 브라우저 없이도 컴퓨터에서 JavaScript 코드를 직접 실행할 수 있게 합니다.

Node.js는 **이벤트 기반(Event-driven)**, **논블로킹 I/O(Non-blocking I/O)** 모델을 사용하여 가벼우면서도 효율적인 애플리케이션을 개발할 수 있도록 설계되었습니다. 이는 동시에 많은 사용자의 요청을 빠르고 안정적으로 처리해야 하는 웹 서비스에 특히 유리합니다.

===== 2. 주요 특징 =====

----
==== 1) 이벤트 기반 (Event-driven) ====
Node.js는 '이벤트'가 발생하면 미리 정의된 '콜백 함수'를 실행하는 방식으로 동작합니다. 예를 들어, 사용자가 웹 페이지에 접속하거나 파일 읽기가 완료되면, Node.js는 해당 이벤트를 감지하고 미리 약속된 작업을 수행합니다.

  * **동작 원리**: 마치 레스토랑에서 주문이 들어오면 요리사가 요리 중에도 다음 주문을 먼저 받고, 요리가 완성되면 "이벤트"를 발생시켜 서빙하는 것과 비슷합니다. 하나의 요청이 끝날 때까지 기다리지 않고, 여러 요청을 동시에 처리할 준비를 합니다.
  * **장점**: 비동기 프로그래밍을 지원하여 동시에 많은 요청을 효율적으로 처리할 수 있습니다. 이는 서버의 응답 속도를 향상시키고, 더 많은 사용자를 수용할 수 있게 합니다.

----
==== 2) 논블로킹 I/O (Non-blocking I/O) ====
'I/O'는 'Input/Output'의 약자로, 파일 시스템 접근(파일 읽기/쓰기), 데이터베이스 쿼리, 네트워크 요청(다른 서버와 통신)과 같은 작업을 의미합니다. '블로킹(Blocking)' 방식은 이러한 I/O 작업이 완료될 때까지 다른 작업을 멈추고 기다리는 것을 말합니다.

  * **동작 원리**: Node.js는 논블로킹 방식으로 작동하여 I/O 작업이 진행 중일 때 다른 작업을 계속 처리합니다. 예를 들어, 서버가 데이터베이스에서 데이터를 요청하면, 그 데이터가 도착할 때까지 기다리지 않고 다른 사용자의 요청을 처리하거나 다른 코드를 실행합니다. 데이터가 준비되면 그때 다시 해당 요청을 처리합니다.
  * **장점**: 특정 작업이 지연되더라도 전체 서버의 동작이 멈추지 않아 높은 성능과 확장성을 제공합니다. 대규모 동시 접속 환경에서 특히 유리합니다.

----
==== 3) 크로스 플랫폼 (Cross-platform) ====
Node.js는 특정 운영체제에 종속되지 않고 다양한 환경에서 실행될 수 있습니다.

  * **장점**: 개발자는 Windows, macOS, Linux 등 어떤 운영체제에서도 동일한 Node.js 코드를 작성하고 실행할 수 있습니다. 이는 개발 및 배포 과정을 간소화하고, 팀원 간의 협업을 용이하게 합니다.

===== 3. 기본 구조 =====

Node.js 애플리케이션의 핵심적인 동작 방식을 이해하기 위한 두 가지 예제를 살펴봅니다.

----
==== 1) 간단한 HTTP 서버 예제 ====
웹 서버는 클라이언트(웹 브라우저 등)의 요청을 받아 응답을 보내주는 역할을 합니다. 다음 코드는 Node.js로 가장 기본적인 웹 서버를 만드는 방법을 보여줍니다.

<file javascript>
const http = require('http'); // 1. Node.js에 내장된 'http' 모듈을 가져옵니다.
                              //    이 모듈은 웹 서버를 만들고 HTTP 요청을 처리하는 기능을 제공합니다.

const server = http.createServer((req, res) => { // 2. 'http' 모듈을 사용하여 서버를 생성합니다.
                                             //    이 함수는 클라이언트 요청이 올 때마다 실행됩니다.
                                             //    'req'는 요청(Request) 정보, 'res'는 응답(Response) 객체입니다.
    res.writeHead(200, { 'Content-Type': 'text/plain' }); // 3. 응답 헤더를 설정합니다.
                                                        //    '200'은 성공적인 응답을 의미하고,
                                                        //    'Content-Type'은 클라이언트에게 보내는 데이터의 종류를 알려줍니다.
    res.end('Hello World\n'); // 4. 클라이언트에게 'Hello World'라는 텍스트를 응답으로 보냅니다.
                              //    'res.end()'는 응답 전송을 완료하고 연결을 닫습니다.
});

server.listen(3000, () => { // 5. 서버를 3000번 포트에서 '수신 대기' 상태로 만듭니다.
                            //    이제 웹 브라우저에서 'http://localhost:3000'으로 접속하면
                            //    위에서 정의한 'Hello World' 응답을 받을 수 있습니다.
    console.log('서버가 포트 3000에서 실행 중입니다.'); // 6. 서버가 성공적으로 시작되면 콘솔에 메시지를 출력합니다.
});
</file>

  * **설명**: 이 코드는 3000번 포트에서 요청을 기다리는 간단한 웹 서버를 만듭니다. 클라이언트가 이 서버에 접속하면 "Hello World"라는 텍스트를 응답으로 보냅니다. 이는 Node.js가 어떻게 웹 요청을 받아 처리하고 응답을 보내는지 보여주는 가장 기본적인 예시입니다.

----
==== 2) 모듈 시스템 ====
애플리케이션의 규모가 커질수록 코드를 여러 파일로 나누어 관리하는 것이 중요해집니다. Node.js는 '모듈 시스템'을 통해 이러한 코드 분할 및 재사용을 가능하게 합니다.

  * **필요성**: 코드를 모듈로 나누면 각 모듈이 특정 기능만을 담당하게 되어 코드를 이해하고 유지보수하기 쉬워집니다. 또한, 다른 프로젝트에서도 해당 모듈을 재사용할 수 있어 개발 효율성이 높아집니다.
  * **동작 원리**:
    *   ''module.exports'': 다른 파일에서 사용할 수 있도록 특정 값(변수, 함수, 객체 등)을 내보낼 때 사용합니다.
    *   ''require()'': 다른 파일에 있는 모듈을 현재 파일로 가져올 때 사용합니다.

<file javascript>
// math.js 파일 (모듈 내보내기)
// 이 파일은 덧셈과 뺄셈 기능을 제공하는 모듈입니다.
module.exports = { // 'module.exports'를 사용하여 'add'와 'subtract' 함수를 외부로 내보냅니다.
    add: (a, b) => a + b,
    subtract: (a, b) => a - b
};

// app.js 파일 (모듈 가져오기 및 사용)
// 이 파일은 위에서 만든 'math.js' 모듈을 가져와 사용합니다.
const math = require('./math'); // './math'는 현재 디렉토리에 있는 'math.js' 파일을 의미합니다.
                                // 'require()' 함수를 사용하여 'math' 변수에 모듈이 내보낸 객체를 할당합니다.
console.log(math.add(5, 3)); // 8 // 'math' 객체의 'add' 함수를 호출하여 덧셈을 수행합니다.
</file>

===== 4. 패키지 관리 =====

Node.js 생태계에서 개발을 효율적으로 하기 위해서는 다른 개발자들이 만든 유용한 코드 묶음(패키지 또는 라이브러리)을 가져와 사용하는 것이 일반적입니다.

----
==== 1) npm (Node Package Manager) ====
''npm''은 Node.js의 기본 **패키지 관리자**입니다. 전 세계 개발자들이 공유하는 수많은 Node.js 패키지들을 쉽게 설치하고 관리할 수 있도록 도와줍니다.

  * **주요 기능**:
    *   **패키지 설치**: 필요한 라이브러리를 명령 한 줄로 쉽게 설치할 수 있습니다 (예: ''npm install express'').
    *   **의존성 관리**: 프로젝트가 어떤 패키지들을 사용하는지 기록하고, 해당 패키지들이 제대로 설치되도록 관리합니다.
    *   **스크립트 실행**: 개발, 테스트, 배포 등 프로젝트에서 자주 사용하는 명령들을 미리 정의해두고 간편하게 실행할 수 있습니다.

----
==== 2) package.json 예제 ====
''package.json'' 파일은 Node.js 프로젝트의 **설명서**와 같습니다. 프로젝트의 이름, 버전, 설명, 실행 스크립트, 그리고 어떤 외부 패키지(의존성)를 사용하는지 등의 정보를 담고 있습니다.

<file json>
{
  "name": "my-project", // 프로젝트의 이름
  "version": "1.0.0", // 프로젝트의 현재 버전
  "description": "프로젝트 설명", // 프로젝트에 대한 간단한 설명
  "main": "index.js", // 이 프로젝트의 시작점(메인 파일)을 지정합니다.
  "scripts": { // 자주 사용하는 명령어를 정의합니다.
    "start": "node index.js", // 'npm start'를 입력하면 'node index.js'가 실행됩니다.
    "dev": "nodemon index.js", // 'npm run dev'를 입력하면 'nodemon index.js'가 실행됩니다.
    "test": "jest" // 'npm test'를 입력하면 'jest' 테스트 프레임워크가 실행됩니다.
  },
  "dependencies": { // 애플리케이션이 '실제로 동작할 때' 필요한 패키지들입니다.
    "express": "^4.18.2", // 웹 애플리케이션 프레임워크
    "socket.io": "^4.7.2" // 실시간 양방향 통신 라이브러리
  },
  "devDependencies": { // 애플리케이션을 '개발할 때' 필요한 패키지들입니다.
                       // 실제 배포 환경에서는 필요하지 않을 수 있습니다.
    "nodemon": "^3.0.1" // 개발 중 코드 변경 시 서버를 자동 재시작해주는 도구
  }
}
</file>

  * **설명**: 이 파일은 프로젝트의 메타데이터를 제공하고, ''npm''이 프로젝트를 관리하고 실행하는 데 필요한 모든 정보를 담고 있습니다.

===== 5. 개발 환경 =====

효율적인 Node.js 개발을 위해 유용한 도구와 설정 방법을 알아봅니다.

----
==== 1) nodemon ====
개발 중에는 코드를 수정할 때마다 서버를 껐다가 다시 켜야 하는 번거로움이 있습니다. ''nodemon''은 이러한 불편함을 해소해주는 도구입니다.

  * **필요성**: ''nodemon''은 소스 코드 파일의 변경을 자동으로 감지하고, 변경이 있을 때마다 Node.js 애플리케이션을 자동으로 재시작해줍니다. 이는 개발자가 코드를 수정하고 결과를 즉시 확인할 수 있도록 하여 개발 속도를 크게 향상시킵니다.
  * **사용법**:
<file bash>
# nodemon 설치
# '-g' 옵션은 nodemon을 전역으로 설치하여 어떤 프로젝트에서든 사용할 수 있게 합니다.
npm install -g nodemon

# 개발 서버 실행
# 'app.js'는 개발 중인 Node.js 애플리케이션의 시작 파일입니다.
nodemon app.js
</file>

----
==== 2) 환경 변수 관리 ====
애플리케이션은 데이터베이스 연결 정보, API 키, 포트 번호 등 환경에 따라 달라지거나 민감한 정보를 포함할 수 있습니다. 이러한 정보들을 코드 안에 직접 작성하는 것은 보안상 좋지 않으며, 환경이 바뀔 때마다 코드를 수정해야 하는 불편함이 있습니다. **환경 변수**는 이러한 문제를 해결해줍니다.

  * **필요성**: 환경 변수를 사용하면 민감한 정보를 코드 외부에 저장하고, 개발 환경, 테스트 환경, 프로덕션 환경 등 각기 다른 환경에 맞게 쉽게 설정할 수 있습니다. 이는 보안을 강화하고, 배포 과정을 유연하게 만듭니다.
  * **사용법**: ''dotenv''와 같은 라이브러리를 사용하여 '''.env''' 파일에 환경 변수를 정의하고 애플리케이션에서 접근할 수 있습니다.

<file javascript>
// dotenv 패키지를 사용하여 .env 파일에 정의된 환경 변수를 로드합니다.
// 이 코드는 보통 애플리케이션의 가장 상단에 위치합니다.
require('dotenv').config();

// process.env 객체를 통해 환경 변수에 접근할 수 있습니다.
// 만약 PORT 환경 변수가 설정되어 있지 않으면 기본값으로 3000을 사용합니다.
const port = process.env.PORT || 3000;
// DATABASE_URL 환경 변수에 저장된 데이터베이스 연결 문자열을 가져옵니다.
const dbUrl = process.env.DATABASE_URL;
</file>

===== 6. 프로덕션 배포 =====

개발이 완료된 Node.js 애플리케이션을 실제 사용자들이 접근할 수 있도록 서버에 배포하는 것은 중요한 과정입니다. 배포 환경에서는 애플리케이션이 안정적으로 계속 실행되도록 관리하는 것이 중요합니다.

----
==== 1) PM2 사용 ====
''PM2''는 Node.js 애플리케이션을 위한 강력한 **프로세스 관리자**입니다. 프로덕션 환경에서 애플리케이션이 멈추지 않고 안정적으로 실행되도록 도와줍니다.

  * **필요성**: Node.js 애플리케이션이 오류로 인해 중단되거나 서버가 재부팅될 때 자동으로 다시 시작해주는 기능이 필요합니다. 또한, 여러 CPU 코어를 효율적으로 사용하기 위한 로드 밸런싱 기능도 중요합니다. PM2는 이러한 기능을 제공하여 애플리케이션의 안정성과 성능을 향상시킵니다.
  * **주요 기능**:
    *   **자동 재시작**: 애플리케이션이 예기치 않게 종료되거나 서버가 재부팅될 때 자동으로 다시 시작합니다.
    *   **클러스터 모드**: 서버의 여러 CPU 코어를 활용하여 애플리케이션의 성능을 극대화합니다.
    *   **모니터링**: 애플리케이션의 상태, CPU 사용량, 메모리 사용량 등을 실시간으로 모니터링할 수 있습니다.

<file bash>
# PM2 설치
# '-g' 옵션으로 전역 설치하여 어디서든 PM2 명령어를 사용할 수 있게 합니다.
npm install -g pm2

# 애플리케이션 시작
# 'app.js' 파일을 PM2로 실행하고, 'my-app'이라는 이름으로 관리합니다.
pm2 start app.js --name "my-app"

# 클러스터 모드
# 서버의 CPU 코어 수만큼 워커 프로세스를 생성하여 로드 밸런싱을 자동으로 처리합니다.
# 'max'는 사용 가능한 모든 CPU 코어를 사용하라는 의미입니다.
pm2 start app.js -i max
</file>

===== 7. 성능 최적화 =====

Node.js 애플리케이션의 성능을 최대한 끌어올리고 안정성을 확보하기 위한 기법들을 알아봅니다.

----
==== 1) 메모리 관리 ====
Node.js는 JavaScript를 사용하며, JavaScript는 '가비지 컬렉션(Garbage Collection)'을 통해 자동으로 메모리를 관리합니다. 하지만 때때로 메모리 누수(Memory Leak)가 발생하거나, 특정 시점에 메모리 사용량을 확인해야 할 필요가 있습니다.

  * **필요성**: 메모리 누수는 애플리케이션이 불필요한 메모리를 계속 점유하여 결국 서버의 성능 저하를 일으키고, 심하면 애플리케이션이 강제 종료될 수 있습니다. 메모리 사용량을 모니터링하고 관리하는 것은 이러한 문제를 예방하는 데 중요합니다.
  * **가비지 컬렉션**: 사용하지 않는 메모리를 자동으로 해제하는 과정입니다. Node.js는 V8 엔진의 가비지 컬렉터를 사용합니다.

<file javascript>
// 개발 또는 디버깅 목적으로 가비지 컬렉션을 강제로 실행할 수 있지만,
// 실제 프로덕션 환경에서는 권장되지 않습니다. V8 엔진이 최적의 시점에 수행합니다.
if (global.gc) {
    global.gc();
}

// 현재 Node.js 프로세스의 메모리 사용량을 모니터링합니다.
// 'heapUsed'는 V8 엔진이 사용 중인 힙(Heap) 메모리 양을 나타냅니다.
const used = process.memoryUsage();
console.log(`메모리 사용량: ${Math.round(used.heapUsed / 1024 / 1024)} MB`);
</file>

----
==== 2) 클러스터 모드 ====
Node.js는 기본적으로 단일 스레드(Single-threaded) 방식으로 동작합니다. 이는 하나의 CPU 코어만 사용하여 작업을 처리한다는 의미입니다. 하지만 최신 서버는 대부분 여러 개의 CPU 코어를 가지고 있습니다. '클러스터 모드'는 이러한 다중 코어를 효율적으로 활용할 수 있게 해줍니다.

  * **필요성**: 단일 스레드 방식으로는 서버의 모든 CPU 코어를 활용할 수 없어, 대규모 트래픽을 처리할 때 성능 한계에 부딪힐 수 있습니다. 클러스터 모드는 여러 워커 프로세스를 생성하여 각 워커가 하나의 CPU 코어를 담당하게 함으로써, 서버의 처리량을 크게 늘리고 안정성을 높입니다.
  * **동작 원리**: '마스터 프로세스'가 워커 프로세스들을 관리하고, 들어오는 요청들을 워커들에게 분배합니다. 각 '워커 프로세스'는 Node.js 애플리케이션의 독립적인 인스턴스입니다.

<file javascript>
const cluster = require('cluster'); // Node.js 내장 'cluster' 모듈을 가져옵니다.
const numCPUs = require('os').cpus().length; // 서버의 CPU 코어 수를 가져옵니다.

if (cluster.isMaster) { // 현재 프로세스가 마스터 프로세스인지 확인합니다.
    // 마스터 프로세스: 워커 프로세스들을 생성하고 관리하는 역할을 합니다.
    console.log(`마스터 프로세스 ${process.pid}가 실행 중입니다.`);
    for (let i = 0; i < numCPUs; i++) {
        cluster.fork(); // CPU 코어 수만큼 워커 프로세스를 생성합니다.
    }

    cluster.on('exit', (worker, code, signal) => {
        console.log(`워커 프로세스 ${worker.process.pid}가 종료되었습니다. 다시 시작합니다.`);
        cluster.fork(); // 워커 프로세스가 비정상적으로 종료되면 새로운 워커를 다시 생성하여 안정성을 유지합니다.
    });
} else {
    // 워커 프로세스: 실제 애플리케이션 코드를 실행하는 역할을 합니다.
    console.log(`워커 프로세스 ${process.pid}가 시작되었습니다.`);
    require('./app.js'); // 워커 프로세스에서 실제 Node.js 애플리케이션 파일(예: app.js)을 실행합니다.
}
</file>

===== 8. 디버깅 =====

애플리케이션을 개발하다 보면 오류(버그)가 발생하기 마련입니다. 이러한 오류를 찾아내고 수정하는 과정을 **디버깅**이라고 합니다. 효과적인 디버깅은 개발 시간을 단축하고 애플리케이션의 품질을 높이는 데 필수적입니다.

----
==== 1) 내장 디버거 사용 ====
Node.js는 코드를 한 줄씩 실행하며 변수 값을 확인하고 프로그램의 흐름을 제어할 수 있는 강력한 내장 디버거를 제공합니다.

  * **필요성**: 단순히 ''console.log()''를 사용하는 것보다 훨씬 정밀하게 코드의 문제를 파악할 수 있습니다. 특정 지점에서 실행을 멈추고(브레이크포인트), 변수 값을 변경해보거나, 다음 줄로 넘어가는 등 상세한 조작이 가능합니다.
  * **사용법**:
<file bash>
# 디버그 모드로 Node.js 애플리케이션을 실행합니다.
# 이 명령을 실행하면 Chrome 개발자 도구와 같은 외부 디버거를 연결할 수 있는 주소가 콘솔에 출력됩니다.
node --inspect app.js

# 코드 내에서 특정 지점에 실행을 멈추고 싶을 때 'debugger;' 키워드를 삽입합니다.
# 디버그 모드로 실행 중 이 키워드를 만나면 실행이 일시 중지됩니다.
</file>

----
==== 2) 로깅 ====
**로깅**은 애플리케이션의 실행 중에 발생하는 중요한 정보(오류, 경고, 일반 정보 등)를 기록하는 과정입니다. 특히 프로덕션 환경에서는 디버거를 직접 사용할 수 없으므로, 로그 파일은 문제 해결의 핵심 단서가 됩니다.

  * **필요성**: 애플리케이션이 어떻게 동작하고 있는지, 어떤 문제가 발생했는지 등을 파악하는 데 필수적입니다. 사용자 요청 흐름 추적, 성능 문제 분석, 보안 감사 등 다양한 목적으로 활용됩니다. ''winston''과 같은 로깅 라이브러리는 로그 레벨(정보, 경고, 오류 등)별로 로그를 분류하고, 파일이나 데이터베이스 등 다양한 곳에 저장할 수 있게 해줍니다.

<file javascript>
const winston = require('winston'); // winston은 강력하고 유연한 로깅 라이브러리입니다.

const logger = winston.createLogger({ // 로거 인스턴스를 생성합니다.
    level: 'info', // 'info' 레벨 이상의 로그(info, warn, error)를 기록합니다.
    format: winston.format.json(), // 로그를 JSON 형식으로 출력하여 분석하기 쉽게 만듭니다.
    transports: [ // 로그를 어디로 보낼지(저장할지) 정의합니다.
        // 'error.log' 파일에는 'error' 레벨의 로그만 기록합니다.
        new winston.transports.File({ filename: 'error.log', level: 'error' }),
        // 'combined.log' 파일에는 'info' 레벨 이상의 모든 로그를 기록합니다.
        new winston.transports.File({ filename: 'combined.log' })
    ]
});
</file>

===== 9. 관련 용어 =====

  * [[wiki:glossary:web_technologies:express|Express.js]] - Node.js 웹 애플리케이션 개발을 위한 최소한의 기능을 제공하는 빠르고 유연한 웹 프레임워크입니다.
  * [[wiki:glossary:server_operations:pm2|PM2]] - Node.js 애플리케이션을 프로덕션 환경에서 안정적으로 실행하고 관리하는 데 사용되는 프로세스 관리자입니다.
  * [[wiki:glossary:server_operations:socketio|Socket.IO]] - 웹 소켓을 기반으로 실시간 양방향 통신 기능을 쉽게 구현할 수 있도록 돕는 라이브러리입니다. 채팅 애플리케이션 등에 활용됩니다.
  * [[wiki:glossary:development_tools:git:git|Git]] - 소스 코드의 변경 이력을 효율적으로 관리하고 여러 개발자가 협업할 수 있도록 돕는 분산 버전 관리 시스템입니다.
  * [[wiki:glossary:web_technologies:javascript|JavaScript]] - 웹 페이지에서 복잡한 기능을 구현할 수 있게 해주는 프로그래밍 언어이자, Node.js의 핵심 언어입니다.

===== 10. 관련 문서 =====

  * [[wiki:it:dream_of_enc:metaverse:nodejs|Node.js 백엔드 설정]] - Node.js를 사용하여 백엔드 시스템을 설정하는 방법에 대한 상세 문서입니다.
  * [[wiki:glossary:development_tools:git:github|GitHub]] - Git 저장소를 호스팅하는 웹 서비스이자, 전 세계 개발자들이 코드를 공유하고 협업하는 플랫폼입니다.
  * [[wiki:glossary:server_operations:linux|Linux]] - 서버 운영체제로 널리 사용되는 오픈 소스 운영체제입니다. Node.js 애플리케이션 배포에 많이 활용됩니다.

---
//이 페이지는 자동으로 생성되었습니다.//