Listener监听器

提示：本文中部分内容图片节选自互联网，无意冒犯。如有侵权请私信联系作者即刻删除、更改。

---

---

前言

Quartz的监听器用于监听任务调度时发生的事件，能够获取对应事件的通知并作出相应的反应。Quartz监听器有三种JobListener、TriggerListener、SchedulerListener，分别对应着Job、Trigger、Scheduler三者的监听器。JobListener和TriggerListener根据配置的作用域不同被分为全局和局部监听器：全局监听器可以监听所有的Job和Trigger事件的通知，局部监听器只能接收到其上注册的Job和Trigger事件。
使用监听器的方式很简单只需要两步：自定义监听和注册监听器。自定义监听器的方式有两种，实现元素的XXXListener接口或者继承Quartz实现的监听器适配类XXListenerSupport抽象类。而注册监听器的方式只有一种，即调用Scheduler# getListenerManager().addXXXListener()。删除监听器的方式类似，调用对应的 scheduler.getListenerManager().removeXXXListener()即可。

JobListener

JobListener用于监听任务过程中Job相关的事件信息。如Job开始执行、执行完成等特殊节点的事件。JobListener的源码如下：

public interface JobListener {
    //获取监听器的名称
    String getName();
    //用于监听一个JobDetail即将被被执行时（与之相关联的Trigger已经被触发），由Schedulerd调用
    //需要注意当Job被否决时，此方法不会被调用
    void jobToBeExecuted(JobExecutionContext context);
    //当一个Job被Trigger否决执行时，由Schedulerd触发此方法
    void jobExecutionVetoed(JobExecutionContext context);
    //当一个JobDetail和Trigger都被执行之后，由Schedulerd触发此方法
    void jobWasExecuted(JobExecutionContext context,
                        JobExecutionException jobException);

}

如果想要使用JobListener需要用户自定义类实现JobListener或者使用JobListenerSupport抽象类并覆盖你感兴趣的方法。然后将其与Job相关联。如下例中使用了JobListenerSupport并将其添加到HelloJob中与之关联成为局部监听器：

public static void main(String[] args) throws SchedulerException {
    final Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
    final JobKey holleJobKey =JobKey.jobKey("job1", "group1");
    final JobDetail detail = JobBuilder.newJob(HelloJob.class)
            .withIdentity(holleJobKey)
            .build();
    final SimpleTrigger trigger = TriggerBuilder.newTrigger()
            .withIdentity("trigger1", "group1")
            //参数1：触发器的名称（唯一），参数2：触发器组的名称
            .withSchedule(SimpleScheduleBuilder.simpleSchedule().repeatForever().withIntervalInSeconds(2))
            //指定重复2秒一次
            .startNow()
            //立即启动
            .build();
    scheduler.scheduleJob(detail,trigger);
    //添加局部监听器
    scheduler.getListenerManager().addJobListener(new JobListenerSupport() {
        @Override
        public String getName() {
            return "part's helloJobListener";
        }

        @Override
        public void jobToBeExecuted(JobExecutionContext context) {
            System.out.println("任务将要被执行");
        }
        @Override
        public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) {
            System.out.println("任务执行后");
        }
    }, KeyMatcher.keyEquals(holleJobKey));
    scheduler.start();
}

如需定义全局监听器可使用以下方式：

//定义全局监听器
scheduler.getListenerManager().addJobListener(new JobListenerSupport() {
    @Override
    public String getName() {
        return "overall's helloJobListener";
    }
}, EverythingMatcher.allJobs());

如果想要注册几个Job的监听器可使用如下方式：

//添加局部监听器
scheduler.getListenerManager().addJobListener(new JobListenerSupport() {
    @Override
    public String getName() {
        return "part's helloJobListener";
    }

    @Override
    public void jobToBeExecuted(JobExecutionContext context) {
        System.out.println("任务将要被执行");
    }
    @Override
    public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) {
        System.out.println("任务执行后");
    }
}, OrMatcher.or(KeyMatcher.keyEquals(holleJobKey),KeyMatcher.keyEquals(JobKey.jobKey("ds","fd"))));

Job为了方便管理可以分组，监听器也可以对组中每个成员进行监听。如果对JobGroup监听可使用如下方式：

