Sundial 项目技术文档

1. 安装指南

Sundial 是一个轻量级的 Java 任务调度框架。以下是安装 Sundial 的步骤：

非Maven用户

• 下载 Sundial 的 Jar 包：下载地址
• 下载依赖：org.slf4j.slf4j-api-2.0.12

Maven用户

将以下依赖添加到您的 pom.xml 文件中：

<dependency>
    <groupId>org.knowm</groupId>
    <artifactId>sundial</artifactId>
    <version>2.3.0</version>
</dependency>

对于快照版本，需要在 pom.xml 中添加以下内容：

<repository>
  <id>sonatype-oss-snapshot</id>
  <snapshots/>
  <url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>

<dependency>
    <groupId>org.knowm</groupId>
    <artifactId>sundial</artifactId>
    <version>2.3.1-SNAPSHOT</version>
</dependency>

2. 项目的使用说明

Sundial 允许您通过定义作业 (jobs) 和触发器 (triggers) 来轻松添加计划任务到您的 Java 应用程序。以下是基本的使用步骤：

• 定义一个继承自 org.knowm.sundial.Job 的作业类。
• 使用 @CronTrigger 或 @SimpleTrigger 注解来定义触发器。
• 启动 Sundial 调度器。

创建作业类

public class SampleJob extends org.knowm.sundial.Job {
  @Override
  public void doRun() throws JobInterruptException {
    // 执行一些有趣的操作...
  }
}

定义触发器

@CronTrigger(cron = "0/5 * * * * ?")
public class SampleJob extends Job {
  // 作业实现
}

或者

@SimpleTrigger(repeatInterval = 30, timeUnit = TimeUnit.SECONDS)
public class SampleJob extends Job {
  // 作业实现
}

启动 Sundial 调度器

public static void main(String[] args) {
  SundialJobScheduler.startScheduler("org.knowm.sundial.jobs"); // 包含注解作业的包名
}

3. 项目API使用文档

以下是 Sundial 项目的一些主要 API 方法：

• addJob(String name, String jobClass)：添加作业。
• addCronTrigger(String name, String jobName, String cronExpression)：添加cron触发器。
• addSimpleTrigger(String name, String jobName, int repeatCount, long repeatInterval)：添加简单触发器。
• startJob(String jobName)：异步启动作业。
• stopJob(String jobName)：中断运行中的作业。
• removeJob(String jobName)：从调度器中移除作业。
• removeTrigger(String triggerName)：从调度器中移除触发器。
• lockScheduler()：锁定调度器。
• unlockScheduler()：解锁调度器。
• isJobRunning(String jobName)：检查作业是否正在运行。

更多 API 方法请参考项目源码。

4. 项目安装方式

Sundial 的安装方式已在“安装指南”部分详细说明，主要包括非 Maven 方式和 Maven 方式。根据您的项目需求选择合适的安装方式即可。