Workless 技术文档

1. 安装指南

首先，您需要在项目的 Gemfile 文件中添加 workless 和 delayed_job 依赖项，并根据您的 Rails 版本选择相应的 delayed_job 版本。以下是针对不同版本的配置示例：

Rails 4.x 与最新的 delayed_job 3.x 使用 Active Record

gem "delayed_job_active_record"
gem "workless", "~> 2.2.0"

Rails 5.x 与最新的 delayed_job 3.x 使用 Active Record

gem "delayed_job_active_record"
gem "workless", "~> 2.0.0"

如果您未在 Gemfile 中指定 delayed_job，workless 会自动将其添加进来，通常是最新版本（4.1.2）。

将您的 Heroku 应用名称和 API 密钥作为配置变量添加到 Heroku 实例中：

heroku config:add WORKLESS_API_KEY=yourapikey APP_NAME=yourherokuappname

2. 项目的使用说明

workless 是为 delayed_job（版本 > 2.0.0）设计的插件，适用于在 Heroku 托管的背景作业。通过将 workless 添加到您的项目并配置一些 Heroku 应用配置变量，workless 可以自动管理作业的执行，从而避免持续运行作业，节省成本。

在创建和销毁作业时，workless 会自动启动和停止工作者（workers）。如果所有尝试都失败，它将仅关闭 dj 工作者。

3. 项目API使用文档

workless 通过 Delayed::Job 类集成了 Delayed::Workless::Scaler，添加了多个回调，用于管理作业的生命周期：

• 当数据库中创建一个作业时，create 回调会启动一个工作者。
• 工作者运行作业后，将其从数据库中移除。
• destroy 回调会停止工作者。

4. 项目安装方式

安装 workless 的方式如下：

1. 在 Gemfile 中添加 workless 和 delayed_job 依赖项。
2. 运行 bundle update 更新依赖。
3. 配置 Heroku 应用配置变量：WORKLESS_API_KEY 和 APP_NAME。
4. 部署应用到 Heroku。

请确保在 Heroku 上正确设置了所有必要的配置变量，并且遵循了上述安装步骤，以便 workless 能够正常工作。

以上就是 workless 的技术文档，希望对您使用该项目有所帮助。