Crono 项目使用教程

Crono 项目使用教程

crono A time-based background job scheduler daemon (just like Cron) for Rails 项目地址: https://gitcode.com/gh_mirrors/cr/crono

1. 项目介绍

Crono 是一个基于 Ruby on Rails 的时间背景任务调度守护进程，类似于 Unix 的 Cron。它的主要目的是为 Rails 应用提供一个纯 Ruby 的定时任务调度解决方案，不依赖于 Unix Cron 或其他平台特定的工具。Crono 通过 Active Record 将任务状态持久化到数据库中，用户可以完全控制任务的执行过程。

2. 项目快速启动

2.1 安装

首先，将以下代码添加到你的 Rails 应用的 Gemfile 中：

gem 'crono'

然后运行以下命令来安装 Crono：

bundle install

2.2 生成配置文件和迁移

安装完成后，运行以下命令生成 Crono 的配置文件和数据库迁移：

rails generate crono:install

接着运行迁移命令来创建必要的数据库表：

rake db:migrate

2.3 创建和调度任务

在 config/cronotab.rb 文件中定义你的任务。例如，创建一个简单的任务：

# config/cronotab.rb
class TestJob
  def perform
    puts 'Test'
  end
end

Crono.perform(TestJob).every 5.seconds

2.4 启动 Crono

在 Rails 项目的根目录下运行以下命令来启动 Crono：

bundle exec crono -e development

3. 应用案例和最佳实践

3.1 定时发送邮件

假设你需要每天早上 8 点发送一封邮件，可以创建一个任务来处理这个需求：

# config/cronotab.rb
class DailyEmailJob
  def perform
    UserMailer.daily_email.deliver_now
  end
end

Crono.perform(DailyEmailJob).every 1.day, at: '08:00'

3.2 数据清理

定期清理旧数据是一个常见的任务。你可以创建一个任务来删除超过 30 天的日志记录：

# config/cronotab.rb
class CleanUpLogsJob
  def perform
    Log.where('created_at < ?', 30.days.ago).delete_all
  end
end

Crono.perform(CleanUpLogsJob).every 1.week, on: :monday, at: '03:00'

4. 典型生态项目

4.1 Active Job

Crono 可以与 Rails 的 Active Job 集成，使用 app/jobs/ 目录下的任务。例如：

# app/jobs/test_job.rb
class TestJob < ActiveJob::Base
  def perform(options)
    # 你的任务代码
  end
end

4.2 Capistrano

如果你使用 Capistrano 进行部署，可以使用 capistrano-crono gem 来管理 Crono 的部署和启动。

# Gemfile
gem 'capistrano-crono'

然后在 Capistrano 的配置文件中添加相应的任务：

# Capfile
require 'capistrano/crono'

通过这些步骤，你可以轻松地在 Rails 应用中集成和使用 Crono 来管理定时任务。

crono A time-based background job scheduler daemon (just like Cron) for Rails 项目地址: https://gitcode.com/gh_mirrors/cr/crono