定时任务quartz的job中注入spring bean时null的问题

定时任务quartz中的job注入spring bean时null的问题

在使用quartz作定时任务的时候难免会注入spring中的管理的bean，如果不作处理，就会出现java.lang.NullPointerException的异常

序言

我们知道quartz中实现一个定时任务有两种方法:

• 实现Job接口
• 继承QuartzJobBean

问题

spring-quartz.xml:

<bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
   <property name="triggers">
       <list>
           <ref bean="jobCron"/>
       </list>
   </property>
</bean>
<bean id="hwJob" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
   <property name="name" value="helloJob"/>
   <property name="group" value="group"/>
   <property name="jobClass" value="com.tian.task.HelloJob"/>
   <property name="durability" value="true"/>
</bean>

<bean id="jobCron" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
   <property name="name" value="helloCron"/>
   <property name="group" value="trigger_group"/>
   <property name="jobDetail" ref="hwJob"/>
   <property name="cronExpression" value="0/1 * * * * ?"/>
</bean>

HelloJob.java:

@Component("helloJob")
public class HelloJob implements Job {

    private static final Logger LOGGER = LoggerFactory.getLogger(HelloJob.class);

    @Autowired
    private HelloService helloService;

    @Override
    public void execute(JobExecutionContext context) throws JobExecutionException {
        LOGGER.info("jos start...");
        LOGGER.info("hello job: "+ new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
        helloService.doHelloService();
        LOGGER.info("jos end...");
    }
}

HelloService.java

@Service
public class HelloService {

    public void doHelloService(){
        System.out.println("invoke HelloService do helloService...");
    }

}

测试案例:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {
        "classpath:spring-context.xml",
        "classpath:mappings/**/*.xml"
})
public class HelloJobTest {

    @Test
    public void helloJobTest() throws InterruptedException {
        Thread.sleep(10000);
        System.out.println("done..");
    }

}

测试结果,经典的空指针异常:

[2018-08-14 09:35:29.474] [ INFO] HelloJob jos start...
[2018-08-14 09:35:29.474] [ INFO] HelloJob hello job: 2018-08-14 09:35:29
[2018-08-14 09:35:29.478] [ERROR] JobRunShell Job group.helloJob threw an unhandled Exception:
java.lang.NullPointerException: null
    at com.pinlor.tian.task.HelloJob.execute(HelloJob.java:31)
    at org.quartz.core.JobRunShell.run(JobRunShell.java:202)
    at org.quartz.simpl.SimpleThreadPool$WorkerThread.run(SimpleThreadPool.java:573)
[2018-08-14 09:35:29.479] [ERROR] ErrorLogger Job (group.helloJob threw an exception.

解决方案

通过继承SpringBeanJobFactory将产生的job注入到spring容器中，这样就能调用spring容器中的其他Bean

SpringQuartzJobFactory.java

@Component("springQuartzJobFactory")
public class SpringQuartzJobFactory extends SpringBeanJobFactory {

    @Autowired
    private AutowireCapableBeanFactory beanFactory;

    @Override
    protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {
        Object obj = super.createJobInstance(bundle);
        beanFactory.autowireBean(obj);
        return obj;
    }
}

修改spring-quartz.xml中的SchedulerFactoryBean增加属性jobFactory为SpringQuartzJobFactory,其他的不变:

<bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    <property name="jobFactory" ref="springQuartzJobFactory"/>
    <property name="triggers">
        <list>
            <ref bean="jobCron"/>
        </list>
    </property>
</bean>

测试结果:

[2018-08-14 10:04:02.002] [ INFO] HelloJob jos start...
[2018-08-14 10:04:02.002] [ INFO] HelloJob hello job: 2018-08-14 10:04:02
invoke HelloService do helloService...
[2018-08-14 10:04:02.002] [ INFO] HelloJob jos end...
done..