quartz框架(八)-Listener

Listener

上篇博文，博主介绍了jobStore相关的内容。本篇博文，博主将介绍quartz框架中监听器的使用以及原理。监听器在开源框架中十分常见，通过监听器我们可以实现一些定制化的功能。

什么是Listener?

监听器就是在某一个事件发生的时候，被监听对象会根据对应事件，循环调用监听对象（监听对象需要监听器对应的方法）的方法。这么说的话，是不是跟设计模式中的观察者模式一模一样。关于quartz框架中使用到的设计模式，博主会在后面的具体某一篇文章中详细介绍。

JobListener

JobListener用于监听Job执行时的相关事件，比如Job将要被执行时，Job执行被否决，job执行完成的时候。

接口定义

quartz框架中，jobListener的接口定义如下所示：

public interface JobListener {

    //获取监听器的名称
    String getName();
   
   //Job将要被执行时
    void jobToBeExecuted(JobExecutionContext context);
    
   //Job执行被否决时
    void jobExecutionVetoed(JobExecutionContext context);
    
   //Job被执行完毕
    void jobWasExecuted(JobExecutionContext context,
            JobExecutionException jobException);

}

通过源码可知，jobListener的jobExecutionVetoed方法，会在Trigger监听器的vetoJobExecution调用时被决定，如果vetoJobExecution返回true的话，那么job的执行就会被否则。

配置

在quartz的默认配置文件中，我们可以定义全局的JobListener。全局的JobListener需要有无参构造函数，并且它的作用域是全部job。

org.quartz.jobListener.NAME.class = com.foo.MyListenerClass
org.quartz.jobListener.NAME.propName = propValue
org.quartz.jobListener.NAME.prop2Name = prop2Value

使用场景

在实际场景中，假设我们需要监控所有的任务，在它们的任务执行完毕的时候，需要记录一下时间，并对超出时间阈值的任务进行记录。这时，我们就可以在基础框架代码中实现JobListener相关的接口，而不需要每个Job业务类自己去做这个事情。

TriggerListener

TriggerListener用于监听Trigger执行时的相关事件，比如Trigger被触发，否决job执行，trigger失火等事件。

接口定义

quartz框架中，triggerListener的接口定义如下所示：

  
   //获取名称
   String getName();
   
   //trigger被触发
    void triggerFired(Trigger trigger, JobExecutionContext context);
    
   //否决job执行
    boolean vetoJobExecution(Trigger trigger, JobExecutionContext context);
    
   //trigger失火
    void triggerMisfired(Trigger trigger);
    
   //trigger完成
    void triggerComplete(Trigger trigger, JobExecutionContext context,
            CompletedExecutionInstruction triggerInstructionCode);

配置

在quartz的默认配置文件中，我们可以定义全局的TriggerListener。全局的TriggerListener需要有无参构造函数，并且它的作用域是全部Trigger。

org.quartz.triggerListener.NAME.class = com.foo.MyListenerClass
org.quartz.triggerListener.NAME.propName = propValue
org.quartz.triggerListener.NAME.prop2Name = prop2Value

SchedulerListener

SchedulerListener用于监听scheduler执行时的相关事件，比如job被添加到scheduler，job被添加到调度器的事件，scheduler正在启动的事件。

接口定义

schedulerListener可以监听的事件很多，博主这里简单的罗列一下SchedulerListener的相关定义。

    void jobScheduled(Trigger trigger);

    void jobUnscheduled(TriggerKey triggerKey);

    void triggerFinalized(Trigger trigger);

    ...

使用

SchedulerListener不像JobListener和TriggerListener一样，它不可以在配置文件中配置全局的SchedulerListener。因此SchedulerListener需要在程序运行时，通过scheduler的listenerManager进行添加。

<span id="wechatGzh">博主微信公众号</span>

<img src="https://gitee.com/chenhaogit/blogimages/raw/master/xsj/wzgzh-8cm.jpg" style="float:right"/>