nodejs腳本中如何執(zhí)行shell命令

更新時間：2025年02月06日 10:02:15 作者：Amber.Li

Node.js中使用child_process模塊的exec和spawn方法來執(zhí)行shell命令,exec適合執(zhí)行小命令,返回輸出；spawn適合大命令或長時間運行的命令,實時輸出

一：exec 方法執(zhí)行shell命令

1. 注意：

exec 方法是將整個命令輸出緩存到內(nèi)存中，當(dāng)執(zhí)行完成后一次性返回，所以適合執(zhí)行較小的命令
exec 方法的回調(diào)函數(shù)只有在命令執(zhí)行完成后才會被調(diào)用[持續(xù)性命令會導(dǎo)致回調(diào)函數(shù)不執(zhí)行]

第2點_舉例：

npm run dev

該命令會一直運行，而 exec 方法的回調(diào)函數(shù)只有在命令運行完成后才會被調(diào)用，導(dǎo)致你的回調(diào)函數(shù)一直沒有返回

2. 優(yōu)點特性：

優(yōu)點是簡單易用,方便地執(zhí)行簡單的命令，并且可以直接獲取命令輸出;
阻塞式調(diào)用的，當(dāng)命令輸出很大時，可能會導(dǎo)致阻塞程序的執(zhí)行，甚至?xí)?dǎo)致程序崩潰

3. 語法格式

exec( '命令',option對象, 回調(diào)函數(shù)callback);

4. option對象屬性

cwd <string> 子進程的當(dāng)前工作目錄。
env <Object> 環(huán)境變量鍵值對。
encoding <string> 默認為 ‘utf8’。
shell <string> 執(zhí)行命令的 shell。在 UNIX 上默認為 ‘/bin/sh’，在 Windows 上默認為 process.env.ComSpec。詳見Shell的要求與Windows默認的Shell。
timeout <number> 默認為 0。
maxBuffer <number> stdout 或 stderr 允許的最大字節(jié)數(shù)。默認為 200*1024。如果超過限制，則子進程會被終止。詳見 maxBuffer與Unicode。
killSignal <string> | <integer> 默認為 ‘SIGTERM’。
uid<number>設(shè)置進程的用戶標(biāo)識，詳見 setuid(2)。
gid<number>設(shè)置進程的組標(biāo)識，詳見 setgid(2)。
windowsHide <boolean> 隱藏子進程的控制臺窗口，常用于 Windows 系統(tǒng)。默認為 false。

5. _示例：

Nodejs–標(biāo)識Node.js進程運行其上的操作系統(tǒng)平臺: process.platform

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

 // 就是進行簡單`判斷`在執(zhí)行環(huán)境下應(yīng)該使用`哪個命令行`執(zhí)行命令;
 // process.platform : 標(biāo)識Node.js進程運行其上的操作系統(tǒng)平臺
 // 返回值：‘a(chǎn)ix',‘darwin',‘freebsd',‘linux',‘openbsd',‘sunos',‘win32'
 