scheduler.getListenerManager().addJobListener(new JobListenerSupport() {
    @Override
    public String getName() {
        return "part's helloJobListener";
    }

    @Override
    public void jobToBeExecuted(JobExecutionContext context) {
        System.out.println("任务将要被执行");
    }
    @Override
    public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) {
        System.out.println("任务执行后");
    }
}, GroupMatcher.groupEquals("group1"));

TriggerListener

TriggerListener用于监听触发器相关的事件。包括：触发器被触发、触发器失效、触发完成。TriggerListener的源码如下：

public interface TriggerListener {
    //获取TriggerListener的名称
    String getName();
    //当触发器被触发，并且相关联的JobDetail将要被执行，由Scheduler调用此方法
    //并且此方法执行在vetoJobExecution之前
    void triggerFired(Trigger trigger, JobExecutionContext context);
   //该方法用于确认是否否决与此触发器相关JobDetail的执行。并且此方法执行在triggerFired之后
   //当触发器被触发，并且相关联的JobDetail将要被执行时，由Scheduler调用此方法
    //当返回值为true时否决JobDetail的执行
    boolean vetoJobExecution(Trigger trigger, JobExecutionContext context);
    //当触发器触发失败后，由Scheduler调用此方法
    //提示：你应该在这个方法上花费的时间，因为它会影响所有触发失败的触发器，如果系统
    //有很多触发器同时失效，这个方法耗时过多讲师灾难性问题
    void triggerMisfired(Trigger trigger);
    //当JobDetail和Trigger都被触发执行并且它的triggered方法也被执行，由Scheduler调用此方法
    void triggerComplete(Trigger trigger, JobExecutionContext context,
                         CompletedExecutionInstruction triggerInstructionCode);

}

它的使用方法和添加方式如上文的JobListener，如有不懂请参考上文示例。这里列举一个简单的案例以供参考：

//添加局部监听器
scheduler.getListenerManager().addTriggerListener(new TriggerListenerSupport() {
    @Override
    public String getName() {
        return "简单案例";
    }
},KeyMatcher.keyEquals(TriggerKey.triggerKey("trigger1","group1")));

SchedulerListener

ShcedulerListener用于监听Scheduler调度任务和一些Job、Trigger管理相关的事件。如：增、删Job/Trigger、Scheduler执行中的错误、Scheduler的开启、关闭等。其源码如下：

public interface SchedulerListener {
    //当一个JobDetail执行之后，由Scheduler调用此方法
    void jobScheduled(Trigger trigger);
    //当一个JobDetail未按计划执行，由Scheduler调用此方法
    void jobUnscheduled(TriggerKey triggerKey);
    //当一个Trigger永远不会被执行了，由Scheduler调用此方法
    void triggerFinalized(Trigger trigger);
    // 当一个Trigger被暂停，由Scheduler调用此方法
    void triggerPaused(TriggerKey triggerKey);
    //当一个triggerGroup被暂停，由Scheduler调用此方法
    void triggersPaused(String triggerGroup);
    void triggerResumed(TriggerKey triggerKey);
    void triggersResumed(String triggerGroup);
    void jobAdded(JobDetail jobDetail);
    void jobDeleted(JobKey jobKey);
    void jobPaused(JobKey jobKey);
    void jobsPaused(String jobGroup);
    void jobResumed(JobKey jobKey);
    void jobsResumed(String jobGroup);
    //当scheduler发生严重错误时，此方法将被调用
    //如JobStore重复失败，或者无法实例化一个Job对象当Trigger已被触发
    //这时可以通过SchedulerException#getErrorCode方法定位问题
    void schedulerError(String msg, SchedulerException cause);
    //当Scheduler被暂停时，此方法被调用
    void schedulerInStandbyMode();
    //当Scheduler已经被执行。此方法被调用
    void schedulerStarted();
    //当Scheduler正在执行。此方法被调用
    void schedulerStarting();
    void schedulerShutdown();
    //当Scheduler属于关闭队列时，此方法被调用
    void schedulerShuttingdown();
    //当与之关联的jobs, triggers and calendars都被删除时，此方法被调用
    void schedulingDataCleared();
}

添加SchedulerListener的示例如下：

scheduler.getListenerManager().addSchedulerListener(new SchedulerListenerSupport() {
});

删除SchedulerListener的示例如下：

scheduler.getListenerManager().removeSchedulerListener(mySchedListener);