Java-springboot使用注解实现定时器任务

本文介绍如何使用SpringBoot轻松实现定时任务,通过@EnableScheduling和@Scheduled注解设置定时器开关和执行时间,提供了两种实现方式并详细解释了cron表达式的使用。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

使用springboot解决定时任务非常简单,只需要几个注解就能实现。

1.@EnableScheduling (设置定时器开关启动)
2.@Scheduled(cron = “0 0 0 * * ?”) (设置定时启动时间)
3.@Configuration (表明该类是一个配置类)

springboot使用注解设置定时器的用法大致相同,一种是将定时器开关加在了启动类上,第二种是将开关加在一个类上,然后将此类声明成配置文件。

方法一:

(1)直接在springboot启动类上添加注解 @EnableScheduling 开启定时器总开关。

@EnableScheduling
@SpringBootApplication
public class DouDouApplication extends SpringBootServletInitializer
{
    public static void main(String[] args)
    {
        SpringApplication.run(DouDouApplication.class, args);
    }
}

(2)给要执行的方法上添加注解 @Scheduled(cron = “0 0 0 * * ?”) ,cron 参数是设置执行时间。

下面设定了一个定时任务,每5秒在控制台显示一次当前时间。
注意:这里是我自己新建的一个定时器类,为了让spring扫描到这个定时器类,所以要在该类上加上一个注解 @Component

@Component
public class TaskTimer {

	@Scheduled(cron = "0/5 * * * * ?")
    public void myTimes(){
        SimpleDateFormat dateFormat1 = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println(dateFormat1.format(new Date()));
    }
    
}

启动项目后,控制台便会出现已经启动的定时任务信息,如下:
控制台

方法二:

直接在定时器类上添加注解 @Configuration@EnableScheduling,表示这个类是配置文件并且同时开启定时开关,但项目运行时扫描这个配置文件便会自动启动定时任务。(注意:这里就不需要在该类上添加注解 @Component,因为已经有了 @Configuration 注解)

记得也要给要执行的定时方法上添加注解 @Scheduled(cron = “0 0 0 * * ?”)

@EnableScheduling
@Configuration
public class TaskTimer {

	@Scheduled(cron = "0/5 * * * * ?")
    public void myTimes(){
        SimpleDateFormat dateFormat1 = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println(dateFormat1.format(new Date()));
    }
    
}

cron表达式详解

cron表达式有至少6个(也可能7个)有空格分隔的时间元素。

格式: cron = [ 秒 ] [ 分钟 ] [ 小时 ] [ 日 ] [ 月 ] [ 周(星期)] [ 年份 ]

序号元素通配符
10-59- * /
2分钟0-59- * /
3小时0-23- * /
41-31- * ? / L W
51-12 or JAN-DEC,- * /
6周(星期)1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT,- * ? / L #
7年份1970-2099,- * /

通配符详解

序号通配符备注
1*表示所有值,如:秒的位置上是 * ,则代表每一秒都会执行
2?表示不指定值,如:年的位置上是 ?,则代表不知道某一年
3-表示区间,如:小时的位是1-2,代表小时为1,2都会执行
4,表示指定多个值,如:小时为1,2,3时都会运行
5L表示最后的意思,如:分钟是L代表每一小时最后一分钟都会运行
6W表示离指定日期的最近那个工作日,如:10W代表离10号最近的一个工作日运行
7#表示第几个,如:2#3 代表二月的第三周执行

下面是常见的 corn 表达式:

表达式备注
*/5 * * * * ?每隔5秒执行一次
0 */1 * * * ?每隔1分钟执行一次
0 0 23 * * ?每天23点执行一次
0 0 1 1 * ?每月1号凌晨1点执行一次
0 0 23 L * ?每月最后一天23点执行一次
0 0 1 ? * L每周星期天凌晨1点执行一次
0 15,25,35 * * * ?在15分、25分、35分执行一次
0 * 16 * * ?每天下午16点钟开始到16点59分结束这么一个时间段
0 0/5 16 * * ?每天下午16点到16点55分之间每5分钟触发一次
0 0/5 14,18 * * ?每天下午14点到14点55分 和18点到18点55分之间 每5分钟触发一次
0 0-5 14 * * ?每天下午14点开始到14点05结束
0 10,44 14 ? 3 WED每年三月份的每个周三下午14点10分和14点44各一次
0 15 10 ? * MON-FRI每个工作日的10点15分
0 15 10 15 * ?每个月15号的上午10点15分
0 15 10 L * ?每个月最后一天的10点15分
0 15 10 ? * 6L每个月最后一个周五的10点15分
0 15 10 ? * 6L 2002-20052002年到2005年每个月最后一个周五的10点15分
0 15 10 ? * 6#3每个月的第三个周五的10点15分
0 0 12 1/5 * ?每个月从第一天开始每隔5天中午12点触发一次
0 11 11 11 11 ?每年11月11号11点11分
0 0 0,13,18,21 * * ?每天的0点、13点、18点、21点都执行一次
0 0/30 9-17 * * ?朝九晚五工作时间内每半小时
0 0 12 * * ?每天中午12点触发
0 15 10 ? * *每天上午10:15触发
0 0 23 * * ?每天
0 59 23 ? * SUN每周
0 59 23 L * ?每月
0 59 23 L 3,6,9,12 ?每季度
0 0 0 31 12 ?每年

