DelayedJob ActiveRecord Backend 技术文档

1. 安装指南

1.1 添加 Gem 到 Gemfile

首先，你需要在项目的 Gemfile 中添加 delayed_job_active_record gem：

gem 'delayed_job_active_record'

然后运行 bundle install 来安装 gem。

1.2 生成迁移文件

如果你正在使用 Rails，可以通过运行以下命令来生成 delayed_job 表的迁移文件：

rails g delayed_job:active_record

接着运行数据库迁移命令：

rake db:migrate

1.3 升级指南

如果你正在从 Delayed Job 2.x 升级到 3.0.0 版本，你需要运行升级生成器来创建一个迁移文件，以便为 delayed_jobs 表添加新的列：

rails g delayed_job:upgrade
rake db:migrate

2. 项目的使用说明

2.1 基本使用

Delayed Job 是一个用于异步任务处理的库。你可以将任何方法或任务放入队列中，Delayed Job 会在后台处理这些任务。

例如，你可以将一个方法延迟执行：

MyModel.delay.my_method

2.2 锁定任务的问题

在某些情况下，你可能会遇到任务锁定的问题。你可以尝试使用传统的锁定代码，虽然它通常较慢，但在某些情况下效果更好：

Delayed::Backend::ActiveRecord.configuration.reserve_sql_strategy = :default_sql

3. 项目 API 使用文档

3.1 延迟执行方法

你可以使用 delay 方法来延迟执行任何方法：

MyModel.delay.my_method

3.2 设置优先级

你可以为任务设置优先级，优先级越低的任务会先被执行：

MyModel.delay(priority: 10).my_method

3.3 设置执行时间

你可以指定任务的执行时间：

MyModel.delay(run_at: 1.hour.from_now).my_method

3.4 任务队列

你可以将任务放入指定的队列中：

MyModel.delay(queue: 'my_queue').my_method

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 delayed_job_active_record gem，然后运行 bundle install。

4.2 生成迁移文件

运行以下命令生成迁移文件并执行迁移：

rails g delayed_job:active_record
rake db:migrate

4.3 升级安装

如果你正在从 Delayed Job 2.x 升级到 3.0.0 版本，运行以下命令：

rails g delayed_job:upgrade
rake db:migrate

通过以上步骤，你可以成功安装并使用 DelayedJob ActiveRecord Backend。希望这篇文档能帮助你更好地理解和使用该项目。