我从Typoro中学到的Child Process知识点(三).md

这是我参与11月更文挑战的第5天，活动详情查看：2021最后一次更文挑战

Typora中可以通过配置图片上传服务的自定义命令，在自定义服务中上传图片并打印上传结果，当插入图片时就会将本地图片上传，并替换成网络图片地址。

以file-uploader-cli为例, 配置fuc(windows)或/usr/local/bin/node /usr/local/bin/fuc(MacOS)之后，插入图片就会调用file-uploader-cli并传入本地图片地址，图片上传完成Typora会捕获到console打印的网络地址并替换本地图片。

Typora是怎么获取到file-uploader-cli中console打印结果呢？

Node.js中可以通过chid process创建子进程，在子进程中执行任务，并捕获子进程stdout输出。

Child Process

我们先了解一下Node.js创建方式子进程有哪几种方式，child process提供了spawn、exec、execFile、fork四种方式来创建异步子进程，execFile、exec、spawn有对应的同步子进程(会阻塞 Node.js 事件循环，直到子进程退出或终止)，exec、execFile、fork底层都是通过spawn/spawnSync来实现的。

首先了解一个概念：stdin,stdout,stderr是啥？

用于输入、输出和错误输出的标准流，一般是从键盘读取，而将标准输出和标准错误打印到屏幕上。每个进程都会有相应的文件描述符绑定到stdin,stdout,stderr用来获取输入输出。

stdout和stderr输出管道的容量是有限的（且特定于平台），如果子进程在没有捕获输出的情况下写入标准输出超过该限制，则子进程会阻塞等待管道缓冲区接受更多数据。

exec和execFile可以通过maxBuffer指定stdout和stderr上允许的最大数据量（以字节为单位，默认值: 1024 * 1024），超出容量则子进程将终止并截断任何输出。

不同方式的实现

创建一个打印输出的文件，我们来获取执行print.js的输出。

#!/usr/bin/env node
// print.js
console.log('http://baidu.com')

spawn

先看一个官方的小示例

// spawn、fork、exec和execFile方法都返回 ChildProcess 实例, 实现了EventEmitter API,允许父进程·调用的监听器函数
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实现读取stdout输出数据

创建一个test.js文件来获取输出，stdout输出流的缓冲机制，数据量大时捕获会多次接收到数据。

#!/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) => {
  // 默认获取到的是Buffer，转成字符
  const outputStr = code === 0 ? Buffer.concat(output).toString() : Buffer.concat(errorOutput).toString()
  // 处理结尾增加的空行
  const printText = outputStr.toString().split(/\r?\n/)[0]
  // print.js输出的内容
  console.log('获取到的输出：',printText)
});

为文件添加执行权限, 并执行：

chmod +x test.js
./test.js node ./print.js
# or
node test.js node ./print.js

我们就可以看到test.js捕获到子进程的输出了。

如果为print.js创建了软连接，也可直接使用./test.js print

exec

exec 会创建一个新的shell，在shell中执行，执行完成后会将stdout和stderr传入回调，所以stdout会一次获取到子进程所有输出数据。

exec实现读取stdout输出数据

#!/usr/bin/env node
const { exec } = require('child_process');

exec(`${process.argv.slice(2).join(' ')}`, (error, stdout, stderr) => {
    if (error) {
      console.error(error);
      return;
    }
    // 默认获取到的是Buffer，转成字符  处理结尾增加的空行，
    const printText = stdout.toString().split(/\r?\n/)[0]
    console.log(printText);
});

execSync:

execSync和exec不同之处在于：execSync子进程完全关闭之前不会返回。

#!/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类似，不过不会创建新的shell，指定的可执行文件作为新进程，exec也是通过调用execFile来实现的。

fork

创建新的 Node.js 进程并使用建立的 IPC 通信通道（其允许在父子进程之间发送消息）

其他

pipe管道打印输出

在创建的子进程中执行任务，比如创建子进程通过npm为项目安装依赖，这个时候子进程执行信息需要输出到父进程中打印，用户才能看到执行进度和结果。

// 父进程监听子进程输出并打印
sp.stdout.on('data', (data) => {
    console.log(data)
});

sp.stderr.on('data', (data) => {
    console.log(data)
});

stdout和stderr属于标准输出流，可以使用Steam API，通过pipe管道传递到父进程中。

sp.stdout.pipe(process.stdout);
sp.stderr.pipe(process.stderr);

也可以通过指定 option.stdio 配置父进程和子进程之间建立的管道。

const { spawn } = require('child_process');
// 子进程将使用父进程的标准输入输出。
spawn('prg', [], { stdio: 'inherit' });
// 衍生仅共享标准错误的子进程。
spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });
// 打开额外的文件描述符=4，以与呈现 startd 风格界面的程序进行交互。
spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });

Windows和类Unix(Mac，Linux，Unix)区别

child_process.execFile() 在类Unix系统上执行效率可能快，因为不用创建新的shell。但是在Windows上.bat和.cmd文件在没有终端的情况下不能单独执行，所以不能使用execFile。可以通过spawn传入shell配置调用，或调用cmd.exe并传入.bat或.cmd文件。

使用cross-spawn或execa来帮我们执行命令，解决跨平台问题，更优雅调用child_process方法