org.dromara.hutool.cron.CronUtil Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.cron;
import org.dromara.hutool.core.exception.HutoolException;
import org.dromara.hutool.core.io.resource.NoResourceException;
import org.dromara.hutool.cron.pattern.CronPattern;
import org.dromara.hutool.cron.task.Task;
import org.dromara.hutool.setting.Setting;
import org.dromara.hutool.setting.SettingException;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
/**
* 定时任务工具类
* 此工具持有一个全局{@link Scheduler}，所有定时任务在同一个调度器中执行
* {@link #setMatchSecond(boolean)} 方法用于定义是否使用秒匹配模式，如果为true，则定时任务表达式中的第一位为秒，否则为分，默认是分
*
* @author Looly
*
*/
public class CronUtil {
/** Crontab配置文件 */
public static final String CRONTAB_CONFIG_PATH = "config/cron.setting";
/**
* Crontab配置文件2
*/
public static final String CRONTAB_CONFIG_PATH2 = "cron.setting";
private static final Lock lock = new ReentrantLock();
private static final Scheduler scheduler = new Scheduler();
private static Setting crontabSetting;
/**
* 自定义定时任务配置文件
*
* @param cronSetting 定时任务配置文件
*/
public static void setCronSetting(final Setting cronSetting) {
crontabSetting = cronSetting;
}
/**
* 自定义定时任务配置文件路径
*
* @param cronSettingPath 定时任务配置文件路径（相对绝对都可）
*/
public static void setCronSetting(final String cronSettingPath) {
try {
crontabSetting = new Setting(cronSettingPath, Setting.DEFAULT_CHARSET, false);
} catch (final SettingException | NoResourceException e) {
// ignore setting file parse error and no config error
}
}
/**
* 设置是否支持秒匹配
* 此方法用于定义是否使用秒匹配模式，如果为true，则定时任务表达式中的第一位为秒，否则为分，默认是分
*
* @param isMatchSecond {@code true}支持，{@code false}不支持
*/
public static void setMatchSecond(final boolean isMatchSecond) {
scheduler.setMatchSecond(isMatchSecond);
}
/**
* 加入定时任务
*
* @param schedulingPattern 定时任务执行时间的crontab表达式
* @param task 任务
* @return 定时任务ID
*/
public static String schedule(final String schedulingPattern, final Task task) {
return scheduler.schedule(schedulingPattern, task);
}
/**
* 加入定时任务
*
* @param id 定时任务ID
* @param schedulingPattern 定时任务执行时间的crontab表达式
* @param task 任务
* @return 定时任务ID
* @since 3.3.0
*/
public static String schedule(final String id, final String schedulingPattern, final Task task) {
scheduler.schedule(id, schedulingPattern, task);
return id;
}
/**
* 加入定时任务
*
* @param schedulingPattern 定时任务执行时间的crontab表达式
* @param task 任务
* @return 定时任务ID
*/
public static String schedule(final String schedulingPattern, final Runnable task) {
return scheduler.schedule(schedulingPattern, task);
}
/**
* 批量加入配置文件中的定时任务
*
* @param cronSetting 定时任务设置文件
*/
public static void schedule(final Setting cronSetting) {
scheduler.schedule(cronSetting);
}
/**
* 移除任务
*
* @param schedulerId 任务ID
* @return 是否移除成功，{@code false}表示未找到对应ID的任务
*/
public static boolean remove(final String schedulerId) {
return scheduler.descheduleWithStatus(schedulerId);
}
/**
* 更新Task的执行时间规则
*
* @param id Task的ID
* @param pattern {@link CronPattern}
* @since 4.0.10
*/
public static void updatePattern(final String id, final CronPattern pattern) {
scheduler.updatePattern(id, pattern);
}
/**
* @return 获得Scheduler对象
*/
public static Scheduler getScheduler() {
return scheduler;
}
/**
* 开始，非守护线程模式
*
* @see #start(boolean)
*/
public static void start() {
start(false);
}
/**
* 开始
*
* @param isDaemon 是否以守护线程方式启动，如果为true，则在调用{@link #stop()}方法后执行的定时任务立即结束，否则等待执行完毕才结束。
*/
synchronized public static void start(final boolean isDaemon) {
if (scheduler.isStarted()) {
throw new HutoolException("Scheduler has been started, please stop it first!");
}
lock.lock();
try {
if (null == crontabSetting) {
// 尝试查找config/cron.setting
setCronSetting(CRONTAB_CONFIG_PATH);
}
// 尝试查找cron.setting
if (null == crontabSetting) {
setCronSetting(CRONTAB_CONFIG_PATH2);
}
} finally {
lock.unlock();
}
schedule(crontabSetting);
scheduler.start(isDaemon);
}
/**
* 重新启动定时任务
* 此方法会清除动态加载的任务，重新启动后，守护线程与否与之前保持一致
*/
public static void restart() {
lock.lock();
try {
if (null != crontabSetting) {
//重新读取配置文件
crontabSetting.load();
}
if (scheduler.isStarted()) {
//关闭并清除已有任务
stop();
}
} finally {
lock.unlock();
}
//重新加载任务
schedule(crontabSetting);
//重新启动
scheduler.start();
}
/**
* 停止
*/
public static void stop() {
scheduler.stop(true);
}
}