spring-job Plugin

spring-job is based on tokio-cron-scheduler

Dependencies

spring-job = { version = "<version>" }

API interface

App implements the JobConfigurator feature, which can be used to configure the scheduling task:

1
use spring::App;
2
use spring_job::{cron, JobPlugin, JobConfigurator, Jobs};
3
use spring_sqlx::SqlxPlugin;
4

5
#[tokio::main]
6
async fn main() {
7
    App::new()
8
        .add_plugin(JobPlugin)
9
        .add_plugin(SqlxPlugin)
10
        .add_jobs(jobs())
11
        .run()
12
        .await
13
}
14

15
fn jobs() -> Jobs {
16
    Jobs::new().typed_job(cron_job)
17
}
18

19
#[cron("1/10 * * * * *")]
20
async fn cron_job() {
21
    println!("cron scheduled: {:?}", SystemTime::now())
22
}

You can also use the auto_config macro to implement automatic configuration. This process macro will automatically register the scheduled tasks marked by the Procedural Macro into the app:

+#[auto_config(JobConfigurator)]
 #[tokio::main]
 async fn main() {
    App::new()
    .add_plugin(JobPlugin)
    .add_plugin(SqlxPlugin)
-   .add_jobs(jobs())
    .run()
    .await
}

Extract the Component registered by the plugin

The SqlxPlugin plugin above automatically registers a Sqlx connection pool component for us. We can use Component to extract this connection pool from App. It should be noted that although the implementation principles of spring-job's Component and spring-web's Component are similar, these two extractors belong to different crates.

use spring_sqlx::{
    sqlx::{self, Row}, ConnectPool
};
use spring_job::cron;
use spring_job::extractor::Component;

#[cron("1/10 * * * * *")]
async fn cron_job(Component(db): Component<ConnectPool>) {
    let time: String = sqlx::query("select DATE_FORMAT(now(),'%Y-%m-%d %H:%i:%s') as time")
        .fetch_one(&db)
        .await
        .context("query failed")
        .unwrap()
        .get("time");
    println!("cron scheduled: {:?}", time)
}

Read configuration

You can use Config to extract the configuration in toml. The usage is exactly the same as spring-web.

#[derive(Debug, Configurable, Deserialize)]
#[config_prefix = "custom"]
struct CustomConfig {
    a: u32,
    b: bool,
}

#[cron("1/10 * * * * *")]
async fn use_toml_config(Config(conf): Config<CustomConfig>) -> impl IntoResponse {
    format!("a={}, b={}", conf.a, conf.b)
}

Add the corresponding configuration to your configuration file:

[custom]
a = 1
b = true