ChildProcess 项目技术文档

1. 安装指南

环境要求

• Ruby 2.4 及以上版本
• JRuby 9 及以上版本

安装步骤

1. 使用 gem 命令安装 childprocess 库：

   gem install childprocess
   

2. 在 Ruby 项目中引入 childprocess：

   require 'childprocess'
   

2. 项目的使用说明

基本用法

ChildProcess 提供了一个简单可靠的解决方案，用于在后台控制外部程序的运行。以下是一些基本的使用示例：

process = ChildProcess.build("ruby", "-e", "sleep")

# 继承父进程的 stdout/stderr
process.io.inherit!

# 设置子进程的工作目录
process.cwd = '/some/path'

# 启动进程
process.start

# 检查进程状态
process.alive?    #=> true
process.exited?   #=> false

# 等待进程退出
process.wait
process.exited?   #=> true

# 获取退出码
process.exit_code #=> 0

高级用法

输出到管道

r, w = IO.pipe

process = ChildProcess.build("sh", "-c", "for i in {1..3}; do echo $i; sleep 1; done")
process.io.stdout = w
process.start

w.close

thread = Thread.new do
  begin
    loop do
      print r.readpartial(16384)
    end
  rescue EOFError
  end
end

process.wait
thread.join

r.close

写入标准输入

process = ChildProcess.build("cat")

out = Tempfile.new("duplex")
out.sync = true

process.io.stdout = process.io.stderr = out
process.duplex = true

process.start
process.io.stdin.puts "hello world"
process.io.stdin.close

process.poll_for_exit(10)

out.rewind
out.read #=> "hello world\n"

管道输出到另一个 ChildProcess

search = ChildProcess.build("grep", '-E', %w(redis memcached).join('|'))
search.duplex = true
search.io.stdout = $stdout
search.start

listing = ChildProcess.build("ps", "aux")
listing.io.stdout = search.io.stdin
listing.start
listing.wait

search.io.stdin.close
search.wait

3. 项目API使用文档

ChildProcess.build

创建一个新的子进程对象。

process = ChildProcess.build("command", "arg1", "arg2")

ChildProcess::AbstractProcess

子进程对象实现了 ChildProcess::AbstractProcess 接口，提供了以下方法：

• start: 启动子进程。
• wait: 等待子进程退出。
• alive?: 检查子进程是否仍在运行。
• exited?: 检查子进程是否已退出。
• exit_code: 获取子进程的退出码。
• stop: 强制终止子进程。

ChildProcess.io

用于管理子进程的输入输出：

• inherit!: 继承父进程的 stdout 和 stderr。
• stdout=: 设置子进程的 stdout。
• stderr=: 设置子进程的 stderr。
• stdin=: 设置子进程的 stdin。

ChildProcess.environment

用于设置子进程的环境变量：

process.environment["VAR_NAME"] = "value"

ChildProcess.cwd

设置子进程的工作目录：

process.cwd = '/path/to/directory'

4. 项目安装方式

通过 RubyGems 安装

gem install childprocess

在项目中引入

require 'childprocess'

通过以上步骤，您可以成功安装并使用 ChildProcess 库来控制和管理后台运行的外部程序。