[Node.js] Node.js Modules | childProcess, spawn, stdout, stderr, fs, path, yargs, properties-reader, Buffer

Node.js modules

🗨️ ChildProcess

 ✅ ChildProcess

개념

• Node.js 프로세스 내에서 다른 프로세스를 실행하고 그와 상호 작용하는 기능을 제공하는 모듈
• Node.js에서 표준 라이브러리로 제공
• exec(), spawn(),fork() 등의 함수를 제공
  • exec()
    • 함수는 셸 명령어를 실행하고 해당 결과를 버퍼링
  • spawn()
    • 새로운 프로세스를 만들고 그 프로세스와의 표준 입출력 스트림을 제공
  • fork()
    • spawn() 함수와 유사하지만, 부모 프로세스와 자식 프로세스 간에 통신할 수 있는 IPC 채널을 자동으로 설정
• ChildProcess 모듈을 사용하면 Node.js 프로세스 내에서 다른 프로그램을 실행하고 그 결과를 받아올 수 있음
  • Node.js 어플리케이션에서 외부 명령어 실행, 자식 프로세스 생성, 클러스터링 등 다양한 용도로 활용 가능

사용예시

Electorn에서 ChildProcess를 사용해 외부 명령어를 실행하는 예시

const { exec } = require('child_process');

