Typora中可以通過配置圖片上傳服務(wù)的自定義命令只泼,在自定義服務(wù)中上傳圖片并打印上傳結(jié)果狞玛,當(dāng)插入圖片時就會將本地圖片上傳软驰,并替換成網(wǎng)絡(luò)圖片地址。
以file-uploader-cli為例, 配置fuc
(windows)或/usr/local/bin/node /usr/local/bin/fuc
(MacOS)之后心肪,插入圖片就會調(diào)用file-uploader-cli并傳入本地圖片地址锭亏,圖片上傳完成Typora會捕獲到console打印的網(wǎng)絡(luò)地址并替換本地圖片。
Typora是怎么獲取到file-uploader-cli中console打印結(jié)果呢硬鞍?
Node.js中可以通過chid process創(chuàng)建子進(jìn)程慧瘤,在子進(jìn)程中執(zhí)行任務(wù),并捕獲子進(jìn)程stdout輸出固该。
Child Process
我們先了解一下Node.js創(chuàng)建方式子進(jìn)程有哪幾種方式锅减,child process提供了spawn、exec伐坏、execFile怔匣、fork四種方式來創(chuàng)建異步子進(jìn)程,execFile著淆、exec劫狠、spawn有對應(yīng)的同步子進(jìn)程(會阻塞 Node.js 事件循環(huán)拴疤,直到子進(jìn)程退出或終止),exec独泞、execFile呐矾、fork底層都是通過spawn/spawnSync來實現(xiàn)的。
首先了解一個概念:stdin,stdout,stderr是啥懦砂?
用于輸入蜒犯、輸出和錯誤輸出的標(biāo)準(zhǔn)流,一般是從鍵盤讀取荞膘,而將標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯誤打印到屏幕上罚随。每個進(jìn)程都會有相應(yīng)的文件描述符綁定到stdin,stdout,stderr用來獲取輸入輸出。
stdout和stderr輸出管道的容量是有限的(且特定于平臺)羽资,如果子進(jìn)程在沒有捕獲輸出的情況下寫入標(biāo)準(zhǔn)輸出超過該限制淘菩,則子進(jìn)程會阻塞等待管道緩沖區(qū)接受更多數(shù)據(jù)。
exec和execFile可以通過maxBuffer指定stdout和stderr上允許的最大數(shù)據(jù)量(以字節(jié)為單位屠升,默認(rèn)值: 1024 * 1024
)潮改,超出容量則子進(jìn)程將終止并截斷任何輸出。
不同方式的實現(xiàn)
創(chuàng)建一個打印輸出的文件腹暖,我們來獲取執(zhí)行print.js的輸出汇在。
#!/usr/bin/env node
// print.js
console.log('http://baidu.com')
spawn
先看一個官方的小示例
// spawn、fork脏答、exec和execFile方法都返回 ChildProcess 實例, 實現(xiàn)了EventEmitter API,允許父進(jìn)程·調(diào)用的監(jiān)聽器函數(shù)
const { spawn } = require('child_process');
const ls = spawn('ls', ['-lh', '.']);
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}`);
});
spawn實現(xiàn)讀取stdout輸出數(shù)據(jù)
創(chuàng)建一個test.js文件來獲取輸出糕殉,stdout輸出流的緩沖機(jī)制,數(shù)據(jù)量大時捕獲會多次接收到數(shù)據(jù)殖告。
#!/usr/bin/env node
const { spawn } = require('child_process');
const [command, ...rest] = process.argv.slice(2)
const sp = spawn(command, rest);
let output = [],errorOutput = [];
sp.stdout.on('data', (data) => {
output.push(data)
});
sp.stderr.on('data', (data) => {
errorOutput.push(data)
});
sp.on('close', (code) => {
// 默認(rèn)獲取到的是Buffer阿蝶,轉(zhuǎn)成字符
const outputStr = code === 0 ? Buffer.concat(output).toString() : Buffer.concat(errorOutput).toString()
// 處理結(jié)尾增加的空行
const printText = outputStr.toString().split(/\r?\n/)[0]
// print.js輸出的內(nèi)容
console.log('獲取到的輸出:',printText)
});
為文件添加執(zhí)行權(quán)限, 并執(zhí)行:
chmod +x test.js
./test.js node ./print.js
# or
node test.js node ./print.js
我們就可以看到test.js捕獲到子進(jìn)程的輸出了。
如果為print.js創(chuàng)建了軟連接黄绩,也可直接使用
./test.js print
exec
exec 會創(chuàng)建一個新的shell赡磅,在shell中執(zhí)行,執(zhí)行完成后會將stdout和stderr傳入回調(diào)宝与,所以stdout會一次獲取到子進(jìn)程所有輸出數(shù)據(jù)。
exec實現(xiàn)讀取stdout輸出數(shù)據(jù)
#!/usr/bin/env node
const { exec } = require('child_process');
exec(`${process.argv.slice(2).join(' ')}`, (error, stdout, stderr) => {
if (error) {
console.error(error);
return;
}
// 默認(rèn)獲取到的是Buffer冶匹,轉(zhuǎn)成字符 處理結(jié)尾增加的空行习劫,
const printText = stdout.toString().split(/\r?\n/)[0]
console.log(printText);
});
execSync:
execSync和exec不同之處在于:execSync子進(jìn)程完全關(guān)閉之前不會返回。
#!/usr/bin/env node
const { execSync } = require('child_process');
const result = execSync(`${process.argv.slice(2).join(' ')}`);
const printText = result.toString().split(/\r?\n/)[0]
console.log(printText)
execFile
和exec類似嚼隘,不過不會創(chuàng)建新的shell诽里,指定的可執(zhí)行文件作為新進(jìn)程,exec也是通過調(diào)用execFile來實現(xiàn)的飞蛹。
fork
創(chuàng)建新的 Node.js 進(jìn)程并使用建立的 IPC 通信通道(其允許在父子進(jìn)程之間發(fā)送消息)
其他
pipe管道打印輸出
在創(chuàng)建的子進(jìn)程中執(zhí)行任務(wù)谤狡,比如創(chuàng)建子進(jìn)程通過npm
為項目安裝依賴灸眼,這個時候子進(jìn)程執(zhí)行信息需要輸出到父進(jìn)程中打印,用戶才能看到執(zhí)行進(jìn)度和結(jié)果墓懂。
// 父進(jìn)程監(jiān)聽子進(jìn)程輸出并打印
sp.stdout.on('data', (data) => {
console.log(data)
});
sp.stderr.on('data', (data) => {
console.log(data)
});
stdout和stderr屬于標(biāo)準(zhǔn)輸出流焰宣,可以使用Steam API,通過pipe管道傳遞到父進(jìn)程中捕仔。
sp.stdout.pipe(process.stdout);
sp.stderr.pipe(process.stderr);
也可以通過指定 option.stdio 配置父進(jìn)程和子進(jìn)程之間建立的管道匕积。
const { spawn } = require('child_process');
// 子進(jìn)程將使用父進(jìn)程的標(biāo)準(zhǔn)輸入輸出。
spawn('prg', [], { stdio: 'inherit' });
// 衍生僅共享標(biāo)準(zhǔn)錯誤的子進(jìn)程榜跌。
spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });
// 打開額外的文件描述符=4闪唆,以與呈現(xiàn) startd 風(fēng)格界面的程序進(jìn)行交互。
spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });
Windows和類Unix(Mac钓葫,Linux悄蕾,Unix)區(qū)別
child_process.execFile()
在類Unix系統(tǒng)上執(zhí)行效率可能快,因為不用創(chuàng)建新的shell础浮。但是在Windows上.bat
和.cmd
文件在沒有終端的情況下不能單獨(dú)執(zhí)行帆调,所以不能使用execFile“云欤可以通過spawn傳入shell
配置調(diào)用贷帮,或調(diào)用cmd.exe并傳入.bat
或.cmd
文件。
使用cross-spawn或execa來幫我們執(zhí)行命令诱告,解決跨平臺問題撵枢,更優(yōu)雅調(diào)用child_process方法