标签： exec

捕获 promisify `child_process.exec` 的错误
这个东西文档里没写清楚，所以写篇博客记一下。

在 Node.js 里，我们可以使用 child_process 下的命令分裂出一个进程，执行其他的命令。这些命令包括 exec，execFile 和 spawn。

我比较常使用 exec 和 spawn。前者用起来比较方便，只要传入完整的命令和参数，很接近日常命令行体验；后者传参要麻烦一些，不过可以实时获取输出，包括 stdout 和 stderr，比较方便给用户及时反馈。

下面贴一下文档里的例子，spawn 的使用将来有机会再说。
```
const { exec } = require('child_process');
exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => {
  if (error) {
    console.error(`exec error: ${error}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.error(`stderr: ${stderr}`);
});
```
Node.js 8 之后，我们可以用 util.promisify() 命令将 exec 转换为 Promise 风格的方法，即不再需要 callback 函数，而是返回 Promise 实例，方便我们链式调用或者使用 Async function。

此时，它的样子是这样的：
```
const util = require('util');
const exec = util.promisify(require('child_process').exec);

async function lsExample() {
  const { stdout, stderr } = await exec('ls');
  console.log('stdout:', stdout);
  console.error('stderr:', stderr);
}
lsExample();
```
官方文档没解释清楚错误处理，经过我的尝试，是这样的：
1. 命令发生错误，或者被意外中断都会引发错误
2. 如果不出错，就会正确返回 stdout 和 stderr
3. 否则，错误实例里会包含 stdout，stderr 和 code
4. 1～127 是各种错误编码，128+ 则是 signal + 127 的结果，通常来说是受控于我们的操作。比如使用 FFmpeg 录屏的时候，结束录制就要 Ctrl+C，此时就会得到值为 128 的 code。所以此时很可能不是真的失败。
```
const util = require('util');
const exec = util.promisify(require('child_process').exec);

(async () => {
  let code, stdout, stderr;
  try {
    ({stdout, stderr} = await exec('ls'));
  } catch (e) {
    ({code, stdout, stderr} = e);
  }

  if (code && code > 127) {
    // 确实失败了
  }
  console.log('stdout:', stdout);
  console.log('stderr:', stderr);
})();
```
2021年9月12日
Promise 改造 child_process.exec
child_process 是 Node.js 的一个内建模块，用于分裂出（spawn）一个子进程，执行一些特定操作。.exec() 是它的方法，接受一个参数，即要执行的 shell 命令，然后通过回调返回结果。.exec() 与 .spawn() 的不同之处在于，前者重在返回结果，后者则重在返回内容。所以当你需要执行一个命令，你并不关心执行过程中发生了什么，只要看到结果就好，那么就用 .exec()；反之，假如执行过程中产生的信息对你特别有价值，你并不是特别在意结果，就应该用 .spawn()。

另外，我之前在《Node.js 8 中的 util.promisify》中介绍过，Node.js 8 引入了一个新函数，位于 util 模块，叫做 promisify()，用于将回调风格的 Node.js 函数改造成 Promise 规范的函数。

OK，背景知识介绍结束。近期开发中，我需要执行一个命令，并且取得它的 stdout，stderr 和 exit code，使用 promisify() 之后发现没有 exit code，于是只好重新写了一下，代码如下：
```
import {exec as BaseExec} from 'util';

function exec(command, options) {
  return new Promise((resolve, reject) => {
    let result = {};
    const cp = baseExec(command, options, (err, stdout, stderr) => {
      if (err) {
        err.stdout = stdout;
        err.stderr = stderr;
        reject(err);
        return;
      }

      result.stdout = stdout;
      result.stderr = stderr;
      if ('code' in result) {
        resolve(result);
      }
    });

    cp.on('exit', (code, signal) => {
      result.code = code;
      result.signal = signal;
      if ('stdout' in result) {
        resolve(result);
      }
    });
  });
}
```
希望对大家有用。

新键盘到了，FC660C，静电容，试用一下，效果还不错。略硬，段落感不强，声音不大。
2018年7月7日

标签： exec

捕获 promisify `child_process.exec` 的错误

Promise 改造 child_process.exec