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 中相同参数的作业并行运行而设计的gem。本指南将带您了解如何通过它的主要组件——目录结构、启动文件以及配置文件——快速上手此开源项目。

1. 项目目录结构及介绍

Sidekiq Unique Jobs 的目录结构通常遵循Rubygem的标准布局，虽然具体的内部文件可能会随着版本更新有所变化。核心结构大致如下：

• lib: 包含所有主库代码，如主要类定义和模块。
  • sidekiq-unique-jobs.rb: 入口文件，加载整个gem的功能。
  • worker/*.rb: 定义了与Sidekiq作业唯一性相关的逻辑。
• spec: 单元测试和集成测试的存放地，确保gem功能的稳定性。
• README.md: 提供快速入门指南和基本使用的说明。
• Gemfile.lock: 项目的依赖锁定文件，保证环境一致性。
• MIT-LICENSE.txt: 许可证文件，表明软件遵循MIT许可协议。

2. 项目的启动文件介绍

在实际应用中，并没有一个特定的“启动文件”属于Sidekiq Unique Jobs本身，而是通过您的应用程序集成它来“启动”。通常，您会在自己的Rails应用中的config/initializers/sidekiq.rb或类似配置文件中加入以下配置以启用该gem：

require 'sidekiq'
require 'sidekiq-unique-jobs' # 确保gem被加载

Sidekiq.configure_server do |config|
  config.options[:unique_jobs] = true # 启用唯一作业特性
end

Sidekiq.configure_client do |config|
  config.options[:unique_jobs] = true
end

如果您想针对测试环境有不同的配置，可以参照GitHub上的指导进行调整：

SidekiqUniqueJobs.configure do |config|
  config.enabled = Rails.env.test? # 只有非测试环境下启用唯一性
end

3. 项目的配置文件介绍

Sidekiq Unique Jobs提供了高度可配置的选项，这些配置通常不是通过独立的配置文件完成，而是通过代码块在初始化时设定。例如，在您的应用程序的配置中，您可以这样设置：

SidekiqUniqueJobs.configure do |config|
  config.enabled = true # 总是启用
  config.logger_enabled = !Rails.env.test? # 日志仅在非测试环境记录
  # 更多定制化配置，比如锁策略等可以根据需求添加
end

此外，对于更复杂的配置需求，比如自定义锁策略或者锁参数方法，可以在相应的Worker类中指定：

class MyCustomJob
  include Sidekiq::Worker
  sidekiq_options lock: :until_executed, lock_args_method: ->(args) { [args.first] }
  
  def perform(param)
    # Job implementation
  end
end

总结而言，Sidekiq Unique Jobs并没有一个预设的全局配置文件，其配置是通过Ruby代码在应用级别或Worker级别动态完成的。这给予开发者高度灵活性，以便根据具体应用需求进行定制。

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