ruby 开启sidekiq

原创

mob64ca12dfd1d5 2024-10-15 04:18:52 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12dfd1d5的原创作品，请联系作者获取转载授权，否则将追究法律责任

如何在 Ruby 中开启 Sidekiq

Sidekiq 是一个高效的后台任务处理工具，可以帮助你异步处理任务，提高应用程序的性能。本文将带您逐步了解如何在 Ruby 环境中设置和使用 Sidekiq。

整体流程

下面是一步一步开启 Sidekiq 的流程：

步骤	描述
1. 安装 gem	在 Gemfile 中添加 Sidekiq
2. 创建设置	配置 Sidekiq 选项
3. 创建任务	定义需要后台执行的任务
4. 启动 Redis	启动 Redis 服务器
5. 启动 Sidekiq	启动 Sidekiq 处理器
6. 测试任务	发送任务到 Sidekiq

步骤详细说明

1. 安装 gem

在你的 Ruby 项目中找到 Gemfile，并添加以下行：

gem 'sidekiq'

这条代码将 Sidekiq 添加为你的项目依赖。

然后，运行以下命令安装新的依赖：

bundle install

这将下载并安装所有在 Gemfile 中列出的 gem，包括 Sidekiq。

2. 创建设置

创建一个新的配置文件，比如 config/initializers/sidekiq.rb，并添加以下内容：

require 'sidekiq'

Sidekiq.configure_server do |config|
  config.redis = { url: 'redis://localhost:6379/0' }
end

Sidekiq.configure_client do |config|
  config.redis = { url: 'redis://localhost:6379/0' }
end

require 'sidekiq' 是加载 Sidekiq 的库。
Sidekiq.configure_server 和 Sidekiq.configure_client 分别用于配置服务器和客户端的 Redis 连接。

3. 创建任务

定义一个新的 Sidekiq 工作（Worker），例如在 app/workers/my_worker.rb 中：

class MyWorker
  include Sidekiq::Worker

  def perform(name)
    puts "处理任务: #{name}"
  end
end

class MyWorker 创建一个新的工作类。
include Sidekiq::Worker 是为了让这个类成为一个 Sidekiq 工作。
def perform(name) 是执行任务的实际方法，你可以在这里编写任意逻辑。

4. 启动 Redis

确保你已经安装并启动了 Redis 服务器。你可以在终端中运行：

redis-server

这将启动 Redis 服务器，使 Sidekiq 可以进行通信。

5. 启动 Sidekiq

在你的项目根目录下，打开终端并输入以下命令以启动 Sidekiq：

bundle exec sidekiq

bundle exec 确保使用当前项目中的 gem 版本。

6. 测试任务

现在你可以通过 Rails 控制台发送任务了。打开终端，进入 Rails 控制台：

rails console

然后运行以下命令：

MyWorker.perform_async("我的任务")

perform_async 方法将异步添加这个任务到 Sidekiq 队列。

序列图

下面是一个简化的序列图，展示了整个任务处理的流程：

sequenceDiagram
    participant A as 用户
    participant B as Rails 应用
    participant C as Sidekiq
    participant D as Redis

    A->>B: 发送任务
    B->>C: 将任务添加至 Sidekiq
    C->>D: 存储任务到 Redis
    C->>C: 处理任务
    C-->>D: 更新任务状态