浅谈在springboot中使用定时任务的方式
更新时间：2021年06月29日 14:38:32 作者：拍打醒
今天给大家带来的是关于Java的相关知识,文章围绕着在springboot中使用定时任务的方式展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
springboot定时任务
在springboot环境下有多种方法，这里记录下使用过的其中两种；1、使用注解，2、通过实现接口的方式。
使用注解的方式虽然比较简单，但是如果项目需要用户对定时周期进行修改操作，只使用注解就比较难实现。所以可以使用实现接口的方式。通过对接口的实现，可以在项目运行时根据需要修改任务执行周期，只需要关闭原任务再开启新任务即可。
1、使用注解方式
首先需要在启动类下添加 @EnableScheduling 注解（@EnableAsync是开启异步的注解）
package com.fongtech.cli;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
@SpringBootApplication
@MapperScan("com.fongtech.cli.mbg.*.**")
@EnableAsync
@EnableScheduling
public class SpringbootAdminApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootAdminApplication.class, args);
}
}
接着在需要用到定时任务的类和方法下加 @Component 和 @Scheduled(cron = "0 0/1 * * * ? ")注解，其中@Scheduled()中的 ‘cron' 有固定的格式。（@Async注解表示开启异步）
@Slf4j
@Component
public class AsyncTaskConfiguration {
/**
* 每分钟检查任务列表，判断任务类型执行相应的任务
* 根据实际任务执行情况，限定执行任务数量
*/
@Scheduled(cron = "0 0/1 * * * ? ")
@Async
public void startCommonTask() throws Exception {
log.info("startCommonTask start........." + Thread.currentThread().getName());
commonTaskService.startCommonTask();
log.info("startCommonTask end........." + Thread.currentThread().getName());
}}
2、使用实现接口的方式
通过实现 SchedulingConfigurer 接口，可对定时任务进行操作。实现接口的方式相比使用注解更加灵活，但需要编写代码，相对繁琐。
实现工具类如下：
package com.fongtech.cli.admin.tasktime;
import com.fongtech.cli.common.util.BeanUtils;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.SchedulingException;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.config.TriggerTask;
import org.springframework.scheduling.support.CronTrigger;
import javax.annotation.PostConstruct;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
/**
* @author linb
* @date 2020/6/15 11:16
*/
@Configuration
//@EnableScheduling
public class DefaultSchedulingConfigurer implements SchedulingConfigurer {
private ScheduledTaskRegistrar taskRegistrar;
private Set<ScheduledFuture<?>> scheduledFutures = null;
private Map<String, ScheduledFuture<?>> taskFutures = new ConcurrentHashMap<>();
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
this.taskRegistrar = taskRegistrar;
}
@SuppressWarnings("unchecked")
private Set<ScheduledFuture<?>> getScheduledFutures() {
if (scheduledFutures == null) {
try {
// spring版本不同选用不同字段scheduledFutures
scheduledFutures = (Set<ScheduledFuture<?>>) BeanUtils.getProperty(taskRegistrar, "scheduledTasks");
} catch (NoSuchFieldException e) {
throw new SchedulingException("not found scheduledFutures field.");
}
}
return scheduledFutures;
}
/**
* 添加任务
*/
public void addTriggerTask(String taskId, TriggerTask triggerTask) {
if (taskFutures.containsKey(taskId)) {
throw new SchedulingException("the taskId[" + taskId + "] was added.");
}
TaskScheduler scheduler = taskRegistrar.getScheduler();
ScheduledFuture<?> future = scheduler.schedule(triggerTask.getRunnable(), triggerTask.getTrigger());
getScheduledFutures().add(future);
taskFutures.put(taskId, future);
}
/**
* 取消任务
*/
public void cancelTriggerTask(String taskId) {
ScheduledFuture<?> future = taskFutures.get(taskId);
if (future != null) {
future.cancel(true);
}
taskFutures.remove(taskId);
getScheduledFutures().remove(future);
}
/**
* 重置任务
*/
public void resetTriggerTask(String taskId, TriggerTask triggerTask) {
cancelTriggerTask(taskId);
addTriggerTask(taskId, triggerTask);
}
/**
* 任务编号
*/
public Set<String> taskIds() {
return taskFutures.keySet();
}
/**
* 是否存在任务
*/
public boolean hasTask(String taskId) {
return this.taskFutures.containsKey(taskId);
}
/**
* 任务调度是否已经初始化完成
*/
public boolean inited() {
return this.taskRegistrar != null && this.taskRegistrar.getScheduler() != null;
}
}
在项目启动后就自动开启任务的操作类如下：
package com.fongtech.cli.admin.tasktime;
import com.fongtech.cli.admin.service.IAuthLoginService;
import com.fongtech.cli.admin.service.IBackupsService;
import com.fongtech.cli.admin.service.IDictionnaryEntryService;
import com.fongtech.cli.mbg.model.entity.AuthLogin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.scheduling.config.TriggerTask;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
/**
* 项目启动后执行，
*/
@Slf4j
@Component
@Order(value = 1)
public class CmdRunner implements CommandLineRunner {
@Autowired
private DefaultSchedulingConfigurer defaultSchedulingConfigurer;
@Autowired
private IDictionnaryEntryService dictionnaryEntryService;
@Autowired
private IBackupsService backupsService;
@Autowired
private IAuthLoginService authLoginService;
@Override
public void run(String... args) throws Exception {
log.info("------按照预设备份周期启动数据库备份定时任务");
while (!defaultSchedulingConfigurer.inited())
{
try {
Thread.sleep(100);
} catch (InterruptedException e) {
e.printStackTrace();
} finally {
}
}
String cron = dictionnaryEntryService.getEntryValueByName("CRON_VALUE");
//默认按照管理员用户权限执行备份任务
AuthLogin authLogin = authLoginService.query().eq(AuthLogin::getLogin_user, "admin").getOne();
//启动线程，按照原表内的时间执行备份任务
defaultSchedulingConfigurer.addTriggerTask("task",
new TriggerTask(
() -> System.out.println("=====----------启动定时任务=-----------");,
new CronTrigger(cron)));
}
}
暂停定时任务：
defaultSchedulingConfigurer.cancelTriggerTask("task");
到此这篇关于浅谈在springboot中使用定时任务的方式的文章就介绍到这了,更多相关springboot定时任务内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
在Maven中,依赖排除是一种常见的技术,用于从项目的依赖中排除特定的传递性依赖,这通常用于解决依赖冲突或避免引入不需要的库,以下是如何在Maven中使用依赖排除的详细步骤,包括代码示例,需要的朋友可以参考下2024-11-11
虽然java8出来很久了，但是之前用的一直也不多，最近正好学习了java8。下面给大家分享java8中的foreach循环，感兴趣的朋友一起看看吧2017-05-05
这篇文章主要介绍了java加密算法，包括rsa解密、对称加密、md5加密等,需要的朋友可以参考下2014-05-05
java多线程并发executorservice(任务调度)类
这篇文章主要介绍了线程并发ScheduledExecutorService类，设置 ScheduledExecutorService ，2秒后，在 1 分钟内每 10 秒钟蜂鸣一次2014-01-01
文章介绍了如何在SpringBoot项目中使用Logback实现日志打印,并通过自定义日志打印工具类和日志分文件打印来提高日志排查和监控的效率2024-12-12
Spring ApplicationContext接口功能详细介绍
ApplicationContext是Spring应用程序中的中央接口，由于继承了多个组件，使得ApplicationContext拥有了许多Spring的核心功能，如获取bean组件，注册监听事件，加载资源文件等2023-02-02
这篇文章主要介绍了Java使用Tesseract-Ocr识别数字的方法，帮助大家更好的理解和学习使用Java，感兴趣的朋友可以了解下2021-04-04
这篇文章主要给大家介绍了关于java读取zip/jar包中文件的几种方式,在我们日常使用中压缩文件是非常常用的,文中通过示例代码将java读取zip/jar包中文件的方法介绍的非常详细,需要的朋友可以参考下2023-07-07
IDEA的每一个方面都是为了最大限度地提高开发人员的工作效率而设计的,它的智能编码辅助和人机工程学设计会让开发过程变得愉悦且高效，今天给大家分享新手小白学JAVA IDEA下载使用手册全集，对idea新手使用相关知识感兴趣的朋友跟随小编一起学习吧2021-05-05
在本篇文章中我们给大家分享的是一篇关于java压缩文件乱码问题的解决办法，有需要的朋友们可以学习下。2019-12-12
最新评论