当前位置：首页 > news >正文

Hutool - Cron：强大的定时任务模块

news 来源：原创 2025/5/2 8:13:03

一、简介

在软件开发中，定时任务是一种常见且重要的功能需求。例如，定期备份数据、定时生成报表、定时清理缓存等。Hutool - Cron 是 Hutool 工具包中的定时任务模块，它提供了类似于 Crontab 表达式的定时任务调度功能，使得在 Java 项目中实现定时任务变得简单而高效。Crontab 表达式是一种用于指定任务执行时间的字符串格式，在 Linux 系统中广泛应用，Hutool - Cron 借鉴了这种简洁且强大的表达方式，让开发者可以轻松定义各种复杂的定时任务。

二、引入依赖

如果你使用 Maven 项目，在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.16</version>
</dependency>

如果使用 Gradle 项目，则在 build.gradle 中添加：

implementation 'cn.hutool:hutool-all:5.8.16'

三、Crontab 表达式详解

Crontab 表达式由 6 或 7 个字段组成，分别表示秒（可选）、分、时、日、月、周、年（可选），各字段之间用空格分隔。以下是各字段的取值范围和常用符号说明：

秒（可选）：取值范围 0 - 59，常用符号有 *（表示任意值）、,（表示枚举值）、-（表示范围）、/（表示步长）。例如，0/5 表示从 0 秒开始，每隔 5 秒执行一次。
分：取值范围 0 - 59。
时：取值范围 0 - 23。
日：取值范围 1 - 31。
月：取值范围 1 - 12 或 JAN - DEC。
周：取值范围 0 - 7 或 SUN - SAT，其中 0 和 7 都表示周日。
年（可选）：取值范围 1970 - 2099。

以下是一些常见的 Crontab 表达式示例：

0 0 12 * * ?：每天中午 12 点执行。
0 15 10 ? * *：每天上午 10:15 执行。
0/5 * * * * ?：每隔 5 秒执行一次。

四、基本使用示例

1. 简单定时任务

import cn.hutool.cron.CronUtil;
import cn.hutool.cron.task.Task;

public class SimpleCronExample {
    public static void main(String[] args) {
        // 开启定时任务调度
        CronUtil.start();

        // 添加定时任务，每天中午 12 点执行
        CronUtil.schedule("0 0 12 * * ?", new Task() {
            @Override
            public void execute() {
                System.out.println("定时任务执行：现在是中午 12 点！");
            }
        });
    }
}

在上述代码中，首先调用 CronUtil.start() 方法开启定时任务调度。然后使用 CronUtil.schedule 方法添加一个定时任务，该方法接受两个参数：Crontab 表达式和一个 Task 对象。Task 对象是一个接口，需要实现其 execute 方法，在该方法中编写定时任务的具体逻辑。

2. 停止和移除定时任务

import cn.hutool.cron.CronUtil;
import cn.hutool.cron.task.Task;

public class StopAndRemoveCronExample {
    public static void main(String[] args) {
        // 开启定时任务调度
        CronUtil.start();

        // 添加定时任务，每隔 5 秒执行一次
        String taskId = CronUtil.schedule("0/5 * * * * ?", new Task() {
            @Override
            public void execute() {
                System.out.println("定时任务执行：每隔 5 秒执行一次！");
            }
        });

        try {
            // 等待 20 秒
            Thread.sleep(20000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        // 停止定时任务
        CronUtil.stop();

        // 移除定时任务
        CronUtil.remove(taskId);
    }
}

在这个示例中，首先添加一个每隔 5 秒执行一次的定时任务，并获取任务的 ID。然后让程序等待 20 秒，之后调用 CronUtil.stop() 方法停止定时任务调度，再使用 CronUtil.remove(taskId) 方法移除指定 ID 的定时任务。

五、高级用法

1. 动态添加和修改定时任务

import cn.hutool.cron.CronUtil;
import cn.hutool.cron.task.Task;

public class DynamicCronExample {
    public static void main(String[] args) {
        // 开启定时任务调度
        CronUtil.start();

        // 初始定时任务，每隔 10 秒执行一次
        String taskId = CronUtil.schedule("0/10 * * * * ?", new Task() {
            @Override
            public void execute() {
                System.out.println("初始定时任务执行：每隔 10 秒执行一次！");
            }
        });

        try {
            // 等待 30 秒
            Thread.sleep(30000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        // 移除初始定时任务
        CronUtil.remove(taskId);

        // 添加新的定时任务，每隔 20 秒执行一次
        CronUtil.schedule("0/20 * * * * ?", new Task() {
            @Override
            public void execute() {
                System.out.println("新定时任务执行：每隔 20 秒执行一次！");
            }
        });
    }
}

在这个示例中，首先添加一个每隔 10 秒执行一次的定时任务。等待 30 秒后，移除该任务，并添加一个新的每隔 20 秒执行一次的定时任务，实现了定时任务的动态修改。

2. 使用配置文件配置定时任务

Hutool - Cron 还支持使用配置文件来配置定时任务。在 resources 目录下创建 cron.setting 文件，内容如下：

# 每天凌晨 2 点执行
0 0 2 * * ? = cn.hutool.demo.task.DailyTask

其中，等号左边是 Crontab 表达式，右边是要执行的任务类的全限定名。然后在代码中加载配置文件并启动定时任务：

import cn.hutool.cron.CronUtil;

public class ConfigFileCronExample {
    public static void main(String[] args) {
        // 加载配置文件
        CronUtil.setMatchSecond(true); // 支持秒级定时任务
        CronUtil.start(true);
    }
}

在上述代码中，CronUtil.setMatchSecond(true) 表示支持秒级定时任务，CronUtil.start(true) 表示从配置文件中加载定时任务并启动调度。

六、注意事项

线程安全：在定时任务的 execute 方法中，如果涉及到共享资源的操作，需要注意线程安全问题，避免出现数据不一致的情况。
异常处理：在 execute 方法中，建议添加异常处理逻辑，防止因异常导致定时任务中断。例如：

import cn.hutool.cron.CronUtil;
import cn.hutool.cron.task.Task;

public class ExceptionHandlingCronExample {
    public static void main(String[] args) {
        CronUtil.start();
        CronUtil.schedule("0/5 * * * * ?", new Task() {
            @Override
            public void execute() {
                try {
                    // 定时任务的具体逻辑
                    System.out.println("定时任务执行：每隔 5 秒执行一次！");
                } catch (Exception e) {
                    System.err.println("定时任务执行出错：" + e.getMessage());
                }
            }
        });
    }
}