千家信息网

如何实现一个Spring定时任务

发表于:2024-11-27 作者:千家信息网编辑
千家信息网最后更新 2024年11月27日,今天就跟大家聊聊有关如何实现一个Spring定时任务,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。从实现的技术上来分类,目前主要有三种技术(或
千家信息网最后更新 2024年11月27日如何实现一个Spring定时任务

今天就跟大家聊聊有关如何实现一个Spring定时任务,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。

从实现的技术上来分类,目前主要有三种技术(或者说有三种产品):

  1. Java自带的java.util.Timer类,这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行,但不能在指定时间运行。一般用的较少,这篇文章将不做详细介绍。

  2. 使用Quartz,这是一个功能比较强大的的调度器,可以让你的程序在指定时间执行,也可以按照某一个频度执行,配置起来稍显复杂,稍后会详细介绍。

  3. Spring3.0以后自带的task,可以将它看成一个轻量级的Quartz,而且使用起来比Quartz简单许多,稍后会介绍。

从作业类的继承方式来讲,可以分为两类:

  1. 作业类需要继承自特定的作业类基类,如Quartz中需要继承自org.springframework.scheduling.quartz.QuartzJobBean;java.util.Timer中需要继承自java.util.TimerTask。

  2. 作业类即普通的java类,不需要继承自任何基类。

注:个人推荐使用第二种方式,因为这样所以的类都是普通类,不需要事先区别对待。

从任务调度的触发时机来分,这里主要是针对作业使用的触发器,主要有以下两种:

  1. 每隔指定时间则触发一次,在Quartz中对应的触发器为:org.springframework.scheduling.quartz.SimpleTriggerBean

  2. 每到指定时间则触发一次,在Quartz中对应的调度器为:org.springframework.scheduling.quartz.CronTriggerBean

注:并非每种任务都可以使用这两种触发器,如java.util.TimerTask任务就只能使用第一种。Quartz和spring task都可以支持这两种触发条件。

二.用法说明

详细介绍每种任务调度工具的使用方式,包括Quartz和spring task两种。

Quartz

第一种,作业类继承自特定的基类:org.springframework.scheduling.quartz.QuartzJobBean。

第一步:定义作业类

Java代码

import org.quartz.JobExecutionContext;  import org.quartz.JobExecutionException;  import org.springframework.scheduling.quartz.QuartzJobBean;  publicclass Job1 extends QuartzJobBean {  privateint timeout;  privatestaticint i = 0;  //调度工厂实例化后,经过timeout时间开始执行调度publicvoid setTimeout(int timeout) {  this.timeout = timeout;  }  /*** 要调度的具体任务*/@Overrideprotectedvoid executeInternal(JobExecutionContext context)  throws JobExecutionException {    System.out.println("定时任务执行中…");  }  }
第二步:spring配置文件中配置作业类JobDetailBean

Xml代码

说明:org.springframework.scheduling.quartz.JobDetailBean有两个属性,jobClass属性即我们在java代码中定义的任务类,jobDataAsMap属性即该任务类中需要注入的属性值。

第三步:配置作业调度的触发方式(触发器)

Quartz的作业触发器有两种,分别是

  • org.springframework.scheduling.quartz.SimpleTriggerBean

  • org.springframework.scheduling.quartz.CronTriggerBean

第一种SimpleTriggerBean,只支持按照一定频度调用任务,如每隔30分钟运行一次。

配置方式如下:

Xml代码

第二种CronTriggerBean,支持到指定时间运行一次,如每天12:00运行一次等。

配置方式如下:

Xml代码

>

关于cronExpression表达式的语法参见附录。

第四步:配置调度工厂

Xml代码

说明:该参数指定的就是之前配置的触发器的名字。

第五步:启动你的应用即可,即将工程部署至tomcat或其他容器。

第二种,作业类不继承特定基类。

Spring能够支持这种方式,归功于两个类:

  • org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean

  • org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

这两个类分别对应spring支持的两种实现任务调度的方式,即前文提到到java自带的timer task方式和Quartz方式。这里我只写MethodInvokingJobDetailFactoryBean的用法,使用该类的好处是,我们的任务类不再需要继承自任何类,而是普通的pojo。

第一步:编写任务类

Java代码

publicclass Job2 {  publicvoid doJob2() {  System.out.println("不继承QuartzJobBean方式-调度进行中...");  }  }

可以看出,这就是一个普通的类,并且有一个方法。

第二步:配置作业类

Xml代码

说明:这一步是关键步骤,声明一个MethodInvokingJobDetailFactoryBean,有两个关键属性:targetObject指定任务类,targetMethod指定运行的方法。往下的步骤就与方法一相同了,为了完整,同样贴出。

第三步:配置作业调度的触发方式(触发器)

Quartz的作业触发器有两种,分别是

  • org.springframework.scheduling.quartz.SimpleTriggerBean

  • org.springframework.scheduling.quartz.CronTriggerBean

第一种SimpleTriggerBean,只支持按照一定频度调用任务,如每隔30分钟运行一次。

配置方式如下:

Xml代码

第二种CronTriggerBean,支持到指定时间运行一次,如每天12:00运行一次等。

配置方式如下:

Xml代码

>

以上两种调度方式根据实际情况,任选一种即可。

第四步:配置调度工厂

Xml代码

说明:该参数指定的就是之前配置的触发器的名字。

第五步:启动你的应用即可,即将工程部署至tomcat或其他容器。

到此,spring中Quartz的基本配置就介绍完了,当然了,使用之前,要导入相应的spring的包与Quartz的包,这些就不消多说了。

其实可以看出Quartz的配置看上去还是挺复杂的,没有办法,因为Quartz其实是个重量级的工具,如果我们只是想简单的执行几个简单的定时任务,有没有更简单的工具,有!

请看我第下文Spring task的介绍。

Spring-Task

上节介绍了在Spring 中使用Quartz,本文介绍Spring3.0以后自主开发的定时任务工具,spring task,可以将它比作一个轻量级的Quartz,而且使用起来很简单,除spring相关的包外不需要额外的包,而且支持注解和配置文件两种

形式,下面将分别介绍这两种方式。

第一种:配置文件方式

第一步:编写作业类

即普通的pojo,如下:

Java代码

import org.springframework.stereotype.Service;  @Servicepublicclass TaskJob {  publicvoid job1() {          System.out.println("任务进行中。。。");      }  }
第二步:在spring配置文件头中添加命名空间及描述

Xml代码

#### 第三步:spring配置文件中设置具体的任务

Xml代码

说明:ref参数指定的即任务类,method指定的即需要运行的方法,cron及cronExpression表达式,具体写法这里不介绍了,详情见上篇文章附录。这个配置不消多说了,spring扫描注解用的。到这里配置就完成了,是不是很简单。

第二种:使用注解形式

也许我们不想每写一个任务类还要在xml文件中配置下,我们可以使用注解@Scheduled,我们看看源文件中该注解的定义:

Java代码

@Target({java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.ANNOTATION_TYPE})  @Retention(RetentionPolicy.RUNTIME)  @Documentedpublic@interface Scheduled  {  publicabstract String cron();  publicabstractlong fixedDelay();  publicabstractlong fixedRate();  }

可以看出该注解有三个方法或者叫参数,分别表示的意思是:

  • cron:指定cron表达式

  • fixedDelay:官方文档解释:An interval-based trigger where the interval is measured from the completion time of the previous task. The time unit value is measured in milliseconds.即表示从上一个任务完成开始到下一个任务开始的间隔,单位是毫秒。

  • fixedRate:官方文档解释:An interval-based trigger where the interval is measured from the start time of the previous task. The time unit value is measured in milliseconds.即从上一个任务开始到下一个任务开始的间隔,单位是毫秒。

下面我来配置一下。

第一步:编写pojo

Java代码

import org.springframework.scheduling.annotation.Scheduled;    import org.springframework.stereotype.Component;  @Component("taskJob")  publicclass TaskJob {  @Scheduled(cron = "0 0 3 * * ?")  publicvoid job1() {          System.out.println("任务进行中。。。");      }  }

#### 第二步:添加task相关的配置:

Xml代码

说明:理论上只需要加上这句配置就可以了,这些参数都不是必须的。

Ok配置完毕,当然spring task还有很多参数,我就不一一解释了,具体参考xsd文档http://www.springframework.org/schema/task/spring-task-3.0.xsd。

看完上述内容,你们对如何实现一个Spring定时任务有进一步的了解吗?如果还想了解更多知识或者相关内容,请关注行业资讯频道,感谢大家的支持。

0