Quartz使用监听器插入定时任务执行日志

Quartz使用监听器插入定时任务执行日志

使用springboot，将监听器交给spring容器管理，并像其中注入日志服务类，环境准备工作实现任务调度需要导入两个quartz的maven依赖

1. <dependency>
2.             <groupId>org.quartz-scheduler</groupId>
3.             <artifactId>quartz</artifactId>
4.             <version>2.3.2</version>
5. </dependency>
6. <dependency>
7.             <groupId>org.springframework.boot</groupId>
8.             <artifactId>spring-boot-starter-quartz</artifactId>
9.             <version>2.7.3</version>
10.             <exclusions>
11.                 <exclusion>
12.                     <artifactId>slf4j-api</artifactId>
13.                     <groupId>org.slf4j</groupId>
14.                 </exclusion>
15.             </exclusions>
16.   </dependency>      
17.         

复制代码

创建一个监听器类，实现JobListener接口。

1. import cn.hutool.core.date.DateUtil;
2. import lombok.extern.slf4j.Slf4j;
3. import org.quartz.JobDataMap;
4. import org.quartz.JobExecutionContext;
5. import org.quartz.JobExecutionException;
6. import org.quartz.JobKey;
7. import org.quartz.JobListener;
8. import org.quartz.TriggerKey;
9. import org.springframework.stereotype.Component;
11. import java.util.Date;
13. @Slf4j
14. @Component
15. public class QuartzJobListener implements JobListener {
17.         private final QuartzRunningLogService logService;
19.         private static ThreadLocal<QuartzRunningLog> logThreadLocal = ThreadLocal.withInitial(QuartzRunningLog::new);
21.         public QuartzJobListener(QuartzRunningLogService logService) {
22.                 this.logService = logService;
23.         }
25.         @Override
26.         public String getName() {
27.                 return "jobLogListener";
28.         }
29.         /**
30.         *
31.         *Scheduler在JobDetail将要被执行时调用这个方法
32.         **/
33.         @Override
34.         public void jobToBeExecuted(JobExecutionContext context) {
35.                 QuartzRunningLog quartzRunningLog = QuartzRunningLog
36.                                 .builder()
37.                                 .startTime(new Date())
38.                                 .build();
39.                 logThreadLocal.set(quartzRunningLog);
40.         }
41.         /**
42.         *
43.         *Scheduler在JobDetail即将被执行，但又被TriggerListerner否决时会调用该方法
44.         **/
45.         @Override
46.         public void jobExecutionVetoed(JobExecutionContext jobExecutionContext) {
48.         }
49.         /**
50.         *
51.         *Scheduler在JobDetail被执行之后调用这个方法
52.         **/
53.         @Override
54.         public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) {
55.                 JobKey jobKey = context.getJobDetail().getKey();
56.                 TriggerKey triggerKey = context.getTrigger().getKey();
57.                 Date fireTime = context.getFireTime();
58.                 Class jobClass = context.getJobDetail().getJobClass();
59.                 JobDataMap dataMap = context.getMergedJobDataMap();
60.                 String taskName = (String) dataMap.get(CommonConst.TASK_NAME);
61.                 String cronExpression = (String) dataMap.get(CommonConst.CRON_EXPRESSION);
62.                 String jobName = (String) dataMap.get(CommonConst.JOB_NAME);
63.                 log.info("JobClass:{},Job:{},Trigger:{},FireTime:{}", jobClass, jobKey, triggerKey, DateUtil.formatDateTime(fireTime));
64.                 if (null != jobException) {
65.                         //保存错误记录
66.                         QuartzRunningLog runningLog = logThreadLocal.get();
67.                         runningLog.setJobName(jobName);
68.                         runningLog.setCronExpression(cronExpression);
69.                         runningLog.setEndTime(new Date());
70.                         runningLog.setStatus("FAIL");
71.                         runningLog.setTaskId(Long.valueOf(jobKey.getName()));
72.                         runningLog.setTaskName(taskName);
73.                         runningLog.setFailReason(jobException.getMessage());
74.                         logService.save(runningLog);
75.                         logThreadLocal.remove();
76.                         return;
77.                 }
78.                 //保存执行记录
79.                 QuartzRunningLog runningLog = logThreadLocal.get();
80.                 runningLog.setJobName(jobName);
81.                 runningLog.setCronExpression(cronExpression);
82.                 runningLog.setEndTime(new Date());
83.                 runningLog.setStatus("SUCESS");
84.                 runningLog.setTaskId(Long.valueOf(jobKey.getName()));
85.                 runningLog.setTaskName(taskName);
86.                 logService.save(runningLog);
87.                 logThreadLocal.remove();
88.         }
89. }