// 'ls' 명령어 실행
exec('ls', (err, stdout, stderr) => {
  if (err) {
    console.error(`exec error: ${err}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.error(`stderr: ${stderr}`);
});

 

ChildProcess모듈을 사용한 메인 프로세스와 렌더러 프로세스 간의 통신 예시

const { fork } = require('child_process');

// 랜더러 프로세스에서 실행할 모듈 경로
const pathToScript = path.join(__dirname, 'myScript.js');

// 랜더러 프로세스에서 myScript.js 모듈 실행
const child = fork(pathToScript);

// 랜더러 프로세스로 메시지 보내기
child.send('hello from main process!');

// 랜더러 프로세스에서 메시지 받기
child.on('message', (msg) => {
  console.log(`received message from renderer process: ${msg}`);
});

 

child_process 모듈의 spawn() 함수를 사용하여 Windows 운영체제에서 cmd.exe를 실행하고 해당 프로세스와 상호작용하는 예시

const { spawn } = require('child_process');
/*
* 새로운 cmd.exe 쉘을 열고 'dir' 명령어를 실행한 결과를 출력
*/

// Windows 운영체제에서는 'cmd.exe'를 사용하여 명령어 실행
const cmd = spawn('cmd.exe'); 

cmd.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

cmd.stderr.on('data', (data) => {
  console.error(`stderr: ${data}`);
});

cmd.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});

// 명령어 입력을 위해 stdin으로 데이터를 전송
cmd.stdin.write('dir\\n'); // 명령어 전송
cmd.stdin.end(); // 입력 종료

 

🗨️ child_process.spawn(command[, args][, options])

 ✅ child_process.spawn(command[, args][, options])

개념

• command
  • 실행할 명령
• args
  • 문자열 인수 목록
• options
  • cwd 자식 프로세스의 현재 작업 디렉토리
  • shell true일 때 쉘 내부에서 실행. 

 

🗨️ ChildProcessWithoutNullStreams

✅ ChildProcessWithoutNullStreams

개념

• Node.js의 child_process 모듈에서 제공하는 클래스 중 하나
• ChildProcess 클래스와 달리, 표준 입력 스트림과 표준 출력 스트림이 null이 아니라면 ChildProcessWithoutNullStreams 객체를 반환
  • 기본적으로 ChildProcess 클래스에서는 표준 입력 스트림과 표준 출력 스트림이 모두 null로 설정
  • ChildProcessWithoutNullStreams의 경우 이러한 제한을 없애고, 표준 입력 스트림과 표준 출력 스트림을 통해 프로세스와 상호작용할 수 있음
• ChildProcess 클래스의 기능을 확장하여 프로세스와 더욱 효율적으로 상호작용할 수 있도록 해주는 클래스

사용예시

const { spawn } = require('child_process');

//stdio: 'inherit' 옵션을 추가하여, 부모 프로세스의 표준 입력 스트림, 
//표준 출력 스트림 및 표준 오류 스트림을 자식 프로세스로 전달
//ChildProcessWithoutNullStreams 객체를 반환

const ls = spawn('ls', ['-lh', '/usr'], { stdio: 'inherit' });

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});

 

 

 

🗨️ stdout, stderr

 ✅ stdout, stderr

개념

stdout

• "standard output"의 약자
• 프로그램이 실행될 때 출력하는 결과물이나 메시지
• 콘솔(Console)이나 터미널(Terminal)에 출력
• 프로그래밍에서는 stdout을 표준 출력 스트림(Standard output stream)이라고도 부름

stderr

• "standard error"의 약자
• 프로그램 실행 중 에러 메시지를 출력
• 콘솔이나 터미널에서 빨간색으로 출력
• 프로그래밍에서는 stderr을 표준 오류 스트림(Standard error stream)이라고도 부름

사용 예시

자식 프로세스의 stdout과 stderr을 각각 data 이벤트와 error 이벤트로 캡처

/*
* Node.js의 child_process 모듈에서는 spawn() 함수를 사용하여
*자식 프로세스를 실행할 때, 
* 이러한 stdout과 stderr을 이벤트 리스너를 통해 캡처
*/

const { spawn } = require('child_process');

const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.error(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});

 

 

 

🗨️ fs

 ✅ fs

개념

• Node.js에서 파일 시스템 작업을 수행하기 위해 사용되는 모듈
• 파일 생성, 읽기, 쓰기, 수정, 삭제 등의 파일 시스템 작업을 수행하는 함수들을 제공
• Node.js의 기본 모듈로 제공되며, 별도의 설치 없이 사용할 수 있음
• fs 모듈에서 제공하는 함수들은 대부분 비동기적으로 동작, 동기적으로 동작하는 함수도 제공
• 콜백 함수를 통해 결과를 반환

주요 함수

* `fs.readFile()`: 파일을 비동기적으로 읽어들입니다.
* `fs.readFileSync()`: 파일을 동기적으로 읽어들입니다.
* `fs.writeFile()`: 파일을 비동기적으로 씁니다.
* `fs.writeFileSync()`: 파일을 동기적으로 씁니다.
* `fs.appendFile()`: 파일의 끝에 내용을 추가합니다.
* `fs.unlink()`: 파일을 삭제합니다.

사용 예시

const fs = require('fs');
const path = require('path');
const { dialog } = require('electron').remote;

// 파일 다이얼로그를 열어서 파일 경로를 입력받습니다.
dialog.showOpenDialog({
  properties: ['openFile']
}).then(result => {
  if (!result.canceled) {
    // 선택한 파일 경로를 가져옵니다.
    const filePath = result.filePaths[0];

    // 파일을 읽어들입니다.
    fs.readFile(filePath, 'utf-8', (err, data) => {
      if (err) {
        console.error(err);
        return;
      }
      
      // 파일 내용에서 단어 수를 계산합니다.
      const wordCount = data.split(/\\s+/).length;

      // 화면에 결과를 출력합니다.
      document.getElementById('result').textContent = `단어 수: ${wordCount}`;
    });
  }
}).catch(err => {
  console.error(err);
});

 

 

 

🗨️ path

 ✅ path

개념

• 파일 경로와 관련된 유틸리티 함수를 제공
• 파일 경로를 안전하게 조작하고, 파일 경로의 구성 요소를 추출하거나 변경 가능

사용 예시

path 모듈을 사용하여 /path/to/some/file.txt 파일 경로를 처리

const path = require('path');

const fullPath = '/path/to/some/file.txt';

// 파일 경로에서 파일 이름을 추출합니다.
const filename = path.basename(fullPath);
console.log('Filename:', filename);

// 파일 경로에서 디렉토리 경로를 추출합니다.
const directory = path.dirname(fullPath);
console.log('Directory:', directory);

// 파일 경로에서 확장자를 추출합니다.
const extname = path.extname(fullPath);
console.log('Extension:', extname);

// 파일 경로를 조합합니다.
const combinedPath = path.join(directory, 'newfile.md');
console.log('Combined Path:', combinedPath);

// 파일 경로를 절대 경로로 변환합니다.
const absolutePath = path.resolve(combinedPath);
console.log('Absolute Path:', absolutePath);

/*
결과값
Filename: file.txt
Directory: /path/to/some
Extension: .txt
Combined Path: \\path\\to\\some\\newfile.md
Absolute Path: C:\\path\\to\\some\\newfile.md
*/

 

 

 

🗨️ yargs

✅ yargs

설치

npm i yargs

개념

• 명령행 인자(command line arguments)를 파싱(parsing)하기 위한 유틸리티
• 명령행 인자를 파싱하여 객체 형태로 반환하므로, 인자를 처리하기 쉽게 해줌
• 명령행 인자를 사용자 친화적인 형태로 정의할 수 있는 기능도 제공

사용 예시

const yargs = require('yargs');

// 사용자 친화적인 형태로 명령행 인자를 정의합니다.
const argv = yargs
  .usage('Usage: $0 [options] <path>')
  .option('r', {
    alias: 'recursive',
    describe: 'Recursively process all files in the directory',
    type: 'boolean',
    default: false
  })
  .option('e', {
    alias: 'extension',
    describe: 'Specify the file extension to process',
    type: 'string',
    default: '.txt'
  })
  .help('h')
  .alias('h', 'help')
  .argv;

// 명령행 인자를 출력합니다.
console.log('Options:', argv);

// path 인자를 추출합니다.
const path = argv._[0];
console.log('Path:', path);

 

 

🗨️ yargs 의 argv

 ✅ argv

개념

• argv는 사용자가 명령행 인자(command line argument)를 전달할 때, 이를 파싱(parsing)한 결과를 담고 있는 객체
• argv 객체는 다양한 프로퍼티를 갖고 있으며, 사용자가 전달한 명령행 인자와 이에 대한 정보를 담고 있음

사용 예시

{
  name: 'Iseo',
  age: 29,
  _: [],
  '$0': 'memo.js'
}

const yargs = require('yargs');

const argv = yargs
  .option('name', {
    alias: 'n',
    describe: 'User name',
    type: 'string'
  })
  .option('age', {
    alias: 'a',
    describe: 'User age',
    type: 'number'
  })
  .argv;

console.log(argv);

{
  name: 'Iseo',
  n: 'Iseo',
  age: 29,
  a: 29,
  _: [],
  '$0': 'memo.js'
}

 

 

 

🗨️ properties-reader

✅ properties-reader

개념

• Node.js에서 프로퍼티 파일(.properties)을 읽어와서 JavaScript 객체로 변환해주는 도구
• 별도의 JSON 파일을 사용하지 않고도, 프로퍼티 파일을 사용하여 간단한 설정 정보를 관리
• Electron 애플리케이션에서 설정 정보를 관리하는 데에 유용하게 사용

사용 예시

# config.properties

host=localhost
port=8080
database=mydb

const PropertiesReader = require('properties-reader');

// config.properties 파일을 읽어와 PropertiesReader객체를 생성
//.path() 메서드를 사용해 객체로 변환하고 각 프로퍼티에 접근 가능
const properties = PropertiesReader('config.properties').path();

console.log(properties.host); // localhost
console.log(properties.port); // 8080
console.log(properties.database); // mydb

 

 

 

🗨️ fs.existsSync()

 ✅ fs.existSync()

개념

• 주어진 경로의 파일이나 디렉토리가 존재하는지 확인
• 동기적으로 작동하며, 주어진 경로가 존재하면 **true**를 반환하고, 존재하지 않으면 **false**를 반환

사용 예시

const fs = require('fs');

if (fs.existsSync('/path/to/file')) {
  console.log('File exists');
} else {
  console.log('File does not exist');
}

 

 

🗨️Buffer

 ✅ Buffer

개념

• Node.js의 **Buffer**클래스는 바이너리 데이터를 다루는 데 사용되는 일종의 배열
• 메모리 상에서 일정한 크기의 공간을 확보하여 데이터를 저장하며, 이를 통해 바이너리 데이터를 조작하고 다른 시스템과 상호작용
• **Buffer**는 바이너리 데이터를 다루는 데 유용한 메소드와 속성을 제공
• **Buffer**클래스는 Node.js의 I/O 작업에서 많이 사용

사용 예시

• 문자열을 바이너리 데이터로 변환

const str = 'Hello, world!';
const buf = Buffer.from(str, 'utf8');

console.log(buf); // <Buffer 48 65 6c 6c 6f 2c 20 77 6f 72 6c 64 21>

• 고정 크기의 **Buffer**인스턴스를 생성하는 예시

const buf1 = Buffer.alloc(10);
const buf2 = Buffer.allocUnsafe(10);

console.log(buf1); // <Buffer 00 00 00 00 00 00 00 00 00 00>
console.log(buf2); // <Buffer 58 0f 70 08 30 00 00 00 00 00>

• 파일을 읽고 쓰는 예시

const fs = require('fs');

// 파일을 읽어들입니다.
fs.readFile('input.txt', (err, data) => {
  if (err) throw err;

  // 읽어들인 데이터를 `Buffer` 인스턴스로 변환합니다.
  const buf = Buffer.from(data);

  // `Buffer` 인스턴스를 콘솔에 출력합니다.
  console.log(buf);
  
  // 파일에 데이터를 쓰기 위한 `Buffer` 인스턴스를 생성합니다.
  const writeBuf = Buffer.from('Write this data to file', 'utf8');
  
  // 파일에 데이터를 씁니다.
  fs.writeFile('output.txt', writeBuf, (err) => {
    if (err) throw err;
    
    console.log('Data written to file');
  });
});