后台任务

此包提供从通常同步的应用程序异步运行某些进程所需的功能。标准示例是 Web 服务，其中某些事情需要处理，但在用户等待浏览器响应时处理它们可能不是最佳体验。

• 请参阅 docs.rs 上的文档
• 在 crates.io 上找到此包
• 在 Mastodon 上联系我

用法

将后台任务添加到您的项目

[dependencies]
actix-rt = "2.2.0"
background-jobs = "0.15.0"
serde = { version = "1.0", features = ["derive"] }

要开始使用后台任务，首先您应该定义一个任务。

任务是由执行操作所需的数据和该操作的逻辑组合而成的。它们实现了 Job，serde::Serialize，和 serde::DeserializeOwned。

use background_jobs::{Job, BoxError};
use std::future::{ready, Ready};

#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
pub struct MyJob {
    some_usize: usize,
    other_usize: usize,
}

impl MyJob {
    pub fn new(some_usize: usize, other_usize: usize) -> Self {
        MyJob {
            some_usize,
            other_usize,
        }
    }
}

impl Job for MyJob {
    type State = ();
    type Error = BoxError;
    type Future = Ready<Result<(), BoxError>>;

    const NAME: &'static str = "MyJob";

    fn run(self, _: Self::State) -> Self::Future {
        info!("args: {:?}", self);

        ready(Ok(()))
    }
}

任务的 run 方法接受一个额外的参数，即任务期望使用的状态。应用程序中定义的所有任务的状态必须相同。默认情况下，状态是一个空元组，但您可能需要传递一些 Actix 地址或其他内容。

让我们重新定义任务以关注一些应用程序状态。

#[derive(Clone, Debug)]
pub struct MyState {
    pub app_name: String,
}

impl MyState {
    pub fn new(app_name: &str) -> Self {
        MyState {
            app_name: app_name.to_owned(),
        }
    }
}

impl Job for MyJob {
    type State = MyState;
    type Error = BoxError;
    type Future = Ready<Result<(), BoxError>>;

    // The name of the job. It is super important that each job has a unique name,
    // because otherwise one job will overwrite another job when they're being
    // registered.
    const NAME: &'static str = "MyJob";

    // The queue that this processor belongs to
    //
    // Workers have the option to subscribe to specific queues, so this is important to
    // determine which worker will call the processor
    //
    // Jobs can optionally override the queue they're spawned on
    const QUEUE: &'static str = DEFAULT_QUEUE;

    // The number of times background-jobs should try to retry a job before giving up
    //
    // Jobs can optionally override this value
    const MAX_RETRIES: MaxRetries = MaxRetries::Count(1);

    // The logic to determine how often to retry this job if it fails
    //
    // Jobs can optionally override this value
    const BACKOFF: Backoff = Backoff::Exponential(2);

    fn run(self, state: Self::State) -> Self::Future {
        info!("{}: args, {:?}", state.app_name, self);

        ready(Ok(()))
    }
}

运行任务

默认情况下，此包附带启用 background-jobs-actix 功能。它使用 background-jobs-actix 包启动服务器和工作者，并提供了一种生成新任务的方法。

background-jobs-actix 本身没有存储工作者状态的机制。这可以通过手动实现来自 background-jobs-core 的 Storage trait 来实现，或者可以使用提供的内存存储。

到此为止，回到示例

主程序

use background_jobs::{create_server, actix::WorkerConfig, BoxError};

#[actix_rt::main]
async fn main() -> Result<(), BoxError> {
    // Set up our Storage
    // For this example, we use the default in-memory storage mechanism
    use background_jobs::memory_storage::{ActixTimer, Storage};
    let storage = Storage::new(ActixTimer);

    // Configure and start our workers
    let queue_handle = WorkerConfig::new(storage, move || MyState::new("My App"))
        .register::<MyJob>()
        .set_worker_count(DEFAULT_QUEUE, 16)
        .start();

    // Queue our jobs
    queue_handle.queue(MyJob::new(1, 2))?;
    queue_handle.queue(MyJob::new(3, 4))?;
    queue_handle.queue(MyJob::new(5, 6))?;

    // Block on Actix
    actix_rt::signal::ctrl_c().await?;
    Ok(())
}

完整示例

对于完整示例项目，请参阅 示例文件夹

提供自己的服务器/工作者实现

如果您想根据这个想法创建自己的任务处理器，可以依赖于 background-jobs-core 包，该包提供 Job trait 以及实现任务处理器和任务存储的某些其他有用类型。

贡献

请随意为任何您发现的问题提交问题。请注意，任何贡献的代码都将根据 AGPLv3 许可。

许可证

版权所有 © 2022 Riley Trautman

background-jobs 是自由软件：您可以按照自由软件基金会发布的 GNU 通用公共许可证的条款重新分发和/或修改它，无论是许可证的第 3 版，还是（根据您的选择）任何更新版本。

background-jobs 的分发是希望它有用，但没有任何保证；甚至没有关于其商业性或适用于特定目的的暗示性保证。有关详细信息，请参阅 GNU 通用公共许可证。此文件是 background-jobs 的一部分。

您应该已经随 background-jobs 收到 GNU 通用公共许可证的副本。如果没有，请参阅 http://www.gnu.org/licenses/。