Backgrounded 项目技术文档

1. 安装指南

1.1 安装方式

要安装 Backgrounded，您可以使用以下命令：

$ gem install backgrounded

1.2 配置

Backgrounded 支持多种后台处理框架，您可以根据需要选择合适的框架。以下是一些常见的配置示例：

1.2.1 Resque

如果您使用 Resque 作为后台处理框架，可以参考相关文档进行配置。

1.2.2 JobFu

如果您使用 JobFu 作为后台处理框架，可以参考相关文档进行配置。

1.2.3 自定义处理器

您也可以编写自定义处理器来处理后台任务。以下是一个简单的自定义处理器示例：

# config/initializers/backgrounded.rb
class MyHandler
  # @param object 是要调用方法的目标对象
  # @param method 是要调用的方法
  # @param args 是传递给方法的可选参数列表
  # @param options 是传递给 backgrounded 调用的可选选项哈希
  def request(object, method, args, options={})
    # 以您希望的方式处理调用
  end
end

# 配置 backgrounded 使用您的处理器
Backgrounded.configure do |config|
  config.handler = MyHandler.new
end

2. 项目使用说明

2.1 基本用法

Backgrounded 提供了一个简洁的 API，允许您在后台执行任何模型方法。以下是一个基本用法的示例：

class User
  def do_stuff
  end
  def self.do_something_else
  end
end

user = User.new
# 在后台执行实例方法
user.backgrounded.do_stuff

# 在后台执行类方法
User.backgrounded.do_something_else

2.2 after_commit_backgrounded 回调

Backgrounded 还支持在模型保存到数据库后自动在后台执行回调。以下是一个示例：

class User < ActiveRecord::Base
  # 在提交后在后台执行 :do_something
  after_commit_backgrounded :do_something

  # 在提交后在后台执行 :do_something_else，并传递自定义选项给 backgrounded 处理器
  after_commit_backgrounded :do_something_else, :backgrounded => {:priority => :high}
end

3. 项目API使用文档

3.1 backgrounded 方法

backgrounded 方法用于在后台执行实例方法或类方法。

3.1.1 实例方法

user.backgrounded.do_stuff

3.1.2 类方法

User.backgrounded.do_something_else

3.2 after_commit_backgrounded 回调

after_commit_backgrounded 回调用于在模型保存到数据库后自动在后台执行指定的方法。

after_commit_backgrounded :do_something

4. 项目安装方式

4.1 使用 gem 安装

$ gem install backgrounded

4.2 自定义处理器

您可以编写自定义处理器来处理后台任务。以下是一个简单的自定义处理器示例：

# config/initializers/backgrounded.rb
class MyHandler
  def request(object, method, args, options={})
    # 以您希望的方式处理调用
  end
end

Backgrounded.configure do |config|
  config.handler = MyHandler.new
end

通过以上步骤，您可以成功安装并配置 Backgrounded，并开始在项目中使用它来处理后台任务。