exec('ls -la',{shell:process.platform === 'win32'}, (error, stdout, stderr) => {
  if (error) {
    console.error(`執(zhí)行出錯: ${error}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.error(`stderr: ${stderr}`);
});

回調(diào)函數(shù)有三個參數(shù)：

error、stdout和stderr：

error表示執(zhí)行命令時出現(xiàn)的錯誤;
stdout表示命令的標(biāo)準輸出;
stderr表示命令的標(biāo)準錯誤輸出;

二：spawn 方法執(zhí)行shell命令

1. 注意：

spawn方法執(zhí)行的命令參數(shù)應(yīng)該是一個Array。
這樣可以避免shell注入攻擊.

// 命令參數(shù)應(yīng)該是一個`數(shù)組`  ['-la']
const ls = spawn('ls', ['-la'],{shell:process.platform === 'win32'},);

2. 優(yōu)點特性：

spawn 方法則是實時返回子進程的標(biāo)準輸出和標(biāo)準錯誤流，適合執(zhí)行大量數(shù)據(jù)或者長時間運行的命令[ 例如 npm run dev ]；

異步執(zhí)行的，可以在命令輸出時即時處理數(shù)據(jù)，不會阻塞程序的執(zhí)行;

可以靈活地配置子進程的輸入輸出、環(huán)境變量等選項

3. _語法格式：

const ls = spawn(命令String, 命令參數(shù)Array,option對象);

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

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

ls.on('close', (code) => {
  console.log(`子進程退出碼：$[code]`);
});

4. option對象屬性

cwd <string> 子進程的當(dāng)前工作目錄。
env<Object>環(huán)境變量鍵值對。
argv0 <string> 顯式地設(shè)置要發(fā)給子進程的 argv[0] 的值。如果未指定，則設(shè)為 command。
stdio<Array> | <string>子進程的 stdio 配置。（詳見 options.stdio）
detached <boolean> 準備將子進程獨立于父進程運行。具體行為取決于平臺。（詳見 [options.detached]）
uid <number> 設(shè)置該進程的用戶標(biāo)識。（詳見 setuid(2)）
gid <number> 設(shè)置該進程的組標(biāo)識。（詳見 setgid(2)）
shell <boolean> | <string> 如果為 true，則在一個 shell 中運行 command。在 UNIX 上使用 '/bin/sh'，在 - Windows 上使用 process.env.ComSpec。一個不同的 shell 可以被指定為字符串。 See [Shell Requirements][] and [Default Windows Shell][]. 默認為 false（沒有 shell）。
windowsVerbatimArguments <boolean> 決定在Windows系統(tǒng)下是否使用轉(zhuǎn)義參數(shù)。在Linux平臺下會自動忽略，當(dāng)指令 shell 存在的時該屬性將自動被設(shè)置為true。默認值: false。
windowsHide 是否隱藏在Windows系統(tǒng)下默認會彈出的子進程控制臺窗口。默認為: false。

【4.1 】 .stdio 屬性詳解：配制在父進程和子進程之間建立的管道

配制在父進程和子進程之間建立的管道
影響到 shell 命令，或者 node 命令在控制臺上的輸出

【屬性值格式 <Array> | <string> 】

['pipe', 'pipe', 'pipe'] (默認值)

數(shù)組元素按位置分別對應(yīng)：

- stdin [命令的標(biāo)準輸入]
- stdout [命令的標(biāo)準輸出]
- stderr [執(zhí)行命令時出現(xiàn)的錯誤]

'pipe', 'ignore', 'inherit

值	作用
pipe	父進程中通過 child_process.spawn.stdout.on(“data”, () => {}) 等獲取
ignore	父進程通過管道得到的是 null
inherit	子進程將使用父進程的標(biāo)準輸入輸出

	ls.stdout.on('data', (data) => {
	  console.log(`stdout: ${data}`);
	});
	
	ls.stderr.on('data', (data) => {
	  console.error(`stderr: ${data}`);
	});
	
	ls.on('close', (code) => {
	  console.log(`子進程退出碼：$[code]`);
	});

5. 示例：

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

// 就是進行簡單`判斷`在執(zhí)行環(huán)境下應(yīng)該使用`哪個命令行`執(zhí)行命令;
// process.platform : 標(biāo)識Node.js進程運行其上的操作系統(tǒng)平臺
// 返回值：‘a(chǎn)ix',‘darwin',‘freebsd',‘linux',‘openbsd',‘sunos',‘win32'

const ls = spawn('ls', ['-la'],{shell:process.platform === 'win32'},);

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

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

ls.on('close', (code) => {
  console.log(`子進程退出碼：$[code]`);
});

如果需要執(zhí)行一個復(fù)雜的shell命令:

可以使用sh命令，并將命令字符串作為參數(shù)傳遞給sh命令；

例如：

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

const command = 'ls -la | grep "example"';

const sh = spawn('sh', ['-c', command]);

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

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

sh.on('close', (code) => {
  console.log(`子進程退出碼：$[code]`);
});

示例中：