Sidekiq Unique Jobs 使用教程

Sidekiq Unique Jobs 使用教程

sidekiq-unique-jobsPrevents duplicate Sidekiq jobs项目地址:https://gitcode.com/gh_mirrors/si/sidekiq-unique-jobs

项目介绍

Sidekiq Unique Jobs 是一个用于 Sidekiq 的 Ruby gem，旨在防止具有相同唯一参数的 Sidekiq 作业同时运行。它高度可配置，可以根据您的特定需求进行调整。

项目快速启动

安装

首先，将 gem 添加到您的 Gemfile 中：

gem 'sidekiq-unique-jobs'

然后运行 bundle install。

配置

在您的 Sidekiq 初始化文件中（通常是 config/initializers/sidekiq.rb），添加以下配置：

require 'sidekiq-unique-jobs'

Sidekiq.configure_server do |config|
  config.redis = { url: 'redis://localhost:6379/0' }
  config.client_middleware do |chain|
    chain.add SidekiqUniqueJobs::Middleware::Client
  end
  config.server_middleware do |chain|
    chain.add SidekiqUniqueJobs::Middleware::Server
  end
end

Sidekiq.configure_client do |config|
  config.redis = { url: 'redis://localhost:6379/0' }
  config.client_middleware do |chain|
    chain.add SidekiqUniqueJobs::Middleware::Client
  end
end

使用

在您的作业类中，使用 sidekiq_options 来配置唯一性：

class MyJob
  include Sidekiq::Job
  sidekiq_options lock: :until_executed, on_conflict: :reject

  def perform(*args)
    # 作业逻辑
  end
end

应用案例和最佳实践

防止重复提交

假设您有一个表单提交，您不希望在第一个作业仍在处理时创建第二个作业：

class FormSubmissionJob
  include Sidekiq::Job
  sidekiq_options lock: :until_executed, on_conflict: :reject

  def perform(form_id)
    # 处理表单提交
  end
end

唯一性参数过滤

您可以根据上下文确保不同类型的唯一参数：

class UniqueJobWithFilterMethod
  include Sidekiq::Worker
  sidekiq_options lock: :until_and_while_executing, lock_args_method: :lock_args

  def self.lock_args(args)
    if Sidekiq::ProcessSet.new.size > 1
      [args.first] # 运行时唯一性
    else
      args # 排队时唯一性
    end
  end
end

典型生态项目

Sidekiq

Sidekiq 是一个用于 Ruby 的后台作业处理系统，它使用 Redis 来管理作业队列。Sidekiq Unique Jobs 是 Sidekiq 的一个扩展，用于增强其唯一性处理能力。

Redis

Redis 是一个开源的内存数据结构存储，用作数据库、缓存和消息代理。Sidekiq 和 Sidekiq Unique Jobs 都依赖于 Redis 来管理作业队列和唯一性锁。

Rails

如果您使用 Ruby on Rails，Sidekiq 和 Sidekiq Unique Jobs 可以无缝集成到您的 Rails 应用程序中，提供强大的后台作业处理能力。

通过以上步骤，您可以快速启动并使用 Sidekiq Unique Jobs，确保您的 Sidekiq 作业在处理重复任务时更加高效和可靠。

sidekiq-unique-jobsPrevents duplicate Sidekiq jobs项目地址:https://gitcode.com/gh_mirrors/si/sidekiq-unique-jobs