[AOP拦截 ]SpringBoot+Quartz Aop拦截Job类中的方法

​ 最近在工作使用boot+quartz整合,开发定时调度平台，遇到需要对Quartz的Job进行异常后将异常记录到日志表的操作，第一反应就想到了使用Spring的AOP，利用AfterThrowing来完成这个操作。

话不多说，直接上代码：

 <!--整合Quartz-->
 <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-quartz</artifactId>
 </dependency>

1.正常的一个job类：

2. 创建JobBeanFactory类，重写 SpringBeanJobFactory 的方法。

 import org.quartz.SchedulerContext;
 import org.quartz.spi.TriggerFiredBundle;
 import org.springframework.beans.BeanWrapper;
 import org.springframework.beans.MutablePropertyValues;
 import org.springframework.beans.PropertyAccessorFactory;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.lang.Nullable;
 import org.springframework.scheduling.quartz.SpringBeanJobFactory;

 /**
  * @Author: Hujh
  * @Date: 2019/7/5 9:38
  * @Description:  配置job工厂
  */
 public class JobBeanFactory extends SpringBeanJobFactory{

     @Nullable
     private String[] ignoredUnknownProperties;

     @Nullable
     private SchedulerContext schedulerContext;

     private final BeanFactory beanFactory;

     JobBeanFactory(BeanFactory beanFactory){
         this.beanFactory = beanFactory;
     }

     public void setIgnoredUnknownProperties(String... ignoredUnknownProperties) {
         this.ignoredUnknownProperties = ignoredUnknownProperties;
     }

     @Override
     public void setSchedulerContext(SchedulerContext schedulerContext) {
         this.schedulerContext = schedulerContext;
     }

     /**
      * @Title: createJobInstance
      * @Author : Hujh
      * @Date: 2019/7/5 10:19
      * @Description : 创建调度工作接口
      * @param : bundle
      * @Return : java.lang.Object
      */
     @Override
     protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
         Class<?> jobClass = bundle.getJobDetail().getJobClass();
         Object job = beanFactory.getBean(jobClass);
         if (isEligibleForPropertyPopulation(job)) {
             BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(job);
             MutablePropertyValues pvs = new MutablePropertyValues();
             if (this.schedulerContext != null) {
                 pvs.addPropertyValues(this.schedulerContext);
             }
             pvs.addPropertyValues(bundle.getJobDetail().getJobDataMap());
             pvs.addPropertyValues(bundle.getTrigger().getJobDataMap());
             if (this.ignoredUnknownProperties != null) {
                 for (String propName : this.ignoredUnknownProperties) {
                     if (pvs.contains(propName) && !bw.isWritableProperty(propName)) {
                         pvs.removePropertyValue(propName);
                     }
                 }
                 bw.setPropertyValues(pvs);
             }
             else {
                 bw.setPropertyValues(pvs, true);
             }
         }
         return job;
     }
 }

3.创建 QuartzConfig类，交给spring容器进行管理

 import org.springframework.beans.BeansException;
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

 /**
  * @Author: Hujh
  * @Date: 2019/7/5 9:39
  * @Description: Quartz相关配置类
  */
 @Configuration
 public class QuartzConfig implements ApplicationContextAware {

     private ApplicationContext applicationContext;

     @Bean
     public SchedulerFactoryBeanCustomizer schedulerFactoryBeanCustomizer() {
         // Spring 项目整合 Quartz  主要依靠添加 SchedulerFactoryBean 这个 FactoryBean
         return schedulerFactoryBean -> schedulerFactoryBean.setJobFactory(new JobBeanFactory(applicationContext));
     }

     /**
      * 初始化加载applicationContext
      */
     @Override
     public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
         this.applicationContext = applicationContext;
     }
 }

4. 创建AOP拦截：JobLogAop

  <!-- aop依赖 -->
  <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-aop</artifactId>
  </dependency>

 import org.aspectj.lang.annotation.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;

 /**
  * @Author: Hujh
  * @Date: 2019/7/4 17:12
  * @Description: 工作调度任务拦截 (日志记录)
  */
 @Component
 @Aspect
 public class JobLogAop {

     private Logger logger = LoggerFactory.getLogger(JobLogAop.class);

     /**
      * 只对于execute切入
      */
     @Pointcut("execution(public void com.ylsp.jobs..*.execute(..))")
     public void pointJobLog(){}

     /**
      * 切点通知(方法执行后)
      */
     @AfterReturning("pointJobLog()")
     public void handlerControllerMethod() {
         logger.info("execute方法执行后..---->> 开始写入日志");
     }

 }

  注：直接创建一个Job,可以看到Aop已经生效。