Spring定时任务实现方法

---

---

前言

我们了解到xxl-job是一个轻量级分布式任务调度平台，可以作为调度中心来使用，当然它也是一个独立的springboot服务，如果我们有大量的调度任务可以考虑引入；今天我们要讨论的是假设我的java项目中就只有个别业务场景需要简单使用一下定时任务，这个时候引入xxl-job就有点太重了，我们使用spring定义的Scheduled注解以及使用配置类实现SchedulingConfigurer接口来实现定时任务。

---

一、使用@Scheduled注解

1.在Spring配置类上添加@EnableScheduling注解来启用定时任务；
2.使用@Component注解，表示将此类标记为Spring容器中的一个Bean；
3.创建定时任务方法，并使用@Scheduled注解来指定任务的执行计划。
demo代码如下：

package com.aaa.sasacdataboard.config;

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

/**
 * @Author：
 * @Date：2024/8/16 9:59
 */
@EnableScheduling
//@Component
public class ScheduledTasks {
    //1.上一个任务结束到下一个任务开始的时间间隔为固定的3秒，任务的执行总是要先等到上一个任务的执行结束
    @Scheduled(fixedDelay = 3000)
    public void printCurrentTimeByDelay() {
        System.out.println("前后两个任务间隔3s打印一下当前时间：" + System.currentTimeMillis());
    }
    @Scheduled(fixedDelayString = "${fixedDelay.in.milliseconds:10000}")
    public void outputCurrentTimeByDelay() {
        System.out.println("前后两个任务按配置的时间间隔输出当前时间：" + System.currentTimeMillis());
    }

    //2.每间隔3秒钟就执行任务一次
    @Scheduled(fixedRate = 3000)
    public void printCurrentTimeByRate() {
        System.out.println("每间隔3秒钟打印一下当前时间：" + System.currentTimeMillis());
    }

    //3.前后两个任务间隔3s,任务延迟2秒钟后再启动
    @Scheduled(fixedDelay = 3000, initialDelay = 2000)
    public void printCurrentTimeByInitialDelay() {
        System.out.println("前后两个任务间隔3s,任务延迟2秒钟后再启动,打印一下当前时间：" + System.currentTimeMillis());
    }

    //4.配置cron表达式
    @Scheduled(cron = "*/10 * * * * ?")
    public void printCurrentTimeByCron() {
        System.out.println("根据corn表达式每10s执行一次,打印一下当前时间：" + System.currentTimeMillis());
    }

}

启动服务，效果如下：

其中，@Scheduled(fixedDelayString = “${fixedDelay.in.milliseconds:10000}”)是把执行间隔时间配置到yml配置文件，方便修改；fixedDelay 和fixedRate 参数的默认单位是毫秒；cron 参数需要正确配置cron表达式，cron表达式介绍见文末。

二、实现SchedulingConfigurer接口

1.实现SchedulingConfigurer接口。
2.重写configureTasks方法，在其中定义定时任务。
demo代码如下：

package com.aaa.sasacdataboard.config;

import com.digitalgd.sasacdataboard.controller.TestController;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import javax.annotation.Resource;
import java.util.concurrent.Executor;
import static java.util.concurrent.Executors.newScheduledThreadPool;

/**
 * @Author：
 * @Date：2024/8/16 14:21
 */
@Configuration
public class SchedulerConfig implements SchedulingConfigurer {
    @Resource
    TestController testController;
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        //使用定长线程池,设置10个线程
        Executor executor = newScheduledThreadPool(10);
        taskRegistrar.setScheduler(executor);
        taskRegistrar.addTriggerTask(
                // 定义执行任务内容,调用需要执行的业务方法(调用加解密方法)
                () -> testController.encry("123456"),
                // 定义执行周期（每10秒执行一次）
                triggerContext -> new CronTrigger("0/10 * * * * ?").nextExecutionTime(triggerContext)
        );
        System.out.println("使用SchedulingConfigurer运行定时任务：" + System.currentTimeMillis());
    }
}

启动服务后效果：

---

三、Cron表达式

1.Cron表达式工具类目前支持三种常用的cron表达式 ：

• 1.每天的某个时间点执行 例:12 12 12 * * *?表示每天12时12分12秒执行
• 2.每周的哪几天执行 例:12 12 12 ? * 1,2,3表示每周的周1周2周3,12时12分12秒执行
• 3.每月的哪几天执行 例:12 12 12 1,21,13 * ? 表示每月的1号21号13号12时12分12秒执行

2.Cron有如下两种语法格式：

（1）Seconds Minutes Hours DayofMonth Month DayofWeek Year
（2）Seconds Minutes Hours DayofMonth Month DayofWeek

3.字符含义：

（1）：表示匹配该域的任意值。假如在Minutes域使用, 即表示每分钟都会触发事件。
（2）?：只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值，但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度，不管20日到底是星期几，则只能使用如下写法： 13 13 15 20 * ?, 其中最后一位只能用？，而不能使用*，如果使用*表示不管星期几都会触发，实际上并不是这样。
（3）-：表示范围。例如在Minutes域使用5-20，表示从5分到20分钟每分钟触发一次
（4）/：表示起始时间开始触发，然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次，而25，45等分别触发一次.
（5）,：表示列出枚举值。例如：在Minutes域使用5,20，则意味着在5和20分每分钟触发一次。
（6）L：表示最后，只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。
（7）W:表示有效工作日(周一到周五),只能出现在DayofMonth域，系统将在离指定日期的最近的有效工作日触发事件。例如：在 DayofMonth使用5W，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日(周一)触发；如果5日在星期一到星期五中的一天，则就在5日触发。另外一点，W的最近寻找不会跨过月份 。
（8）LW:这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。
（9）#:用于确定每个月第几个星期几，只能出现在DayofMonth域。例如在4#2，表示某月的第二个星期三。
星期数值枚举如下
public final static int SUNDAY = 1;
public final static int MONDAY = 2;
public final static int TUESDAY = 3;
public final static int WEDNESDAY = 4;
public final static int THURSDAY = 5;
public final static int FRIDAY = 6;
public final static int SATURDAY = 7;

4.常用表达式例子：

（1）0 0 2 1 * ? * 表示在每月的1日的凌晨2点调整任务
（2）0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业
（3）0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作　
（4）0 0 10,14,16 * * ? 每天上午10点，下午2点，4点
（5）0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时
（6）0 0 12 ? * WED 表示每个星期三中午12点
（7）0 0 12 * * ? 每天中午12点触发
（8）0 15 10 ? * * 每天上午10:15触发
（9）0 15 10 * * ? 每天上午10:15触发
（10）0 15 10 * * ? * 每天上午10:15触发
（11）0 15 10 * * ? 2005 2005年的每天上午10:15触发
（12）0 * 14 * * ? 在每天下午2点到下午2:59期间的每1分钟触发
（13）0 0/5 14 * * ? 在每天下午2点到下午2:55期间的每5分钟触发
（14）0 0/5 14,18 * * ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
（15）0 0-5 14 * * ? 在每天下午2点到下午2:05期间的每1分钟触发
（16）0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发
（17）0 15 10 ? * MON-FRI 周一至周五的上午10:15触发
（18）0 15 10 15 * ? 每月15日上午10:15触发
（19）0 15 10 L * ? 每月最后一日的上午10:15触发
（20）0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发
（21）0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发
（22）0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发

总结

以上就是今天要讲的内容，本文仅仅简单介绍了spring实现定时任务的两种方式，xxl-job定时调度平台有机会再讨论。