SpringBoot の動的スケジュールされたタスクを実装する方法
- 王林転載
- 2023-05-21 14:05:301200ブラウズ
スケジュールされたタスクを実行するためのスレッド プール構成クラス
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
@Configuration
public class SchedulingConfig {
@Bean
public TaskScheduler taskScheduler() {
ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
// 定时任务执行线程池核心线程数
taskScheduler.setPoolSize(6);
taskScheduler.setRemoveOnCancelPolicy(true);
taskScheduler.setThreadNamePrefix("TaskSchedulerThreadPool-");
return taskScheduler;
}
}ScheduledFuture のペーパー クラス
ScheduledFuture は、ScheduledExecutorService のスケジュールされたタスクのスレッド プールの実行結果です。
import java.util.concurrent.ScheduledFuture;
public final class ScheduledTask {
volatile ScheduledFuture<?> future;
/**
* 取消定时任务
*/
public void cancel() {
ScheduledFuture<?> future = this.future;
if (future != null) {
future.cancel(true);
}
}
}Runnable インターフェイス実装クラス
は、スケジュールされたタスクのスレッド プールによって呼び出され、指定された Bean 内のメソッドを実行します。
import com.ying.demo.utils.springContextUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
import java.lang.reflect.Method;
import java.util.Objects;
public class SchedulingRunnable implements Runnable {
private static final Logger logger = LoggerFactory.getLogger(SchedulingRunnable.class);
private String beanName;
private String methodName;
private String params;
public SchedulingRunnable(String beanName, String methodName) {
this(beanName, methodName, null);
}
public SchedulingRunnable(String beanName, String methodName, String params) {
this.beanName = beanName;
this.methodName = methodName;
this.params = params;
}
@Override
public void run() {
logger.info("定时任务开始执行 - bean：{}，方法：{}，参数：{}", beanName, methodName, params);
long startTime = System.currentTimeMillis();
try {
Object target = springContextUtils.getBean(beanName);
Method method = null;
if (!StringUtils.isEmpty(params)) {
method = target.getClass().getDeclaredMethod(methodName, String.class);
} else {
method = target.getClass().getDeclaredMethod(methodName);
}
ReflectionUtils.makeAccessible(method);
if (!StringUtils.isEmpty(params)) {
method.invoke(target, params);
} else {
method.invoke(target);
}
} catch (Exception ex) {
logger.error(String.format("定时任务执行异常 - bean：%s，方法：%s，参数：%s ", beanName, methodName, params), ex);
}
long times = System.currentTimeMillis() - startTime;
logger.info("定时任务执行结束 - bean：{}，方法：{}，参数：{}，耗时：{} 毫秒", beanName, methodName, params, times);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
SchedulingRunnable that = (SchedulingRunnable) o;
if (params == null) {
return beanName.equals(that.beanName) &&
methodName.equals(that.methodName) &&
that.params == null;
}
return beanName.equals(that.beanName) &&
methodName.equals(that.methodName) &&
params.equals(that.params);
}
@Override
public int hashCode() {
if (params == null) {
return Objects.hash(beanName, methodName);
}
return Objects.hash(beanName, methodName, params);
}
}スケジュールされたタスクの登録クラス
スケジュールされたタスクの追加と削除に使用されます
@Component
public class CronTaskRegistrar implements DisposableBean {
private final Map<Runnable, ScheduledTask> scheduledTasks = new ConcurrentHashMap<>(16);
@Autowired
private TaskScheduler taskScheduler;
public TaskScheduler getScheduler() {
return this.taskScheduler;
}
public void addCronTask(Runnable task, String cronExpression) {
addCronTask(new CronTask(task, cronExpression));
}
public void addCronTask(CronTask cronTask) {
if (cronTask != null) {
Runnable task = cronTask.getRunnable();
if (this.scheduledTasks.containsKey(task)) {
removeCronTask(task);
}
this.scheduledTasks.put(task, scheduleCronTask(cronTask));
}
}
public void removeCronTask(Runnable task) {
ScheduledTask scheduledTask = this.scheduledTasks.remove(task);
if (scheduledTask != null)
scheduledTask.cancel();
}
public ScheduledTask scheduleCronTask(CronTask cronTask) {
ScheduledTask scheduledTask = new ScheduledTask();
scheduledTask.future = this.taskScheduler.schedule(cronTask.getRunnable(), cronTask.getTrigger());
return scheduledTask;
}
@Override
public void destroy() {
for (ScheduledTask task : this.scheduledTasks.values()) {
task.cancel();
}
this.scheduledTasks.clear();
}
}スケジュールされたタスクのサンプル クラス
@Slf4j
@Component("taskDemo")
public class Task1 {
public void taskByParams(String params) {
log.info("taskByParams执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("taskByParams执行有参示例任务：{}",params);
}
public void taskNoParams() {
log.info("taskByParams执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("taskNoParams执行无参示例任务");
}
public void test(String params) {
log.info("test执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("test执行有参示例任务：{}",params);
}
}データベース テーブルの設計
CREATE TABLE `schedule_setting` ( `job_id` int NOT NULL AUTO_INCREMENT COMMENT '任务ID', `bean_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT 'bean名称', `method_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '方法名称', `method_params` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '方法参数', `cron_expression` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT 'cron表达式', `remark` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '备注', `job_status` int DEFAULT NULL COMMENT '状态(1正常 0暂停)', `create_time` datetime DEFAULT NULL COMMENT '创建时间', `update_time` datetime DEFAULT NULL COMMENT '修改时间', PRIMARY KEY (`job_id`) ) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
Entity クラス
@Data
public class ScheduleSetting extends Model<ScheduleSetting> {
/**
* 任务ID
*/
@Id
private Integer jobId;
/**
* bean名称
*/
private String beanName;
/**
* 方法名称
*/
private String methodName;
/**
* 方法参数
*/
private String methodParams;
/**
* cron表达式
*/
private String cronExpression;
/**
* 状态（1正常 0暂停）
*/
private Integer jobStatus;
/**
* 备注
*/
private String remark;
/**
* 创建时间
*/
private Date createTime;
/**
* 更新时间
*/
private Date updateTime;
}スケジュールされたタスクのウォームアップ
Spring Boot プロジェクトが開始されたら、スケジュールされたタスクを通常のステータスでデータベースに読み込みます
@Service
public class SysJobRunner implements CommandLineRunner {
private static final Logger logger = LoggerFactory.getLogger(SysJobRunner.class);
@Autowired
private CronTaskRegistrar cronTaskRegistrar;
@Override
public void run(String... args) {
// 初始加载数据库里状态为正常的定时任务
ScheduleSetting existedSysJob = new ScheduleSetting();
List<ScheduleSetting> jobList = existedSysJob.selectList(new QueryWrapper<ScheduleSetting>().eq("job_status", 1));
if (CollectionUtils.isNotEmpty(jobList)) {
for (ScheduleSetting job : jobList) {
SchedulingRunnable task = new SchedulingRunnable(job.getBeanName(), job.getMethodName(), job.getMethodParams());
cronTaskRegistrar.addCronTask(task, job.getCronExpression());
}
logger.info("定时任务已加载完毕...");
}
}
}Tool クラス
Spring コンテナから Bean を取得するために使用されます
@Component
public class SpringContextUtils implements ApplicationContextAware {
private static ApplicationContext applicationContext;
@Override
public void setApplicationContext(ApplicationContext applicationContext)
throws BeansException {
SpringContextUtils.applicationContext = applicationContext;
}
public static Object getBean(String name) {
return applicationContext.getBean(name);
}
public static <T> T getBean(Class<T> requiredType) {
return applicationContext.getBean(requiredType);
}
public static <T> T getBean(String name, Class<T> requiredType) {
return applicationContext.getBean(name, requiredType);
}
public static boolean containsBean(String name) {
return applicationContext.containsBean(name);
}
public static boolean isSingleton(String name) {
return applicationContext.isSingleton(name);
}
public static Class<? extends Object> getType(String name) {
return applicationContext.getType(name);
}
}スケジュールされたタスク: add/delete/modify/start/pause
@RestController
public class TestController {
@Autowired
private CronTaskRegistrar cronTaskRegistrar;
/**
* 添加定时任务
*
* @param sysJob
* @return
*/
@PostMapping("add")
public boolean add(@RequestBody ScheduleSetting sysJob) {
sysJob.setCreateTime(new Date());
sysJob.setUpdateTime(new Date());
boolean insert = sysJob.insert();
if (!insert) {
return false;
}else {
if (sysJob.getJobStatus().equals(1)) {// 添加成功,并且状态是1，直接放入任务器
SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
}
}
return insert;
}
/**
* 修改定时任务
*
* @param sysJob
* @return
*/
@PostMapping("update")
public boolean update(@RequestBody ScheduleSetting sysJob) {
sysJob.setCreateTime(new Date());
sysJob.setUpdateTime(new Date());
// 查询修改前任务
ScheduleSetting existedSysJob = new ScheduleSetting();
existedSysJob = existedSysJob.selectOne(new QueryWrapper<ScheduleSetting>().eq("job_id", sysJob.getJobId()));
// 修改任务
boolean update = sysJob.update(new UpdateWrapper<ScheduleSetting>().eq("job_id", sysJob.getJobId()));
if (!update) {
return false;
} else {
// 修改成功,则先删除任务器中的任务,并重新添加
SchedulingRunnable task1 = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
cronTaskRegistrar.removeCronTask(task1);
if (sysJob.getJobStatus().equals(1)) {// 如果修改后的任务状态是1就加入任务器
SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
}
}
return update;
}
/**
* 删除任务
*
* @param jobId
* @return
*/
@PostMapping("del/{jobId}")
public boolean del(@PathVariable("jobId") Integer jobId) {
// 先查询要删除的任务信息
ScheduleSetting existedSysJob = new ScheduleSetting();
existedSysJob = existedSysJob.selectOne(new QueryWrapper<ScheduleSetting>().eq("job_id", jobId));
// 删除
boolean del = existedSysJob.delete(new QueryWrapper<ScheduleSetting>().eq("job_id", jobId));
if (!del)
return false;
else {// 删除成功时要清除定时任务器中的对应任务
SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
cronTaskRegistrar.removeCronTask(task);
}
return del;
}
// 停止/启动任务
@PostMapping("changesStatus/{jobId}/{stop}")
public boolean changesStatus(@PathVariable("jobId") Integer jobId, @PathVariable("stop") Integer stop) {
// 修改任务状态
ScheduleSetting scheduleSetting = new ScheduleSetting();
scheduleSetting.setJobStatus(stop);
boolean job_id = scheduleSetting.update(new UpdateWrapper<ScheduleSetting>().eq("job_id", jobId));
if (!job_id) {
return false;
}
// 查询修改后的任务信息
ScheduleSetting existedSysJob = new ScheduleSetting();
existedSysJob = existedSysJob.selectOne(new QueryWrapper<ScheduleSetting>().eq("job_id", jobId));
// 如果状态是1则添加任务
if (existedSysJob.getJobStatus().equals(1)) {
SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
cronTaskRegistrar.addCronTask(task, existedSysJob.getCronExpression());
} else {
// 否则清除任务
SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
cronTaskRegistrar.removeCronTask(task);
}
return true;
}
cron
cron 式の構文:
[秒] [分] [時間] [日] [月] [週] [年]
注: [年] は必須フィールドではありません。[年] を省略できます。その場合、フィールドは合計 6 つになります
# ワイルドカードの説明:
* はすべての値を表します。例: 分フィールドに * を設定すると、毎分トリガーされることを意味します。
? は値が指定されていないことを意味します。使用シナリオでは、このフィールドの現在の値を気にする必要はありません。例: 毎月 10 日に操作をトリガーしたいが、曜日は気にしないため、曜日の位置フィールドを「?」に設定する必要があります。具体的な設定は 0 です。 0 0 10 * ?
-
- は間隔を表します。たとえば、正時に「10-12」を設定すると、10 時、11 時、12 時にトリガーされることになります。
は、複数の値を指定することを意味します。たとえば、週フィールドに「MON,WED,FRI」を設定すると、月曜日、水曜日、金曜日にトリガーされることを意味します
-
/ はインクリメンタルトリガーに使用されます。秒数を「5/15」に設定すると、5 秒目から 15 秒ごと (5 秒目、20 秒目、35 秒目、50 秒目) にトリガーされます。日付フィールドに「1/3」を設定すると、毎月 1 日に開始され、3 日ごとにトリガーされます。
L は最後の意味を表します。日フィールドの設定では月の最終日を表し（現在の月に応じて、2 月の場合は閏年かどうかにも依存します）、週フィールドでは土曜日を表します。 「7」または「SAT」に相当します。 「L」の前に数字を付けると、最後のデータを意味します。たとえば、週フィールドに「6L」のような形式を設定すると、「今月の最後の金曜日」を意味します。
W は、指定された日付に最も近い営業日 (月曜日から金曜日) を意味します。たとえば、日フィールドに「15W」を設定すると、毎月 15 日に最も近い営業日にトリガーがトリガーされることを意味します。 15 日が土曜日の場合、トリガーは最も近い金曜日 (14 日) に検出されます。15 日が週末の場合、トリガーは最も近い月曜日 (16 日) に検出されます。営業日 (月曜日から日曜日) 5)、その日にトリガーされます。指定された形式が「1W」の場合、毎月 1 日以降の最も近い営業日にトリガーされることを意味します。 1 日が土曜日の場合は、3 日の月曜日にトリガーされます。 (「W」の前に特定の数値のみを設定でき、間隔「-」は使用できないことに注意してください)。
# シリアル番号（各月の曜日を示します）。たとえば、週フィールドに「6#3」を設定すると、各月の第 3 土曜日を示します。 「#5」を指定した場合、第 5 週に土曜日がない場合、この設定はトリガーされません (母の日と父の日に最適です); ヒント: 「L」と「W」は組み合わせて使用できます。日フィールドに「LW」が設定されている場合、今月の最終営業日にトリガーされることを意味します。英語の文字が使用されている場合、週フィールドの設定は大文字と小文字が区別されません。つまり、MON は同じです。モンとして。
例:
5 秒ごとに実行: */5 * * * * ?
5 秒ごとに実行1分: 0 */1 * * * ?
毎日23:00に1回実行: 0 0 23 * * ?
毎日1回午前1時に実行: 0 0 1 * * ?
毎月 1 日の午前 1 時に 1 回実行: 0 0 1 1 * ?
毎月末日の 23:00 に 1 回実行: 0 0 23 L * ?
毎週土曜日の午前 1 時に 1 回実行: 0 0 1 ? * L
26 分、29 分、33 分に 1 回実行: 0 26、29、33 * * * ?
毎日 1 回、0:00、13:00、18:00、21:00 に実行します: 0 0 0,13,18,21 * * ?
cron オンライン式ジェネレーター: http://tools.jb51.net/code/Quartz_Cron_create
以上がSpringBoot の動的スケジュールされたタスクを実装する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。
声明：
この記事はyisu.comで複製されています。侵害がある場合は、admin@php.cn までご連絡ください。