天天看点

定时任务

spring定时任务的几种实现

近日项目开发中需要执行一些定时任务,比如需要在每天凌晨时候,分析一次前一天的日志信息,借此机会整理了一下定时任务的几种实现方式,由于项目采用spring框架,所以我都将结合

spring框架来介绍。

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

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

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

作业类需要继承自特定的作业类基类,如quartz中需要继承自org.springframework.scheduling.quartz.quartzjobbean;java.util.timer中需要继承自java.util.timertask。

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

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

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

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

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

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

第一步:定义作业类

java代码  

定时任务

import org.quartz.jobexecutioncontext;  

import org.quartz.jobexecutionexception;  

import org.springframework.scheduling.quartz.quartzjobbean;  

public class job1 extends quartzjobbean {  

private int timeout;  

private static int i = 0;  

//调度工厂实例化后,经过timeout时间开始执行调度  

public void settimeout(int timeout) {  

this.timeout = timeout;  

}  

/** 

* 要调度的具体任务 

*/  

@override  

protected void executeinternal(jobexecutioncontext context)  

throws jobexecutionexception {  

  system.out.println("定时任务执行中…");  

 第二步:spring配置文件中配置作业类jobdetailbean

xml代码  

定时任务

<bean name="job1" class="org.springframework.scheduling.quartz.jobdetailbean">  

<property name="jobclass" value="com.gy.job1" />  

<property name="jobdataasmap">  

<map>  

<entry key="timeout" value="0" />  

</map>  

</property>  

</bean>  

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

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

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

org.springframework.scheduling.quartz.simpletriggerbean

org.springframework.scheduling.quartz.crontriggerbean

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

配置方式如下:

定时任务

<bean id="simpletrigger" class="org.springframework.scheduling.quartz.simpletriggerbean">  

<property name="jobdetail" ref="job1" />  

<property name="startdelay" value="0" /><!-- 调度工厂实例化后,经过0秒开始执行调度 -->  

<property name="repeatinterval" value="2000" /><!-- 每2秒调度一次 -->  

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

定时任务

<bean id="crontrigger" class="org.springframework.scheduling.quartz.crontriggerbean">  

<!—每天12:00运行一次 -->  

<property name="cronexpression" value="0 0 12 * * ?" />  

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

第四步:配置调度工厂 

定时任务

<bean class="org.springframework.scheduling.quartz.schedulerfactorybean">  

<property name="triggers">  

<list>  

<ref bean="crontrigger" />  

</list>  

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

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

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

org.springframework.scheduling.timer.methodinvokingtimertaskfactorybean

org.springframework.scheduling.quartz.methodinvokingjobdetailfactorybean

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

第一步:编写任务类

定时任务

public class job2 {  

public void dojob2() {  

system.out.println("不继承quartzjobbean方式-调度进行中...");  

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

第二步:配置作业类

定时任务

<bean id="job2"  

class="org.springframework.scheduling.quartz.methodinvokingjobdetailfactorybean">  

<property name="targetobject">  

<bean class="com.gy.job2" />  

<property name="targetmethod" value="dojob2" />  

<property name="concurrent" value="false" /><!-- 作业不并发调度 -->  

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

定时任务

<property name="jobdetail" ref="job2" />  

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

定时任务

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

定时任务

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

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

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

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

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

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

第一步:编写作业类

即普通的pojo,如下:

定时任务

import org.springframework.stereotype.service;  

@service  

public class taskjob {  

    public void job1() {  

        system.out.println(“任务进行中。。。”);  

    }  

 第二步:在spring配置文件头中添加命名空间及描述

定时任务

<beans xmlns="http://www.springframework.org/schema/beans"  

    xmlns:task="http://www.springframework.org/schema/task"   

    。。。。。。  

    xsi:schemalocation="http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd">  

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

定时任务

 <task:scheduled-tasks>   

        <task:scheduled ref="taskjob" method="job1" cron="0 * * * * ?"/>   

</task:scheduled-tasks>  

<context:component-scan base-package=" com.gy.mytask " />  

说明:ref参数指定的即任务类,method指定的即需要运行的方法,cron及cronexpression表达式,具体写法这里不介绍了,详情见上篇文章附录。

<context:component-scan base-package="com.gy.mytask" />这个配置不消多说了,spring扫描注解用的。

到这里配置就完成了,是不是很简单。

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

定时任务

@target({java.lang.annotation.elementtype.method, java.lang.annotation.elementtype.annotation_type})  

@retention(retentionpolicy.runtime)  

@documented  

public @interface scheduled  

{  

  public abstract string cron();  

  public abstract long fixeddelay();  

  public abstract long 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

定时任务

import org.springframework.scheduling.annotation.scheduled;    

import org.springframework.stereotype.component;  

@component(“taskjob”)  

    @scheduled(cron = "0 0 3 * * ?")  

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

定时任务

<?xml version="1.0" encoding="utf-8"?>  

    xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:aop="http://www.springframework.org/schema/aop"  

    xmlns:context="http://www.springframework.org/schema/context"  

    xmlns:tx="http://www.springframework.org/schema/tx"  

    xmlns:task="http://www.springframework.org/schema/task"  

    xsi:schemalocation="  

        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd  

        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd  

        http://www.springframework.org/schema/context   

http://www.springframework.org/schema/jdbc/spring-jdbc-3.0.xsd  

        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd  

        http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd"  

    default-lazy-init="false">  

    <context:annotation-config />  

    <!—spring扫描注解的配置   -->  

    <context:component-scan base-package="com.gy.mytask" />  

<!—开启这个配置,spring才能识别@scheduled注解   -->  

    <task:annotation-driven scheduler="qbscheduler" mode="proxy"/>  

    <task:scheduler id="qbscheduler" pool-size="10"/>  

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

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

附录:

cronexpression的配置说明,具体使用以及参数请百度google

字段   允许值   允许的特殊字符

秒    0-59    , - * /

分    0-59    , - * /

小时    0-23    , - * /

日期    1-31    , - * ? / l w c

月份    1-12 或者 jan-dec    , - * /

星期    1-7 或者 sun-sat    , - * ? / l c #

年(可选)    留空, 1970-2099    , - * / 

- 区间  

* 通配符  

? 你不想设置那个字段

下面只例出几个式子

cron表达式    含义 

"0 0 12 * * ?"    每天中午十二点触发 

"0 15 10 ? * *"    每天早上10:15触发 

"0 15 10 * * ?"    每天早上10:15触发 

"0 15 10 * * ? *"    每天早上10:15触发 

"0 15 10 * * ? 2005"    2005年的每天早上10:15触发 

"0 * 14 * * ?"    每天从下午2点开始到2点59分每分钟一次触发 

"0 0/5 14 * * ?"    每天从下午2点开始到2:55分结束每5分钟一次触发 

"0 0/5 14,18 * * ?"    每天的下午2点至2:55和6点至6点55分两个时间段内每5分钟一次触发 

"0 0-5 14 * * ?"    每天14:00至14:05每分钟一次触发 

"0 10,44 14 ? 3 wed"    三月的每周三的14:10和14:44触发 

"0 15 10 ? * mon-fri"    每个周一、周二、周三、周四、周五的10:15触发