Spring Kotlin Cron

Spring Kotlin Cron allows developers to schedule recurrent tasks using cron expressions in a Kotlin-based Spring Boot application.

Features

1. Easy configuration of cron-based recurrent tasks through annotations.
2. Automatic scheduling of tasks using the reliable, well-established cron expression syntax.
3. Clean and concise code thanks to Kotlin's expressive syntax.
4. Effective use of Spring Boot's dependency injection capabilities.
5. Flexible and customizable scheduling options.

Getting Started

Installation

To use Spring Kotlin Cron, include the following dependency in your Gradle build file:

compile("org.springframework.boot:spring-boot-starter")
compile("org.springframework:spring-context")
compile("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
compile("com.github.rkumsher:spring-kotlin-cron:<version>")

Usage

First, create a Kotlin class implementing the Task interface to define the task to be scheduled:

@Component
class MyTask : Task {
    override fun run() {
        println("Task executed!")
    }
}

Next, annotate the class with @ScheduledTask and provide a cron expression as the argument:

@Component
@ScheduledTask(cron = "0 0 12 * * ?")
class MyTask : Task {
    override fun run() {
        println("Task executed!")
    }
}

Finally, add the @EnableTaskScheduling annotation to your @SpringBootApplication class:

@SpringBootApplication
@EnableTaskScheduling
class MyApplication {
    // ...
}

Your scheduled task will now run at 12:00 PM every day.

Customization

A custom Clock instance can be provided to the CronScheduler to override the current date and time. This can be useful for testing or other scenarios where the current time needs to be controlled.

Conclusion

Spring Kotlin Cron simplifies the task of scheduling recurrent tasks in a Kotlin-based Spring Boot application. Its intuitive syntax and powerful features allow developers to easily and effectively schedule complex tasks using cron expressions.