Java Spring注解任务调度并实现AOP监控任务执行情况

本文讲的是通过Spring注解的方式实现任务调度。只要引入了spring-context包就能够在项目中使用注解方式的任务调度。

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

下面看具体配置

spring框架来介绍。

需要在Spring配置文件中加入task的schema。

一.分类

xmlns:task="http://www.springframework.org/schema/task"
xsi:schemaLocation="http://www.springframework.org/schema/task
http://www.springframework.org/schema/task/spring-task-4.0.xsd"

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

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都可以支持这两种触发条件。

<task:annotation-driven />

二.用法说明

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

然后在代码中就可以直接用了,要定时执行的方法必须是void的,并且没有任何参数的。

Quartz

@Override
@Scheduled(cron="0 0 2 * * ?")
@Transactional(rollbackFor=Exception.class)
public void excute() throws DXPException

第一种,作业类继承自特定的基类: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或其他容器。

cron表达式请自行问百度,下面只列出几个从网上找的例子

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

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的介绍。

CRON表达式 含义

Spring-Task

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

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

“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触发

第一种:配置文件方式

第一步:编写作业类

即普通的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表达式,具体写法这里不介绍了,详情见上篇文章附录。

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

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

通过AOP监控方法的执行情况,并保存到数据库中

第二种:使用注解形式

也许我们不想每写一个任务类还要在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代码 

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    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文档

附录:

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触发 *

package com.tiamaes.gjds.dxp.aop;

import java.util.Date;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;

import com.tiamaes.gjds.dxp.annotation.Task;
import com.tiamaes.gjds.dxp.bean.TbScheduledExcuteLog;
import com.tiamaes.gjds.dxp.repository.TbScheduledExcuteLogRepository;
import com.tiamaes.gjds.dxp.task.DxpScheduled;

/**  
 * <p>类描述:通过AOP监控方法的执行情况,并保存到数据库中</p>
 * <p>创建人:王成委  </p>
 * <p>创建时间:2015年2月28日 上午9:40:18  </p>
 * <p>版权说明: © 2015 Tiamaes </p>
 */
@Aspect
public class ScheduledStatisticsHandler {

    @Autowired
    private TbScheduledExcuteLogRepository tbScheduledExcuteLogRepository;

    @Pointcut("@annotation(org.springframework.scheduling.annotation.Scheduled)")  
    public void proxyAspect() {

    }

    @Around("proxyAspect()")
    public Object doInvoke(ProceedingJoinPoint joinPoint) throws Throwable{
        Date date = new Date();
        long start = System.currentTimeMillis();
        Object result = joinPoint.proceed();
        long end = System.currentTimeMillis();
        Object target = joinPoint.getTarget();

        TbScheduledExcuteLog log = new TbScheduledExcuteLog();
        log.setClassName(joinPoint.getTarget().getClass().getName());
        log.setConsum(end-start);
        log.setExcuteDate(date);
        log.setExcuteTime(date);
        log.setIsError(false);
        if (target instanceof DxpScheduled) {
            DxpScheduled scheduled = (DxpScheduled) target;
            Task task = scheduled.getClass().getAnnotation(Task.class);
            log.setContentName(task.value());
            log.setRemark(scheduled.getTaskExcuteInfo());
            log.setGetRecCount(scheduled.getRemoteCount());
            log.setSyncRecCount(scheduled.getSyncCount());
        }

        this.tbScheduledExcuteLogRepository.save(log);

        return result;
    }
}

通过AOP记录执行时发生异常的任务

package com.tiamaes.gjds.dxp.aop;

import java.util.Date;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;

import com.tiamaes.gjds.dxp.annotation.Task;
import com.tiamaes.gjds.dxp.bean.TbScheduledExcuteLog;
import com.tiamaes.gjds.dxp.dao.TbScheduledExcuteLogDao;
import com.tiamaes.gjds.dxp.exception.DXPException;
import com.tiamaes.gjds.dxp.task.DxpScheduled;
import com.tiamaes.gjds.util.ExceptionTools;

/**  
 * <p>类描述: 处理任务执行时法伤的异常 </p>
 * <p>创建人:王成委  </p>
 * <p>创建时间:2015年2月28日 下午4:24:54  </p>
 * <p>版权说明: © 2015 Tiamaes </p>
 */
@Aspect
public class ScheduleExceptionHandler {

    @Autowired
    private TbScheduledExcuteLogDao tbScheduledExcuteLogDao;

    @Pointcut("@annotation(org.springframework.scheduling.annotation.Scheduled)")  
    public void proxyAspect() {

    }

    @AfterThrowing(pointcut="proxyAspect()",throwing="ex")
    public void doException(JoinPoint joinPoint,Exception ex){
        Object target = joinPoint.getTarget();
        this.saveException(target, ex);
    }

    public void saveException(Object target,Exception ex){
        try {
            Date date = new Date();
            TbScheduledExcuteLog log = new TbScheduledExcuteLog();
            log.setClassName(target.getClass().getName());
            log.setExcuteDate(date);
            log.setExcuteTime(date);
            log.setIsError(true);
            log.setErrorInfo(ExceptionTools.getExceptionDetails(ex).toString());
            if (target instanceof DxpScheduled) {
                DxpScheduled scheduled = (DxpScheduled) target;
                Task task = scheduled.getClass().getAnnotation(Task.class);
                log.setContentName(task.value());
            }
            this.tbScheduledExcuteLogDao.saveAndCommit(log);
        } catch (DXPException e) {
            e.printStackTrace();
        }
    }
}

其中Task注解为标注任务的名称,方便在数据库中保存。

You can leave a response, or trackback from your own site.

Leave a Reply

网站地图xml地图