定时任务

Spring Task

以 Spring Boot 为例，实现定时任务只需两步：开启定时任务；添加定时任务。

一： 开启定时任务

开启定时任务只需要在 Spring Boot 的启动类上声明 @EnableScheduling 即可，代码如下：

@SpringBootApplication
@EnableScheduling // 开启定时任务
public class DemoApplication {
}

二：添加定时任务

定时任务的添加只需要使用@Scheduled 注解标注即可，如果有多个定时任务可以创建多个@Scheduled注解标注的方法，代码如下：

@Component
public class TaskJob {
    //cron 表达式，每周五 23:59:59 执行
    @Scheduled(cron = "59 59 23 0 0 5")  
    public void doTask(){
        System.out.println("我是定时任务~");
    }
}

注意：定时任务是自动触发的无需手动干预，也就是说SpringBoot启动后会自动加载并执行定时任务。

SpringTask的实现需要使用 cron 表达式来声明执行的频率和规则，cron 表达式是由 6 位或者 7 位组成的（最后一位可以省略），每位之间以空格分隔，每位从左到右代表的含义如下：

 其中 * 和 ? 号都表示匹配所有的时间。附加cron 表达式在线生成地址：https://cron.qqe2.com/

SpringBoot整合Quartz

Quartz的简介：

1.Quartz是一个开源的任务调度框架。基于定时、定期的策略来执行任务是它的核心功能，比如x年x月的每个星期五上午8点到9点，每隔10分钟执行1次。

2.Quartz有3个核心要素：调度器(Scheduler)、任务(Job)、触发器(Trigger)。

2.1.Job（任务）：是一个接口，有一个方法void execute()，可以通过实现该接口来定义需要执行的任务（具体的逻辑代码）。

2.2.JobDetail:Quartz每次执行job时，都重新创建一个Job实例，会接收一个Job实现类，以便运行的时候通过newInstance()的反射调用机制去实例化Job.JobDetail是用来描述Job实现类以及相关静态信息，比如任务在scheduler中的组名等信息。

2.3.Trigger（触发器）：描述触发Job执行的时间触发规则实现类SimpleTrigger和CronTrigger可以通过crom表达式定义出各种复杂的调度方案。

2.4.Calendar：是一些日历特定时间的集合。一个Trigger可以和多个 calendar关联,比如每周一早上10:00执行任务，法定假日不执行，则可以通过calendar进行定点排除。

2.5.Scheduler（调度器）：代表一个Quartz的独立运行容器。Trigger和JobDetail可以注册到Scheduler中。Scheduler可以将Trigger绑定到某一JobDetail上，这样当Trigger被触发时，对应的Job就会执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job.

项目结构及代码

 1.pom.xml

<!--spring boot集成quartz-->
<dependency>
　　<groupId>org.springframework.boot</groupId>
　　<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

2.DateTimeJob.java(具体的业务逻辑代码写在这里)

public class DateTimeJob extends QuartzJobBean {
 
    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        //获取JobDetail中关联的数据
        String msg = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("msg");
        System.out.println("current time :"+new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "---" + msg);
    }
}

3.QuartzConfig.java（配置类）

@Configuration
public class QuartzConfig {
    @Bean
    public JobDetail printTimeJobDetail(){
        return JobBuilder.newJob(DateTimeJob.class)//PrintTimeJob我们的业务类
                .withIdentity("DateTimeJob")//可以给该JobDetail起一个id
                //每个JobDetail内都有一个Map，包含了关联到这个Job的数据，在Job类中可以通过context获取
                .usingJobData("msg", "Hello Quartz")//关联键值对
                .storeDurably()//即使没有Trigger关联时，也不需要删除该JobDetail
                .build();
    }
    @Bean
    public Trigger printTimeJobTrigger() {
        CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/1 * * * * ?");
        return TriggerBuilder.newTrigger()
                .forJob(printTimeJobDetail())//关联上述的JobDetail
                .withIdentity("quartzTaskService")//给Trigger起个名字
                .withSchedule(cronScheduleBuilder)
                .build();
    }
}

4. 结果