org.dromara.hutool.cron.TaskTable 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.map.TripleTable;
import org.dromara.hutool.core.text.StrUtil;
import org.dromara.hutool.cron.pattern.CronPattern;
import org.dromara.hutool.cron.task.CronTask;
import org.dromara.hutool.cron.task.Task;
import java.io.Serializable;
import java.util.List;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
/**
* 定时任务表
* 任务表将ID、表达式、任务一一对应，定时任务执行过程中，会周期性检查定时任务表中的所有任务表达式匹配情况，从而执行其对应的任务
* 任务的添加、移除使用读写锁保证线程安全性
*
* @author Looly
*/
public class TaskTable implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 默认任务表大小：10
*/
public static final int DEFAULT_CAPACITY = 10;
private final ReadWriteLock lock;
private final TripleTable table;
/**
* 构造
*/
public TaskTable() {
this(DEFAULT_CAPACITY);
}
/**
* 构造
*
* @param initialCapacity 容量，即预估的最大任务数
*/
public TaskTable(final int initialCapacity) {
lock = new ReentrantReadWriteLock();
this.table = new TripleTable<>(initialCapacity);
}
/**
* 新增Task
*
* @param id ID
* @param pattern {@link CronPattern}
* @param task {@link Task}
* @return this
*/
public TaskTable add(final String id, final CronPattern pattern, final Task task) {
final Lock writeLock = lock.writeLock();
writeLock.lock();
try {
if (this.table.containLeft(id)) {
throw new CronException("Id [{}] has been existed!", id);
}
this.table.put(id, pattern, task);
} finally {
writeLock.unlock();
}
return this;
}
/**
* 获取所有ID，返回不可变列表，即列表不可修改
*
* @return ID列表
* @since 4.6.7
*/
public List getIds() {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return this.table.getLefts();
} finally {
readLock.unlock();
}
}
/**
* 获取所有定时任务表达式，返回不可变列表，即列表不可修改
*
* @return 定时任务表达式列表
* @since 4.6.7
*/
public List getPatterns() {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return this.table.getMiddles();
} finally {
readLock.unlock();
}
}
/**
* 获取所有定时任务，返回不可变列表，即列表不可修改
*
* @return 定时任务列表
* @since 4.6.7
*/
public List getTasks() {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return this.table.getRights();
} finally {
readLock.unlock();
}
}
/**
* 移除Task
*
* @param id Task的ID
* @return 是否成功移除，{@code false}表示未找到对应ID的任务
*/
public boolean remove(final String id) {
final Lock writeLock = lock.writeLock();
writeLock.lock();
try {
final int index = this.table.indexOfLeft(id);
if (index > -1) {
this.table.remove(index);
return true;
}
} finally {
writeLock.unlock();
}
return false;
}
/**
* 更新某个Task的定时规则
*
* @param id Task的ID
* @param pattern 新的表达式
* @return 是否更新成功，如果id对应的规则不存在则不更新
* @since 4.0.10
*/
public boolean updatePattern(final String id, final CronPattern pattern) {
final Lock writeLock = lock.writeLock();
writeLock.lock();
try {
final int index = this.table.indexOfLeft(id);
if (index > -1) {
this.table.setMiddle(index, pattern);
return true;
}
} finally {
writeLock.unlock();
}
return false;
}
/**
* 获得指定位置的{@link Task}
*
* @param index 位置
* @return {@link Task}
* @since 3.1.1
*/
public Task getTask(final int index) {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return this.table.getRight(index);
} finally {
readLock.unlock();
}
}
/**
* 获得指定id的{@link Task}
*
* @param id ID
* @return {@link Task}
* @since 3.1.1
*/
public Task getTask(final String id) {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return table.getRightByLeft(id);
} finally {
readLock.unlock();
}
}
/**
* 获得指定id的{@link CronPattern}
*
* @param id ID
* @return {@link CronPattern}
* @since 3.1.1
*/
public CronPattern getPattern(final String id) {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return table.getMiddleByLeft(id);
} finally {
readLock.unlock();
}
}
/**
* 获得指定位置的{@link CronPattern}
*
* @param index 位置
* @return {@link CronPattern}
* @since 3.1.1
*/
public CronPattern getPattern(final int index) {
final Lock readLock = lock.readLock();
readLock.lock();
try {
return table.getMiddle(index);
} finally {
readLock.unlock();
}
}
/**
* 任务表大小，加入的任务数
*
* @return 任务表大小，加入的任务数
* @since 4.0.2
*/
public int size() {
return this.table.size();
}
/**
* 任务表是否为空
*
* @return true为空
* @since 4.0.2
*/
public boolean isEmpty() {
return size() < 1;
}
/**
* 如果时间匹配则执行相应的Task，带读锁
*
* @param scheduler {@link Scheduler}
* @param millis 时间毫秒
*/
public void executeTaskIfMatch(final Scheduler scheduler, final long millis) {
final Lock readLock = lock.readLock();
readLock.lock();
try {
executeTaskIfMatchInternal(scheduler, millis);
} finally {
readLock.unlock();
}
}
@Override
public String toString() {
final int size = this.size();
final StringBuilder builder = StrUtil.builder();
for (int i = 0; i < size; i++) {
builder.append(StrUtil.format("[{}] [{}] [{}]\n",
this.table.getLeft(i), this.table.getMiddle(i), this.table.getRight(i)));
}
return builder.toString();
}
/**
* 如果时间匹配则执行相应的Task，无锁
*
* @param scheduler {@link Scheduler}
* @param millis 时间毫秒
* @since 3.1.1
*/
protected void executeTaskIfMatchInternal(final Scheduler scheduler, final long millis) {
final int size = size();
for (int i = 0; i < size; i++) {
if (this.table.getMiddle(i).match(scheduler.config.timezone, millis, scheduler.config.matchSecond)) {
scheduler.taskExecutorManager.spawnExecutor(
new CronTask(this.table.getLeft(i), this.table.getMiddle(i), this.table.getRight(i)));
}
}
}
}