quartz 是开源且具有丰富特性的任务调度库,能够集成于任何的java应用,小到独立的应用,大到商业类系统。quartz能够创建多种类型的调度,用来执行成千上万的任务。
个人理解,使用quartz主要在分布式环境下。曾经有个项目,使用spring 的scheduled-tasks实现一个定时器。但是在分布式情况下,该定时任务在每个节点上都执行了。导致任务执行了几遍。这个场景下,就应该使用quartz。
官网 http://www.quartz-scheduler.org/
1 Quartz 知识介绍
1.1 Quartz的体系结构
1.2 核心概念
任务job
job就是你想要实现的任务类。每一个job必须实现org.quartz.job接口,且只需要实现接口定义的execute方法。
触发器trigger
trigger为你执行任务的触发器。比如你想每天定时3点发送一份统计右键。trigger将会设置3点执行该任务。Trigger主要包含两种SimpleTrigger和CronTrigger两种。
调度器scheduler
调度器将任务以及trigger整合起来。负责基于trigger设定的时间来执行job。
下面以一个实例开发,讲解如何使用quartz
2 实例
参考 http://www.quartz-scheduler.org/documentation/quartz-2.3.0/quick-start.html
2.1 准备工作
我在家里开发,连的是阿里的maven仓库,setting文件示例
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
<localRepository>G:\tools\Java\repository</localRepository>
<pluginGroups>
</pluginGroups>
<proxies>
</proxies>
<servers>
</servers>
<mirrors>
<mirror>
<id>alimaven</id>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<mirrorOf>central</mirrorOf>
</mirror>
<mirror>
<id>UK</id>
<mirrorOf>central</mirrorOf>
<url>http://uk.maven.org/maven2</url>
</mirror>
<mirror>
<id>net-cn</id>
<mirrorOf>central</mirrorOf>
<url>http://maven.net.cn/content/groups/public/</url>
</mirror>
</mirrors>
<profiles>
<profile>
<id>ali</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>ali</id>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>ali</id>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
<profile>
<id>net-cn</id>
<repositories>
<repository>
<id>net-cn</id>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>net-cn</id>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
</settings>
2.2 创建maven工程
按照新建maven工程的模板创建即可。创建后的工程形如
这里我们需要引入quartz的两个包
可以搜索 https://maven.aliyun.com/mvn/search 或者 https://mvnrepository.com
<!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz,核心包 -->
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<version>2.3.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz-jobs ,工具包 -->
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz-jobs</artifactId>
<version>2.3.0</version>
</dependency>
此时查看maven工程的依赖lib,可以看到quartz依赖的slf4j-api接口包。另外需要引入slf4j接口log4j实现
介绍:slf4j-api提供接口,slf4j-log4j提供具体的实现。也就是 slf4j只是一个日志标准,并不是日志系统的具体实现,如果项目只有slf4j的包是没有办法实现日志功能的。
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.6</version>
</dependency>
加了log4j以后,需要引入配置文件。 可以在resource下面新增log4j.properties
log4j.rootLogger=INFO, stdout, file
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss}%l%F%p%m%n
log4j.appender.stdout.encoding=UTF-8
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.file=G:\logs\quartz.log
log4j.appender.file.MaxBackupIndex=5
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss}%l%F%p%m%n
log4j.appender.file.bufferSize=10000
log4j.appender.file.encoding=UTF-8
然后再看到工程依赖的jdk版本是1.5的。这个时候可以修改java build path,也可以在pom中增加如下插件
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
<configuration>
<target>1.8</target>
<source>1.8</source>
</configuration>
</plugin>
</plugins>
</build>
2.3 编写代码
新建一个HelloJob,需要继承自org.quartz.Job 。用来模拟一个任务。这里我们让系统打印一个时间
package com.huawei.test.quartz.job;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class HelloJob implements Job {
@Override
public void execute(JobExecutionContext arg0) throws JobExecutionException {
// TODO Auto-generated method stub
Date date = new Date();
SimpleDateFormat formate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
System.out.println("date is " + formate.format(date));
}
}
新建一个控制类 HelloSchedulerDemo
package com.huawei.test.quartz.main;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import com.huawei.test.quartz.job.HelloJob;
public class HelloSchedulerDemo {
public static void main(String[] args) throws SchedulerException {
//需要通过4个步骤,拉起任务
//1、调度器,从工厂中获取调度实例
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
//2、创建任务实例
JobDetail jobDetail = JobBuilder.newJob(HelloJob.class)
.withIdentity("job1","group1")
.build();
//3、创建触发器
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1")
.startNow()
.withSchedule(SimpleScheduleBuilder.simpleSchedule().repeatSecondlyForever(5))
.build();
//4、建立任务和触发器的关联
scheduler.scheduleJob(jobDetail,trigger);
scheduler.start();
}
}
直接右键HelloSchedulerDemo 类,run as java application。
第一个demo完成。