springboot---定时任务实现

1. scheduled注解实现

1.1. 用法

任意类中创建一个方法,将该方法用@scheduled注解修饰,然后在项目的主方法上添加@EnableScheduling注解,定时任务就会生效。
但是需要注意的是定时任务不会一开始就执行,会等待设定的时间

1.2. 参数详解

1.2.1. cron

cron表达式是一个字符串,字符串以5或6个空格隔开,分开共6或7个域,每一个域代表一个含义。
cron表达式语法:[秒] [分] [时] [日] [月] [周] [年]
注:[年]不是必须的域,可以省略[年],则一共6个域
在这里插入图片描述

通配符说明

  1. *表示所有值。 例如:在分的字段上设置 *,表示每一分钟都会触发。

  2. ? 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作,但不关心是周几,所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?

  3. -表示区间。例如 在小时上设置 “10-12”,表示 10,11,12点都会触发。

  4. , 表示指定多个值,例如在周字段上设置 “MON,WED,FRI” 表示周一,周三和周五触发

  5. / 用于递增触发。如在秒上面设置”5/15” 表示从5秒开始,每增15秒触发(5,20,35,50)。 在日字段上设置’1/3’所示每月1号开始,每隔三天触发一次。

  6. L 表示最后的意思。在日字段设置上,表示当月的最后一天(依据当前月份,如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六,相当于”7”或”SAT”。如果在”L”前加上数字,则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”

  7. W 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”,表示离每月15号最近的那个工作日触发。如果15号正好是周六,则找最近的周五(14号)触发, 如果15号是周未,则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五),则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六,则将在3号下周一触发。(注,”W”前只能设置具体的数字,不允许区间”-“)。

  8. #序号(表示每月的第几个周几),例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六,则不会触发该配置(用在母亲节和父亲节再合适不过了) ;小提示:’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发;周字段的设置,若使用英文字母是不区分大小写的,即MON与mon相同。

1.2.2. zone

时区,接收一个java.util.TimeZone#ID。cron表达式会基于该时区解析。默认是一个空字符串,即取服务器所在地的时区。比如我们一般使用的时区Asia/Shanghai。该字段我们一般留空。

1.2.3. fixedDelay

上一次执行完毕时间点之后多长时间再执行。如:

@Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行

1.2.4. fixedDelayString

与 fixedDelay 意思相同,只是使用字符串的形式。唯一不同的是支持占位符。如:

@Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行

占位符的使用(配置文件中有配置:time.fixedDelay=5000):

@Scheduled(fixedDelayString = "${time.fixedDelay}")
void testFixedDelayString() {
    System.out.println("Execute at " + System.currentTimeMillis());
}

运行结果:
在这里插入图片描述

1.2.5. fixedRate

上一次开始执行时间点之后多长时间再执行。如:

@Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行

1.2.6. fixedRateString

与 fixedRate 意思相同,只是使用字符串的形式。唯一不同的是支持占位符。

1.2.7. initialDelay

第一次延迟多长时间后再执行。如:

@Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次

1.2.8. initialDelayString

与 initialDelayString 意思相同,只是使用字符串的形式。唯一不同的是支持占位符。

1.3. 示例

每隔5秒执行一次:*/5 * * * * ?

每隔1分钟执行一次:0 */1 * * * ?

每天23点执行一次:0 0 23 * * ?

每天凌晨1点执行一次:0 0 1 * * ?

每月1号凌晨1点执行一次:0 0 1 1 * ?

每月最后一天23点执行一次:0 0 23 L * ?

每周星期天凌晨1点实行一次:0 0 1 ? * L

在26分、29分、33分执行一次:0 26,29,33 * * * ?

