开源项目 `delayed` 使用教程

开源项目 delayed 使用教程

delayeda multi-threaded, SQL-driven ActiveJob backend used at Betterment to process millions of background jobs per day项目地址:https://gitcode.com/gh_mirrors/de/delayed

1. 项目的目录结构及介绍

delayed 项目的目录结构如下：

delayed/
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
├── Rakefile
├── delayed.gemspec
├── lib/
│   ├── delayed/
│   │   ├── backend/
│   │   │   ├── active_record.rb
│   │   │   └── test.rb
│   │   ├── compatibility.rb
│   │   ├── exceptions.rb
│   │   ├── message_sending.rb
│   │   ├── performable_method.rb
│   │   ├── railtie.rb
│   │   ├── settings.rb
│   │   ├── worker.rb
│   │   └── version.rb
│   └── delayed.rb
├── spec/
│   ├── active_record_spec.rb
│   ├── configuration_spec.rb
│   ├── job_spec.rb
│   ├── message_sending_spec.rb
│   ├── performable_method_spec.rb
│   ├── railtie_spec.rb
│   ├── settings_spec.rb
│   ├── worker_spec.rb
│   └── spec_helper.rb
└── tasks/
    └── delayed_job.rb

目录结构介绍

• Gemfile 和 Gemfile.lock：定义了项目的依赖关系。
• LICENSE.txt：项目的许可证文件。
• README.md：项目的基本介绍和使用说明。
• Rakefile：定义了项目的 Rake 任务。
• delayed.gemspec：项目的 gem 规范文件。
• lib/：包含项目的核心代码。
  • delayed/：项目的核心模块。
    • backend/：后端存储实现，如 active_record.rb。
    • compatibility.rb：兼容性相关代码。
    • exceptions.rb：自定义异常类。
    • message_sending.rb：消息发送相关代码。
    • performable_method.rb：可执行方法相关代码。
    • railtie.rb：Rails 集成相关代码。
    • settings.rb：配置相关代码。
    • worker.rb：工作进程相关代码。
    • version.rb：版本信息。
  • delayed.rb：项目的主入口文件。
• spec/：包含项目的测试代码。
• tasks/：包含项目的 Rake 任务定义。

2. 项目的启动文件介绍

项目的启动文件是 lib/delayed.rb，它负责加载项目的核心模块和配置。

# lib/delayed.rb

require 'delayed/version'
require 'delayed/settings'
require 'delayed/compatibility'
require 'delayed/exceptions'
require 'delayed/message_sending'
require 'delayed/performable_method'
require 'delayed/worker'
require 'delayed/railtie' if defined?(Rails::Railtie)

module Delayed
  class << self
    def configure
      yield(Delayed::Settings) if block_given?
    end
  end
end

启动文件介绍

• require 'delayed/version'：加载版本信息。
• require 'delayed/settings'：加载配置模块。
• require 'delayed/compatibility'：加载兼容性模块。
• require 'delayed/exceptions'：加载自定义异常类。
• require 'delayed/message_sending'：加载消息发送模块。
• require 'delayed/performable_method'：加载可执行方法模块。
• require 'delayed/worker'：加载工作进程模块。
• require 'delayed/railtie'：加载 Rails 集成模块（如果存在）。
• module Delayed：定义了 Delayed 模块，并提供了配置方法 configure。

3. 项目的配置文件介绍

项目的配置文件是 lib/delayed/settings.rb，它定义了项目的配置选项。

# lib/delayed/settings.rb

module Delayed
  module Settings
    class << self
      attr_accessor :default_priority, :default_queue_name, :max_attempts, :max_run_

delayeda multi-threaded, SQL-driven ActiveJob backend used at Betterment to process millions of background jobs per day项目地址:https://gitcode.com/gh_mirrors/de/delayed