Spawnling 项目技术文档

1. 安装指南

通过 Git 安装

如果你想使用最新的 master 分支，可以在你的 Gemfile 中添加以下内容：

gem 'spawnling', :git => 'https://github.com/tra/spawnling'

然后使用 bundler 进行管理，执行以下命令：

bundle install
bundle update

通过 RubyGem 安装

如果你更倾向于从最新的 gem 安装，可以在 Gemfile 中添加以下内容：

gem 'spawnling', '~>2.1'

配置数据库连接

确保 ActiveRecord 在需要时自动重新连接到数据库。例如，在 config/database.yml 中添加以下内容：

production/development:
  ...
  reconnect: true

2. 项目使用说明

Spawnling 是一个用于轻松分叉或线程化长时间运行代码段的 gem，以便您的应用程序可以更快地向用户返回结果。它通过在 ActiveRecord::Base 中创建新的数据库连接来工作，因此您不必担心数据库连接是否正常工作，它们只是工作。

简单示例

以下是一个简单的示例，展示如何在控制器中使用 Spawnling：

Spawnling.new do
  logger.info("I feel sleepy...")
  sleep 11
  logger.info("Time to wake up!")
end

如果一切正常，控制器应快速完成，然后您将在几秒钟后看到最后一个日志消息。

等待子进程/线程

如果您需要等待生成的进程/线程完成，可以传递由 Spawnling.new 返回的对象给 Spawnling.wait()，如下所示：

spawns = []
N.times do |i|
  # 生成 N 个代码块
  spawns << Spawnling.new do
    something(i)
  end
end
# 等待所有 N 个代码块完成运行
Spawnling.wait(spawns)

3. 项目 API 使用文档

选项

Spawnling 提供了多种选项，您可以在调用时传递这些选项：

选项	值
:method	:fork, :thread, :yield
:nice	整数值 0-19，19 = 非常友好
:kill	布尔值，指示父进程退出时是否杀死子进程
:argv	覆盖进程名称的字符串
:detach	布尔值，指示父进程是否应分离生成的进程

设置默认选项

您可以将任何选项设置为默认值，以便不必在每次调用 Spawnling.new 时传递它们。例如：

Spawnling::default_options :method => :thread

如果没有设置默认选项，:method 将默认为 :fork。

示例

设置子进程的优先级

Spawnling.new(:nice => 7) do
  do_something_nicely
end

使用线程

Spawnling.new(:method => :thread) do
  something
end

设置进程名称

3.times do |i|
  Spawnling.new(:argv => "spawn -#{i}-") do
    something(i)
  end
end

4. 项目安装方式

通过 Git 安装

gem 'spawnling', :git => 'https://github.com/tra/spawnling'

通过 RubyGem 安装

gem 'spawnling', '~>2.1'

配置数据库连接

在 config/database.yml 中添加：

production/development:
  ...
  reconnect: true

通过以上步骤，您可以成功安装并配置 Spawnling，开始使用它来优化您的应用程序性能。