每天的0点、13点、18点、21点都执行一次:0 0 0,13,18,21 * * ?

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
SpringBoot是一个非常流行的Java Web框架,而mybatis-plus是一个非常强大的ORM框架,两者合起来可以实现非常好用的定时任务管理。 下面是基于SpringBoot和mybatis-plus实现定时任务管理的步骤: 1. 添加依赖 在pom.xml文件中添加以下依赖: ```xml <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.3.1</version> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.4.3.1</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-quartz</artifactId> </dependency> </dependencies> ``` 2. 配置数据库 在application.properties文件中添加以下配置: ``` # 数据库配置 spring.datasource.url=jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf-8&useSSL=false spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.jdbc.Driver # mybatis-plus配置 mybatis-plus.mapper-locations=classpath:/mapper/*.xml # Quartz配置 org.quartz.scheduler.instanceName = QuartzScheduler org.quartz.scheduler.instanceId = AUTO org.quartz.threadPool.threadCount=10 org.quartz.jobStore.class=org.quartz.impl.jdbcjobstore.JobStoreTX org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate org.quartz.jobStore.dataSource=myDS org.quartz.jobStore.tablePrefix=QRTZ_ org.quartz.dataSource.myDS.driver=com.mysql.jdbc.Driver org.quartz.dataSource.myDS.URL=jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf-8&useSSL=false org.quartz.dataSource.myDS.user=root org.quartz.dataSource.myDS.password=123456 org.quartz.dataSource.myDS.maxConnections=5 ``` 3. 创建实体类和Mapper 创建一个定时任务的实体类,并在其中定义定时任务的属性: ```java @Data public class JobEntity { /** * 任务ID */ private String jobId; /** * 任务名称 */ private String jobName; /** * 任务分组 */ private String jobGroup; /** * 任务执行类 */ private String jobClass; /** * 任务描述 */ private String jobDescription; /** * 任务状态 0禁用 1启用 */ private Integer jobStatus; /** * 任务表达式 */ private String jobExpression; /** * 创建时间 */ private Date createTime; /** * 修改时间 */ private Date modifyTime; } ``` 创建一个定时任务的Mapper,并继承mybatis-plus的BaseMapper: ```java @Repository public interface JobMapper extends BaseMapper<JobEntity> { } ``` 4. 创建定时任务工具类 创建一个定时任务的工具类,用于实现定时任务的添加、删除、暂停和恢复等操作: ```java @Service public class QuartzService { @Autowired private Scheduler scheduler; /** * 添加任务 * * @param jobEntity */ public void addJob(JobEntity jobEntity) throws SchedulerException, ClassNotFoundException { // 获取任务类 Class<? extends Job> jobClass = (Class<? extends Job>) Class.forName(jobEntity.getJobClass()); // 创建任务 JobDetail jobDetail = JobBuilder.newJob(jobClass) .withIdentity(jobEntity.getJobName(), jobEntity.getJobGroup()) .withDescription(jobEntity.getJobDescription()) .storeDurably(true) .build(); // 创建触发器 Trigger trigger = TriggerBuilder.newTrigger() .withIdentity(jobEntity.getJobName(), jobEntity.getJobGroup()) .withSchedule(CronScheduleBuilder.cronSchedule(jobEntity.getJobExpression())) .build(); // 将任务和触发器添加到调度器 scheduler.scheduleJob(jobDetail, trigger); } /** * 删除任务 * * @param jobId * @param jobGroup */ public void deleteJob(String jobId, String jobGroup) throws SchedulerException { JobKey jobKey = new JobKey(jobId, jobGroup); scheduler.deleteJob(jobKey); } /** * 暂停任务 * * @param jobId * @param jobGroup */ public void pauseJob(String jobId, String jobGroup) throws SchedulerException { JobKey jobKey = new JobKey(jobId, jobGroup); scheduler.pauseJob(jobKey); } /** * 恢复任务 * * @param jobId * @param jobGroup */ public void resumeJob(String jobId, String jobGroup) throws SchedulerException { JobKey jobKey = new JobKey(jobId, jobGroup); scheduler.resumeJob(jobKey); } } ``` 5. 创建定时任务控制器 创建一个定时任务的控制器,用于实现定时任务的增删改查等操作: ```java @RestController @RequestMapping("/job") public class JobController { @Autowired private JobMapper jobMapper; @Autowired private QuartzService quartzService; /** * 添加任务 * * @param jobEntity */ @PostMapping("/add") public void addJob(@RequestBody JobEntity jobEntity) throws SchedulerException { // 添加任务 quartzService.addJob(jobEntity); // 保存任务到数据库 jobMapper.insert(jobEntity); } /** * 删除任务 * * @param jobId * @param jobGroup */ @DeleteMapping("/delete") public void deleteJob(String jobId, String jobGroup) throws SchedulerException { // 删除任务 quartzService.deleteJob(jobId, jobGroup); // 从数据库中删除任务 QueryWrapper<JobEntity> queryWrapper = new QueryWrapper<>(); queryWrapper.eq("job_id", jobId); queryWrapper.eq("job_group", jobGroup); jobMapper.delete(queryWrapper); } /** * 暂停任务 * * @param jobId * @param jobGroup */ @PutMapping("/pause") public void pauseJob(String jobId, String jobGroup) throws SchedulerException { // 暂停任务 quartzService.pauseJob(jobId, jobGroup); // 更新任务状态 JobEntity jobEntity = new JobEntity(); jobEntity.setJobId(jobId); jobEntity.setJobGroup(jobGroup); jobEntity.setJobStatus(0); jobMapper.updateById(jobEntity); } /** * 恢复任务 * * @param jobId * @param jobGroup */ @PutMapping("/resume") public void resumeJob(String jobId, String jobGroup) throws SchedulerException { // 恢复任务 quartzService.resumeJob(jobId, jobGroup); // 更新任务状态 JobEntity jobEntity = new JobEntity(); jobEntity.setJobId(jobId); jobEntity.setJobGroup(jobGroup); jobEntity.setJobStatus(1); jobMapper.updateById(jobEntity); } /** * 获取任务列表 * * @return */ @GetMapping("/list") public List<JobEntity> listJob() { return jobMapper.selectList(null); } } ``` 至此,基于SpringBoot和mybatis-plus实现定时任务管理的步骤就完成了。我们可以通过访问控制器提供的接口来实现定时任务的添加、删除、暂停和恢复等操作。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

lipviolet

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值