• Spring 定时作业


    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两种。
    Quartz
    第一种,作业类继承自特定的基类:org.springframework.scheduling.quartz.QuartzJobBean。
    第一步:定义作业类
     
    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分钟运行一次。
    配置方式如下:
     
    Xml代码  
     <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秒调度一次 -->  
    </bean>  
     
    第二种CronTriggerBean,支持到指定时间运行一次,如每天12:00运行一次等。
    配置方式如下:
    Xml代码  
     <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">  
    <property name="jobDetail" ref="job1" />  
    <!—每天12:00运行一次 -->  
    <property name="cronExpression" value="0 0 12 * * ?" />  
    </bean>  
     关于cronExpression表达式的语法参见附录。
    第四步:配置调度工厂 
    Xml代码  
     <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
    <property name="triggers">  
    <list>  
    <ref bean="cronTrigger" />  
    </list>  
    </property>  
    </bean>  
     
     说明:该参数指定的就是之前配置的触发器的名字。
    第五步:启动你的应用即可,即将工程部署至tomcat或其他容器。
     
     
    第二种,作业类不继承特定基类。
    Spring能够支持这种方式,归功于两个类:
    org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean
    org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean
    这两个类分别对应spring支持的两种实现任务调度的方式,即前文提到到java自带的timer task方式和Quartz方式。这里我只写MethodInvokingJobDetailFactoryBean的用法,使用该类的好处是,我们的任务类不再需要继承自任何类,而是普通的pojo。
    第一步:编写任务类
    Java代码  
    public class Job2 {  
    public void doJob2() {  
    System.out.println("不继承QuartzJobBean方式-调度进行中...");  
    }  
    }  
     可以看出,这就是一个普通的类,并且有一个方法。
    第二步:配置作业类
    Xml代码 
     <bean id="job2"  
    class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
    <property name="targetObject">  
    <bean class="com.gy.Job2" />  
    </property>  
    <property name="targetMethod" value="doJob2" />  
    <property name="concurrent" value="false" /><!-- 作业不并发调度 -->  
    </bean>  
     说明:这一步是关键步骤,声明一个MethodInvokingJobDetailFactoryBean,有两个关键属性:targetObject指定任务类,targetMethod指定运行的方法。往下的步骤就与方法一相同了,为了完整,同样贴出。
    第三步:配置作业调度的触发方式(触发器)
    Quartz的作业触发器有两种,分别是
    org.springframework.scheduling.quartz.SimpleTriggerBean
    org.springframework.scheduling.quartz.CronTriggerBean
    第一种SimpleTriggerBean,只支持按照一定频度调用任务,如每隔30分钟运行一次。
    配置方式如下:
    Xml代码  
     <bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">  
    <property name="jobDetail" ref="job2" />  
    <property name="startDelay" value="0" /><!-- 调度工厂实例化后,经过0秒开始执行调度 -->  
    <property name="repeatInterval" value="2000" /><!-- 每2秒调度一次 -->  
    </bean>  
     第二种CronTriggerBean,支持到指定时间运行一次,如每天12:00运行一次等。
    配置方式如下:
    Xml代码  
     <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">  
    <property name="jobDetail" ref="job2" />  
    <!—每天12:00运行一次 -->  
    <property name="cronExpression" value="0 0 12 * * ?" />  
    </bean>  
    以上两种调度方式根据实际情况,任选一种即可。
    第四步:配置调度工厂 
    Xml代码  
    <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
    <property name="triggers">  
    <list>  
    <ref bean="cronTrigger" />  
    </list>  
    </property>  
    </bean>  
    说明:该参数指定的就是之前配置的触发器的名字。
    第五步:启动你的应用即可,即将工程部署至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;  
    @Service  
    public class TaskJob {  
          
        public void job1() {  
            System.out.println(“任务进行中。。。”);  
        }  
    }  
     第二步:在spring配置文件头中添加命名空间及描述
    Xml代码  
    <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配置文件中设置具体的任务
    Xml代码  
     <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表达式,具体写法这里不介绍了,详情见上篇文章附录。
    这个配置不消多说了,spring扫描注解用的。
    到这里配置就完成了,是不是很简单。
    第二种:使用注解形式
    也许我们不想每写一个任务类还要在xml文件中配置下,我们可以使用注解@Scheduled,我们看看源文件中该注解的定义:
    Java代码  
    @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
    Java代码  
    import org.springframework.scheduling.annotation.Scheduled;    
    import org.springframework.stereotype.Component;  
      
    @Component(“taskJob”)  
    public class TaskJob {  
        @Scheduled(cron = "0 0 3 * * ?")  
        public void job1() {  
            System.out.println(“任务进行中。。。”);  
        }  
    }  
     第二步:添加task相关的配置:
    Xml代码  
     
        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"/>  
         
    说明:理论上只需要加上这句配置就可以了,这些参数都不是必须的。
     
     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触发 
     
    原文:http://gong1208.iteye.com/blog/1773177
     
    以下作为补充:
    星号(*):可用在所有的字段中,表示对应时间域的每一个时刻,例如:*在分钟字段时,表示“每分钟”
    问号(?):该字符只能在日期和星期字段中使用,它通常指定为“无意义的值”,相当于占位符
    减号(-):表达一个范围,如在小时字段中使用“10-12”,这表示从10点到12点,即10、11、12
    逗号(,):表示一个列表值,如在星期字段中使用“MON,WED,FRI”,则表示星期一、星期三、星期五
    斜杠(/):x/y表达一个等长序列,x为起始值,y为增量步长值。如在分钟字段中使用0/15,则表示为0,15,30和45秒;而5/15在分钟字段中表示5,20,35,50.用户也可以使             用*/y,他等同于0/y。
     
    L:("last") ("last") "L" 用在day-of-month字段意思是 "这个月最后一天";用在 day-of-week字段, 它简单意思是 "7" or "SAT"。 如果在day-of-week字段里和数字联合使用,它的意思就是 "这个月的最后一个星期几" – 例如: "6L" means "这个月的最后一个星期五". 当我们用“L”时,不指明一个列表值或者范围是很重要的,不然的话,我们会得到一些意想不到的结果。 
    W:("weekday") 只能用在day-of-month字段。用来描叙最接近指定天的工作日(周一到周五)。例如:在day-of-month字段用“15W”指“最接近这个 月第15天的工作日”,即如果这个月第15天是周六,那么触发器将会在这个月第14天即周五触发;如果这个月第15天是周日,那么触发器将会在这个月第 16天即周一触发;如果这个月第15天是周二,那么就在触发器这天触发。注意一点:这个用法只会在当前月计算值,不会越过当前月。“W”字符仅能在 day-of-month指明一天,不能是一个范围或列表。也可以用“LW”来指定这个月的最后一个工作日。 
    # :只能用在day-of-week字段。用来指定这个月的第几个周几。例:在day-of-week字段用"6#3"指这个月第3个周五(6指周五,3指第3个)。如果指定的日期不存在,触发器就不会触发。 
    C :指和calendar联系后计算过的值。例:在day-of-month 字段用“5C”指在这个月第5天或之后包括calendar的第一天;在day-of-week字段用“1C”指在这周日或之后包括calendar的第一天。
  • 相关阅读:
    Struts2.5 利用Ajax将json数据传值到JSP
    io/nio
    Elasticsearch 、 Logstash以及Kibana 分布式日志
    zookeeper
    mybatis
    Kubemetes
    线程池
    @Builder
    jdk命令行工具系列
    什么是分布式事务
  • 原文地址:https://www.cnblogs.com/andysd/p/3397418.html
Copyright © 2020-2023  润新知