在线 cron 表达式生成工具:https://qqe2.com/cron/index

A:实现定时器任务管理可以使用Spring Boot提供的定时任务(@Scheduled)和Mybatis-Plus提供的定时任务表(定时器任务表在Mybatis-Plus 3.1.1版本及以上已支持,使用Mybatis-Plus官方提供的SQL脚本创建定时器任务表)。 1. 首先,在项目中引入Mybatis-Plus和定时任务依赖。 ```xml <!-- Mybatis-Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>{mybatis-plus.version}</version> </dependency> <!-- 定时任务 --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>{spring.version}</version> </dependency> ``` 2. 创建定时器任务表。 可以直接在数据库中执行Mybatis-Plus官方提供的SQL脚本,创建定时器任务表(或者在Mybatis-Plus 3.1.1版本之后,通过注解方式自动创建)。 ```sql CREATE TABLE `tb_task` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID', `task_group` varchar(50) NOT NULL COMMENT '任务组', `task_name` varchar(50) NOT NULL COMMENT '任务名称', `task_cron` varchar(50) NOT NULL COMMENT '任务执行cron表达式', `task_class` varchar(500) NOT NULL COMMENT '任务具体执行类', `task_method` varchar(50) NOT NULL COMMENT '任务具体执行方法', `task_data` varchar(500) DEFAULT NULL COMMENT '任务执行参数', `task_status` tinyint(1) NOT NULL DEFAULT '0' COMMENT '任务状态(0:停止,1:运行)', `create_time` datetime NOT NULL COMMENT '创建时间', `update_time` datetime NOT NULL COMMENT '更新时间', `remark` varchar(500) DEFAULT NULL COMMENT '备注', PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='定时任务表'; ``` 3. 创建定时器任务实体类。 ```java @Data @TableName("tb_task") public class Task extends BaseEntity { /** * 任务组(用于区分不同业务) */ private String taskGroup; /** * 任务名称 */ private String taskName; /** * 任务执行cron表达式 */ private String taskCron; /** * 任务具体执行类 */ private String taskClass; /** * 任务具体执行方法 */ private String taskMethod; /** * 任务执行参数 */ private String taskData; /** * 任务状态(0:停止,1:运行) */ private Integer taskStatus; /** * 备注 */ private String remark; } ``` 4. 创建定时器任务管理接口和实现类。 ```java public interface TaskService extends IService<Task> { /** * 执行定时任务 */ void runTask(Task task); /** * 根据任务组和任务名称获取任务 */ Task getTaskByGroupAndName(String taskGroup, String taskName); /** * 更新任务状态 */ boolean updateTaskStatus(Long id, Integer taskStatus); } @Service public class TaskServiceImpl extends ServiceImpl<TaskMapper, Task> implements TaskService { @Autowired private ApplicationContext applicationContext; @Override public void runTask(Task task) { try { // 获取任务类 Object taskObj = applicationContext.getBean(task.getTaskClass()); if (null == taskObj) { throw new RuntimeException("No such task class found!"); } // 获取任务方法 Method method = taskObj.getClass().getMethod(task.getTaskMethod(), String.class); // 执行任务方法 method.invoke(taskObj, task.getTaskData()); } catch (Exception e) { throw new RuntimeException(e.getMessage(), e); } } @Override public Task getTaskByGroupAndName(String taskGroup, String taskName) { QueryWrapper<Task> wrapper = new QueryWrapper<>(); wrapper.eq("task_group", taskGroup) .eq("task_name", taskName); return baseMapper.selectOne(wrapper); } @Override public boolean updateTaskStatus(Long id, Integer taskStatus) { Task task = new Task(); task.setId(id); task.setTaskStatus(taskStatus); return updateById(task); } } ``` 5. 配置定时任务。 ```java @Configuration @EnableScheduling public class TaskConfig { @Autowired private TaskService taskService; @Autowired private ThreadPoolTaskScheduler taskScheduler; @Scheduled(fixedRate = 5000) // 每隔5000ms执行一次 public void runTask() { // 获取需要执行的任务列表 List<Task> taskList = taskService.list(new QueryWrapper<Task>().eq("task_status", 1)); if (CollectionUtils.isEmpty(taskList)) { return; } // 执行任务 for (Task task : taskList) { taskScheduler.schedule(new TaskRunnable(taskService, task), new CronTrigger(task.getTaskCron())); } } /** * 定时器任务运行线程 */ public static class TaskRunnable implements Runnable { private TaskService taskService; private Task task; public TaskRunnable(TaskService taskService, Task task) { this.taskService = taskService; this.task = task; } @Override public void run() { // 执行任务 taskService.runTask(task); // 更新任务状态 taskService.updateTaskStatus(task.getId(), 1); } } } ``` 6. 启动项目,添加定时器任务,等待定时任务执行。 以上就是基于Mybatis-Plus实现定时器任务管理的过程,希望对你有所帮助。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值