node - 执行shell脚本

执行shell脚本

在Node.js中，exec、execFile、spawn和fork都是用于执行外部命令或脚本的方法，但它们之间有一些关键的区别和用途。以下是每个方法的简要概述和用途：

1. exec(command[, options], callback)
   • 概述：exec方法用于执行一个shell命令，并缓存命令的输出，直到命令执行完成。当命令完成时，通过回调函数返回完整的输出。
   • 用途：适用于需要执行简单的shell命令，并且不关心命令执行过程中的实时输出，只关心最终结果的场景。例如，执行一些构建任务、获取系统信息等。
   • 注意事项：由于exec会缓存输出，如果命令产生大量输出，可能会导致内存溢出。
2. execFile(file[, args][, options][, callback])
   • 概述：execFile方法用于直接执行一个可执行文件，而不是通过shell。与exec不同，execFile不会启动一个新的shell来执行命令，因此它更安全、更高效。
   • 用途：适用于需要直接执行可执行文件，并且不需要shell功能的场景。例如，调用一些编译好的程序或工具。
   • 优点：由于没有shell的开销，execFile通常比exec更快，并且更安全（不容易受到shell注入攻击）。
3. spawn(command[, args][, options])
   • 概述：spawn方法用于异步地启动一个子进程，并返回一个表示该子进程的ChildProcess对象。与exec和execFile不同，spawn不会缓存输出，而是提供一个流接口，允许你实时地处理子进程的输出。
   • 用途：适用于需要长时间运行的命令，或者需要实时处理命令输出的场景。例如，处理大量数据的流式处理任务、实时日志分析等。
   • 优点：由于输出是流式的，spawn可以处理大量数据而不会导致内存溢出。此外，它还提供了更细粒度的控制，如设置子进程的stdio、环境变量等。
4. fork(modulePath[, args][, options])
   • 概述：fork方法是spawn的一个特例，专门用于创建新的Node.js进程。它使用与spawn相同的参数和返回值，但自动设置子进程的IPC（进程间通信）通道，并允许你通过发送和接收消息与子进程进行通信。
   • 用途：适用于需要创建多个Node.js子进程，并在它们之间进行通信的场景。例如，实现基于消息的并发处理、分布式计算等。
   • 优点：fork提供了强大的进程间通信能力，使得在Node.js应用程序中实现并行处理和分布式计算变得相对简单。

总的来说，这些方法的选择取决于你的具体需求和场景。对于简单的shell命令执行，可以选择exec或execFile；对于需要实时处理输出的长时间运行命令，应该选择spawn；如果需要创建多个Node.js子进程并进行通信，则应该使用fork。

exec(command[, options], callback)

options（可选参数）

• 一个对象，用于配置子进程的行为。常见的选项包括：
  • cwd：指定子进程的当前工作目录（默认是当前 Node.js 进程的工作目录）。
  • env：指定环境变量对象，默认是 process.env。
  • encoding：指定输出的字符编码（默认为 'utf8'）。
  • timeout：设置子进程的超时时间（单位为毫秒，默认为 0 表示不超时）。
  • maxBuffer：stdout 和 stderr 的最大缓存大小（以字节为单位，默认是 1024 * 1024）。
  • shell：指定使用的 shell 程序（默认是 /bin/sh，在 Windows 上是 cmd.exe）。

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

exec(
  'node -v', //一个字符串，表示需要执行的命令
  {
    shell: '/bin/bash', //指定使用的 shell 程序
    cwd: '/usr/local/bin', //指定子进程的当前工作目录（默认是当前 Node.js 进程的工作目录）
    maxBuffer: 1024 * 1024 * 10, //stdout 和 stderr 的最大缓存大小（以字节为单位，默认是 1024 * 1024）
    env: { NODE_ENV: 'production' }, //指定环境变量对象，默认是 process.env。
  },
  (error, stdout, stderr) => {
    if (error) {
      console.error(`执行错误: ${error}`)
      return
    }

    console.log(`Node.js 版本: ${stdout}`)
  },
)

1. 异步执行：
   • exec 是异步的，子进程的执行不会阻塞主线程。命令执行完成后，结果会通过回调函数返回。
2. stdout 和 stderr 输出：
   • exec 会缓冲子进程的输出，直到整个进程结束为止，然后一次性返回。
   • 如果输出的数据量超过了 maxBuffer 限制，则会抛出错误。