Java定时任务详解

发布时间：2020-10-18 02:46:08 作者：wuzhiyuan
来源：脚本之家阅读：123

定时任务在项目中经常会使用到，本文主要根据博主自己使用定时的经验分如下几点介绍定时任务：

1、Quartz定时任务简介及Spring配置Quartz定时任务

2、SchedulerFactory对定时任务进行增删改查

3、总结

Quartz定时任务简介：

Quartz是项目中经常用到的定时任务之一，是一个完全由java编写的开源作业调度框架，可以与J2EE与J2SE应用程序相结合也可以单独使用，其主要组成部分包括Job、Scheduler、CronExpression，这里就不一一介绍了，下面介绍Spring如何配置Quartz。

配置Quartz需要明白的一点是配置Quartz即配置Job、Scheduler和CronExpression，这三部分配置完成后，就是一个完整的定时任务，配置如下：

<bean id= "TestJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean"> 
　　<property name="jobClass" value="xx.TestQuartzJob"/>
　　<!-- 可以封装各种数据到JobExecutionContext里，包括接口、类，其中testServiceImpl是Spring管理的Bean，需要什么声明 --> 
　　<property name="jobDataAsMap"> 
　　　　<map> 
　　　　　　<entry key="test" value="test"/>
　　　　　　<entry key ="testServiceImpl" value-ref="testServiceImpl"/>
　　　　</map> 
　　</property> 
</bean>

<bean id= "TestTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean"> 
　　<property name="jobDetail" ref="TestJobDetail" /> 
　　<property name="cronExpression" value="0 0/1 * * * ?" />
</bean>

<bean id= "testSchedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> 
　　<property name="triggers" > 
　　　　<list> 
　　　　　　<ref bean="TestTrigger" /> 
　　　　</list> 
　　</property> 
</bean>
<bean id="testServiceImpl" class="xx.service.impl.TestServiceImpl">

配置完成后，就是增加一个为你执行一个任务的Java类。每一个Quartz Job必须有一个实现了org.quartz.Job接口的具体类，代码如下：

public class TestQuartzJob extends QuartzJobBean {
　　@Override
　　protected void executeInternal(JobExecutionContext arg0) throws JobExecutionException
　　{
　　　　// 获取Job配置的接口
　　　　TestServiceImpl testServiceImpl = (TestServiceImpl) arg0.getJobDetail().getJobDataMap().get("testServiceImpl");
　　　　// 执行业务方法
　　　　quartzStart();
　　}
　　public void quartzStart(){
　　　　// 业务方法...
　　}
}

当然，在Job中其实不用特意的配置接口，使用Spring的注入即可，这里只是把这个配置接口的方法进行说明。

到这里，简单的配置Quartz定时任务已经完成，下面附加一个我在项目中使用Quartz的情形：cronExpression表达式从数据库读取。

当时，我解决这个问题的方法是继承org.springframework.scheduling.quartz.CronTriggerBean，设置cronExpression，具体代码如下：

Trigger的配置要改：

<bean id="TestTrigger" class="xx.InitCronTriggerFactoryBean">
　　<property name="jobDetail" ref="TestJobDetail" />
　　<property name="key" value="key" />
</bean>

xx.InitCronTriggerFactoryBean代码：

public class InitCronTriggerFactoryBean extends CronTriggerFactoryBean implements Serializable {

　　private static final long serialVersionUID = 1L;

　　@Resource
　　private SysParamService sysParamService;

　　private String key;

　　public void setKey(String key)
　　{
　　　　this.key = key;

　　　　setCronExpression(getCronExpressionFromDB());
　　}

　　private String getCronExpressionFromDB()
　　{
　　　　if(StringUtils.isEmpty(key))
　　　　　　return "0 0/5 * * * ?";

　　　　SysParam sysParam = new SysParam();

　　　　try
　　　　{
　　　　　　sysParam = sysParamService.getNameByKey(key);
　　　　}
　　　　catch (Exception e)
　　　　{
　　　　　　e.printStackTrace();
　　　　}

　　　　if(sysParam != null && !StringUtils.isEmpty(sysParam.getParamValue()))
　　　　　　return sysParam.getParamValue();

　　　　return "0 0/5 * * * ?";
　　}
}

其中，SysParamService是根据key到数据库查询对应的cronExpression表达式的接口，这个接口除了使用Spring注入，也可以使用set方法设置，如下：

<bean id="TestTrigger" class="xx.InitCronTriggerFactoryBean">
　　<property name="jobDetail" ref="TestJobDetail" />
　　<property name="key" value="key" />
　　<property name="sysParamService" ref="sysParamService" />
</bean>
<bean id="sysParamService" class="xx.service.impl.SysParamServiceImpl">

这样，在xx.InitCronTriggerFactoryBean就要加入sysParamService的set方法，此时的xx.InitCronTriggerFactoryBean代码为：

public class InitCronTriggerFactoryBean extends CronTriggerFactoryBean implements Serializable {
　　private static final long serialVersionUID = 1L;
　　private SysParamServiceImpl sysParamService;
　　private String key;
　　public void setKey(String key)
　　{
　　　　this.key = key;
　　}
　　public void setSysParamService(SysParamServiceImpl sysParamService)
　　{
　　　　this.sysParamService = sysParamService;
　　　　setCronExpression(getCronExpressionFromDB());
　　}
　　private String getCronExpressionFromDB()
　　{
　　　　if(StringUtils.isEmpty(key))
　　　　　　return "0 0 0/1 * * ?";
　　　　SysParam sysParam = new SysParam();
　　　　try
　　　　{
　　　　　　sysParam = sysParamServiceImpl.getNameByKey(key);
　　　　}
　　　　catch (Exception e)
　　　　{
　　　　　　e.printStackTrace();
　　　　}
　　　　if(sysParam != null && !StringUtils.isEmpty(sysParam.getParamValue()))
　　　　　　return sysParam.getParamValue();
　　　　return "0 0 0/1 * * ?";
　　}
}