复制代码

quartzconfig配置类

1. import org.quartz.Scheduler;
2. import org.quartz.SchedulerException;
3. import org.quartz.spi.JobFactory;
4. import org.springframework.beans.factory.annotation.Autowired;
5. import org.springframework.context.ApplicationContext;
6. import org.springframework.context.annotation.Bean;
7. import org.springframework.context.annotation.Configuration;
8. import org.springframework.scheduling.quartz.SchedulerFactoryBean;
10. @Configuration
11. public class QuartzConfig {
13.         @Autowired
14.         private ApplicationContext applicationContext;
16.         /**
17.          * Create the job factory bean
18.          *
19.          * @return Job factory bean
20.          */
21.         @Bean
22.         public JobFactory jobFactory() {
23.                 ApplicationContextHolder jobFactory = new ApplicationContextHolder();
24.                 jobFactory.setApplicationContext(applicationContext);
25.                 return jobFactory;
26.         }
28.         /**
29.          * Create the Scheduler Factory bean
30.          *
31.          * @return scheduler factory object
32.          */
33.         @Bean
34.         public SchedulerFactoryBean schedulerFactory() {
35.                 SchedulerFactoryBean factory = new SchedulerFactoryBean();
36.                 factory.setAutoStartup(true);
37.                 factory.setSchedulerName("Scheduler");
38.                 factory.setOverwriteExistingJobs(true);
39.                 factory.setJobFactory(jobFactory());
40.                 return factory;
41.         }
43.         /**
44.          * Create the Scheduler bean
45.          *
46.          * @param logService
47.          * @return Scheduler
48.          * @throws SchedulerException
49.          */
50.         @Bean
51.         public Scheduler scheduler(@Autowired QuartzRunningLogService logService) throws SchedulerException {
52.         //在这里注入日志服务类且激活监听器，如果直接在监听器类里面使用@Autowired会出现注入为null
53.                 schedulerFactory().getScheduler().getListenerManager().addJobListener(new QuartzJobListener(logService));
54.                 return schedulerFactory().getScheduler();
55.         }
57. }

复制代码

容器工具类

1. import org.quartz.spi.TriggerFiredBundle;
2. import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
3. import org.springframework.context.ApplicationContext;
4. import org.springframework.context.ApplicationContextAware;
5. import org.springframework.scheduling.quartz.SpringBeanJobFactory;
6. import org.springframework.stereotype.Component;
8. @Component
9. public class ApplicationContextHolder extends SpringBeanJobFactory
10.                 implements ApplicationContextAware {
11.         private static ApplicationContext context;
12.         private transient AutowireCapableBeanFactory beanFactory;
14.         @Override
15.         public void setApplicationContext(final ApplicationContext context) {
16.                 beanFactory = context.getAutowireCapableBeanFactory();
17.                 ApplicationContextHolder.context = context;
18.         }
20.         @Override
21.         protected Object createJobInstance(final TriggerFiredBundle bundle) throws Exception {
22.                 final Object job = super.createJobInstance(bundle);
23.                 beanFactory.autowireBean(job);
24.                 return job;
25.         }
27.         public static ApplicationContext getContext() {
28.                 return context;
29.         }
30. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！