DelayedJob Mongoid 后端技术文档

1. 安装指南

环境要求

• Ruby 2.3 及以上版本
• Mongoid 5 及以上版本

如果你使用的是 Mongoid 3 或 4，请使用 2.x 版本的 delayed_job_mongoid gem。

安装步骤

1. 将 delayed_job_mongoid gem 添加到你的 Gemfile 中：

   gem 'delayed_job_mongoid'
   

2. 创建索引（在生产环境中不要忘记执行此步骤）：

   script/rails runner 'Delayed::Backend::Mongoid::Job.create_indexes'
   

3. 生成 script/delayed_job 文件：

   rails generate delayed_job
   

完成以上步骤后，你可以像往常一样使用 delayed_job。

2. 项目的使用说明

基本使用

安装完成后，你可以使用 delayed_job 来处理后台任务。默认情况下，delayed_job 会将任务存储在 Mongoid 数据库中。

高级用法

静默日志记录

默认情况下，Mongo Ruby Driver 会在 Delayed Job 轮询数据库时每隔 5 秒打印一次日志。你可以使用以下插件来静默这些日志（除了 error 级别的日志），并且只记录在任务执行期间的操作日志。

# 在 initializers/delayed_job.rb 中

require 'delayed/plugins/mongo_silencer'
Delayed::Worker.plugins << Delayed::Plugins::MongoSilencer

为了确保线程安全，此插件要求你的 Mongo::Logger.logger 是 ActiveSupport::Logger 类的实例。它将忽略 Ruby 标准库 Logger 类的实例。

自定义任务类

Delayed Job 允许你为任务指定一个自定义的后端类。例如，你可能希望指定一个不同的数据库集合名称。你可以这样做：

# 在初始化器中

class MyJob
  include ::Mongoid::Document

  store_in(collection: :my_jobs)

  include ::Delayed::Backend::Mongoid::Mixin
end

Delayed::Worker.backend = MyJob

# 在你的应用程序中

MyJob.enqueue(job_object)

3. 项目API使用文档

主要API

• Delayed::Backend::Mongoid::Job.create_indexes：创建 Mongoid 索引。
• Delayed::Worker.plugins：添加插件以扩展 Delayed Job 的功能。
• Delayed::Worker.backend：设置自定义的任务后端类。

示例

# 创建索引
Delayed::Backend::Mongoid::Job.create_indexes

# 添加插件
require 'delayed/plugins/mongo_silencer'
Delayed::Worker.plugins << Delayed::Plugins::MongoSilencer

# 设置自定义任务类
class MyJob
  include ::Mongoid::Document
  store_in(collection: :my_jobs)
  include ::Delayed::Backend::Mongoid::Mixin
end

Delayed::Worker.backend = MyJob

4. 项目安装方式

项目的安装方式已经在 安装指南 中详细说明。请按照步骤进行安装，确保你的环境满足要求。

---

通过以上文档，你应该能够顺利安装和使用 delayed_job_mongoid 项目。如果在使用过程中遇到问题，请参考项目的 GitHub Wiki 或联系项目维护者。