Rust定时任务调度库clokwerk的使用：轻量级、高效的时间管理和周期性任务调度

Clokwerk是一个简单的调度库，灵感来自Python的Schedule和Ruby的clockwork。它使用类似的DSL进行调度，而不是解析cron字符串。

默认情况下，时间和日期是相对于本地时区的，但可以使用Scheduler::with_tz构造函数让调度器使用不同的时区。

从0.4版本开始，Clokwerk还支持单独的AsyncScheduler，它可以轻松地并发运行异步任务。

使用示例

// 引入调度器和时间单位特性
use clokwerk::{Scheduler, TimeUnits};
// 引入星期和WeekDay
use clokwerk::Interval::*;
use std::thread;
use std::time::Duration;

// 创建一个新的调度器
let mut scheduler = Scheduler::new();
// 或者创建一个指定时区的调度器
let mut scheduler = Scheduler::with_tz(chrono::Utc);
// 添加一些任务
scheduler.every(10.minutes()).plus(30.seconds()).run(|| println!("周期性任务"));
scheduler.every(1.day()).at("3:20 pm").run(|| println!("每日任务"));
scheduler.every(Tuesday).at("14:20:17").and_every(Thursday).at("15:00").run(|| println!("双周任务"));

// 在事件循环中手动运行调度器
for _ in 1..10 {
    scheduler.run_pending();
    thread::sleep(Duration::from_millis(10));
}
// 或者在后台线程中运行
let thread_handle = scheduler.watch_thread(Duration::from_millis(100));
// 当`thread_handle`被丢弃或调用`stop`时，调度器会停止
thread_handle.stop();

完整示例代码

use clokwerk::{Scheduler, TimeUnits};
use clokwerk::Interval::*;
use std::thread;
use std::time::Duration;

fn main() {
    // 创建调度器
    let mut scheduler = Scheduler::new();

    // 添加各种定时任务
    // 每隔10分钟30秒执行一次
    scheduler.every(10.minutes())
             .plus(30.seconds())
             .run(|| println!("执行周期性任务 - 每10分30秒"));

    // 每天下午3:20执行
    scheduler.every(1.day())
             .at("3:20 pm")
             .run(|| println!("执行每日任务 - 下午3:20"));

    // 每周二14:20:17和每周四15:00执行
    scheduler.every(Tuesday)
             .at("14:20:17")
             .and_every(Thursday)
             .at("15:00")
             .run(|| println!("执行双周任务 - 周二14:20:17或周四15:00"));

    // 在事件循环中运行调度器
    loop {
        scheduler.run_pending();
        thread::sleep(Duration::from_millis(100));
    }
}

类似库

• schedule-rs和job_scheduler是另外两个Rust调度库。它们都使用cron语法进行调度。

安装

在Cargo.toml中添加：

clokwerk = "0.4.0"

或者运行：

cargo add clokwerk

完整示例demo

下面是一个更完整的clokwerk使用示例，包含异步任务调度和错误处理：

use clokwerk::{AsyncScheduler, Scheduler, TimeUnits};
use clokwerk::Interval::*;
use std::sync::Arc;
use tokio::sync::Mutex;
use std::time::Duration;

#[tokio::main]
async fn main() {
    // 同步调度器示例
    let mut sync_scheduler = Scheduler::new();
    
    // 添加同步任务
    sync_scheduler.every(30.seconds()).run(|| {
        println!("同步任务执行 - 每30秒");
    });
    
    // 异步调度器示例
    let async_scheduler = Arc::new(Mutex::new(AsyncScheduler::new()));
    
    // 添加异步任务
    {
        let mut scheduler = async_scheduler.lock().await;
        scheduler.every(1.minutes()).run(|| async {
            println!("异步任务执行 - 每分钟");
        });
    }
    
    // 在后台线程中运行同步调度器
    let sync_thread = sync_scheduler.watch_thread(Duration::from_millis(100));
    
    // 运行异步调度器
    tokio::spawn(async move {
        let scheduler = async_scheduler.clone();
        loop {
            scheduler.lock().await.run_pending().await;
            tokio::time::sleep(Duration::from_millis(100)).await;
        }
    });
    
    // 主线程等待
    tokio::signal::ctrl_c().await.expect("无法监听Ctrl+C信号");
    sync_thread.stop();
    println!("调度器已停止");
}

Clokwerk是一个轻量级但功能强大的定时任务调度库，特别适合需要简单但灵活的任务调度场景。通过直观的DSL语法，开发者可以轻松设置各种复杂的定时任务，而无需学习复杂的cron表达式。