Quartz定时任务到这里就差不多了，基本的配置和使用就是上面将的，想要深入了解Quartz可以在网上查找更多的资料，并在实践中使用。接下来将讲解在项目中使用的可以随时对定时任务进行增删改查操作的实例。

定时任务的增删改查，其实可以看做是对数据进行增删改查。不过，定时任务的增删改查是操作Job和Trigger，具体代码如下：

定时任务管理器代码：

public class QuartzManager {

　　private static final Logger logger = LogPresident.getRootLogger();

　　private static SchedulerFactory schedulerFactory = new StdSchedulerFactory();

　　private static Map<String, JobKey> jobKeyMap = new HashMap<String, JobKey>();

　　/**
　　* 增加一个定时任务
　　* @author zhiyuan.wu
　　* @date 2017年3月30日
　　* @param jobName
　　* @param triggerName
　　* @param cls
　　* @param date
　　*/
　　@SuppressWarnings({ "rawtypes", "unchecked" })
　　public static void addJob(String jobName, String triggerName, Class cls, Date date)
　　{
　　　　try
　　　　{
　　　　　　Scheduler scheduler = schedulerFactory.getScheduler();

　　　　　　// job
　　　　　　JobDetail jobDetail = JobBuilder.newJob(cls).withIdentity(jobName, Scheduler.DEFAULT_GROUP).build();

　　　　　　// 触发器
　　　　　　SimpleTrigger trigger = (SimpleTrigger) TriggerBuilder.newTrigger().withIdentity(triggerName, Scheduler.DEFAULT_GROUP).startAt(date).build();

　　　　　　scheduler.scheduleJob(jobDetail, trigger);

　　　　　　// 启动
　　　　　　scheduler.start();

　　　　　　jobKeyMap.put(jobDetail.getKey().getName(), jobDetail.getKey());
　　　　}
　　　　catch (Exception e)
　　　　{
　　　　　　logger.error("--------添加定时任务出错：" + e.getMessage(), e);
　　　　}
　　}

/**
* 删除对应的定时任务
* @author zhiyuan.wu
* @date 2017年3月29日
* @param jobKey
*/
public static void removeJob(JobKey jobKey)
{
　　Scheduler scheduler;
　　try
　　{
　　　　scheduler = schedulerFactory.getScheduler();
　　　　scheduler.deleteJob(jobKey);

　　　　　　jobKeyMap.remove(jobKey.getName());
　　　　}
　　　　catch (SchedulerException e)
　　　　{
　　　　　　logger.error("--------删除定时任务出错：" + e.getMessage(), e);
　　　　}
　　}

/**
* 启动所有定时任务
* @author zhiyuan.wu
* @date 2017年3月29日
*/
public static void startJobs()
{
　　try
　　{
　　　　Scheduler sched = schedulerFactory.getScheduler();
　　　　sched.start();
　　}
　　catch (Exception e)
　　{
　　　　logger.error("--------启动所有定时任务出错：" + e.getMessage(), e);
　　}
}

/**
* 停止所有定时任务
* @author zhiyuan.wu
* @date 2017年3月29日
*/
public static void shutdownJobs()
{
　　try
　　{
　　　　Scheduler sched = schedulerFactory.getScheduler();

　　　　if (!sched.isShutdown())
　　　　{
　　　　　　sched.shutdown();
　　　　}
　　}
　　catch (Exception e)
　　{
　　　　logger.error("--------停止所有定时任务出错：" + e.getMessage(), e);
　　}
}

/**
* 修改定时任务
* @author zhiyuan.wu
* @date 2017年3月29日
* @param jobKey
* @param jobName
* @param triggerName
* @param cls
* @param date
*/
@SuppressWarnings("rawtypes")
public static void modifyJobTime(JobKey jobKey, String jobName, String triggerName, Class cls, Date date)
{
　　try
　　{
　　　　removeJob(jobKey);

　　　　addJob(jobName, triggerName, cls, date);
　　}
　　catch (Exception e)
　　{
　　　　logger.error("--------修改定时任务出错：" + e.getMessage(), e);
　　}
}

/**
* 打印当前定时任务的jobName
* @author zhiyuan.wu
* @date 2017年3月29日
* @throws SchedulerException
*/
public static void printJobName() throws SchedulerException
{
　　for (String jobName : jobKeyMap.keySet())
　　{
　　　　logger.info("--------jobName:" + jobName);
　　}
}
}

Job代码：

public class TestJob implements Job {

　　private static final Logger logger = LogPresident.getRootLogger();

　　public void execute(JobExecutionContext context) throws JobExecutionException
　　{
　　　　JobKey jobKey = context.getJobDetail().getKey();

　　　　logger.info("--------定时任务开始执行：" + jobKey.getName());

　　　　// 业务方法...
　　　　// 移除定时任务
　　　　QuartzManager.removeJob(jobKey);
　　}
}

增加一个定时任务代码：

QuartzManager.addJob(JobName, TriggerName , TestJob.class, Date);

这样，在到达时间Date时，定时任务将会执行。不过这样增加的任务是保存在内存中，项目重启将会丢失定时任务，所以，最好增加一个类，在项目启动时将会扫描数据库，将未执行的定时任务重新加载到内存中去。

定时任务在项目中运用需要根据业务具体调整，但只要弄清楚定时任务的原理和实现，那么就可以在项目中灵活运它用来具体的业务，希望这篇文章可以让大家快速了解和运用定时任务，并运用到实践中。

以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，同时也希望多多支持亿速云!

Java定时任务详解

相关阅读