美文网首页
Quartz(一) 定义和demo

Quartz(一) 定义和demo

作者: guideEmotion | 来源:发表于2019-07-15 23:25 被阅读0次

    一 介绍

    Quartz是完全由java开发的一个开源任务日程管理系统,“任务进度管理器”就是一个在预先确定(被纳入日程)的时间到达时,负责执行(或者通知)其他软件组件的系统。

    核心

    • 任务:JobDetail:实现类里面是我们要执行的任务
    • 触发器:Trigger,包括SimpleTrigger和CronTrigger:指定Job的执行时间,执行间隔,运行次数等。
    • 调度器:Scheduler:结合上面两者

    存储方式

    RAMJobStore

    优点:不要外部数据库,配置容易,运行速度快
    缺点:因为调度程序信息是存储在被分配给JVM的内存里面,所以,当应用程序停止运行时,所有调度信息将被丢失。另外因为存储到JVM内存里面,所以可以存储多少个Job和Trigger将会受到限制(数量有限制)

    JDBCJobStore

    优点:支持集群,因为所有的任务信息都会保存到数据库中,可以控制事务,还有就是如果应用服务器关闭或者重启,任务信息都不会丢失,并且可以恢复因服务器关闭或者重启而导致执行失败的任务
    缺点:运行速度的快慢取决与连接数据库的快慢

    表关系和解释

    表关系

    image.png

    解释

    表名称 说明
    qrtz_blob_triggers Trigger作为Blob类型存储(用于Quartz用户用JDBC创建他们自己定制的Trigger类型,JobStore 并不知道如何存储实例的时候)
    qrtz_calendars Blob类型存储Quartz的Calendar日历信息, quartz可配置一个日历来指定一个时间范围
    qrtz_cron_triggers 存储Cron Trigger,包括Cron表达式和时区信息。
    qrtz_fired_triggers 存储与已触发的Trigger相关的状态信息,以及相联Job的执行信息
    qrtz_job_details 存储每一个已配置的Job的详细信息
    qrtz_locks 存储程序的非观锁的信息(假如使用了悲观锁)
    qrtz_paused_trigger_graps 存储已暂停的Trigger组的信息
    qrtz_scheduler_state 存储少量的有关 Scheduler的状态信息,和别的 Scheduler 实例(假如是用于一个集群中)
    qrtz_simple_triggers 存储简单的 Trigger,包括重复次数,间隔,以及已触的次数
    qrtz_triggers 存储已配置的 Trigger的信息
    qrzt_simprop_triggers

    二 类相关

    常用类

    • Job和JobDetail
      = JobExecutionContext
    • JobDataMap
    • Trigger、SimpleTrigger、CronTrigger

    Job和JobDetail

    Job是Quartz中的一个接口,接口下只有execute方法,在这个方法中编写业务逻辑

    JobDetail·用来·绑定Job·,为Job实例提供许多属性:

    • name
    • group
    • jobClass
    • jobDataMap
      JobDetail绑定指定的Job,每次Scheduler调度执行一个Job的时候,首先会拿到对应的Job,然后创建该Job实例,再去执行Job中的execute()的内容,任务执行结束后,关联的Job对象实例会被释放,且会被JVM GC清除

    为什么分组?
    mailgroup就是分组的意思。
    比如一个系统有3个job 是备份数据库的,有4个job 是发邮件的,那么对他们进行分组,可以方便管理,类似于一次性停止所有发邮件的这样的操作.

    为什么设计成JobDetail + Job,不直接使用Job?
    JobDetail定义的是任务数据,而真正的执行逻辑是在Job中。
    这是因为任务是有可能并发执行,如果Scheduler直接使用Job,就会存在对同一个Job实例并发访问的问题。而JobDetail & Job 方式,Sheduler每次执行,都会根据JobDetail创建一个新的Job实例,这样就可以规避并发访问的问题。(一个job可以被多个定时任务同时用)

    JobExecutionContext

    JobExecutionContext中包含了Quartz运行时的环境以及Job本身的详细数据信息。
    当Schedule调度执行一个Job的时候,就会将JobExecutionContext传递给该Job的execute()中,Job就可以通过JobExecutionContext对象获取信息

    JobDataMap

    方式一
    obDataMap实现了JDK的Map接口,可以以Key-Value的形式存储数据。
    JobDetail、Trigger都可以使用JobDataMap来设置一些参数或信息,

    JobBuilder.newJob(PrintWordsJob.class).usingJobData("jobDetail1", "这个Job用来测试的")...
    jobExecutionContext.getJobDetail().getJobDataMap().get("jobDetail1")
    
    TriggerBuilder.newTrigger().withIdentity("trigger1", "triggerGroup1")
          .usingJobData("trigger1", "这是jobDetail1的trigger")
            ...
    jobExecutionContext.getTrigger().getJobDataMap().get("trigger1")
    

    方式二

            //定义一个JobDetail
            JobDetail job = newJob(MailJob.class)
                .withIdentity("mailjob1", "mailgroup")
                .usingJobData("email", "admin@10086.com")
                .build();
             
            //用JobDataMap 修改email
            job.getJobDataMap().put("email", "admin@taobao.com");
    

    Trigger

    Trigger是Quartz的触发器,会去通知Scheduler何时去执行对应Job。

    new Trigger().startAt():表示触发器首次被触发的时间;
    new Trigger().endAt():表示触发器结束触发的时间;
    

    SimpleTrigger

    SimpleTrigger可以实现在一个指定时间段内执行一次作业任务或一个时间段内多次执行作业任务。
    下面的程序就实现了程序运行5s后开始执行Job,执行Job 5s后结束执行:

    Date startDate = new Date();
    startDate.setTime(startDate.getTime() + 5000);
    
     Date endDate = new Date();
     endDate.setTime(startDate.getTime() + 5000);
    
            Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "triggerGroup1")
                    .usingJobData("trigger1", "这是jobDetail1的trigger")
                    .startNow()//立即生效
                    .startAt(startDate)
                    .endAt(endDate)
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule()
                    .withIntervalInSeconds(1)//每隔1s执行一次
                    .repeatForever()).build();//一直执行
    
    

    CronTrigger

    CronTrigger功能非常强大,是基于日历的作业调度,而SimpleTrigger是精准指定间隔,所以相比SimpleTrigger,CroTrigger更加常用。CroTrigger是基于Cron表达式的,先了解下Cron表达式:

    [秒] [分] [小时] [日] [月] [周] [年]
    可通过在线生成Cron表达式的工具:http://cron.qqe2.com/ 来生成自己想要的表达式。

    关系

    image.png
    一个job可以被多个Trigger 绑定,但是一个Trigger只能绑定一个job!

    配置文件

    quartz.properties

    //调度标识名 集群中每一个实例都必须使用相同的名称 (区分特定的调度器实例)
    org.quartz.scheduler.instanceName:DefaultQuartzScheduler
    //ID设置为自动获取 每一个必须不同 (所有调度器实例中是唯一的)
    org.quartz.scheduler.instanceId :AUTO
    //数据保存方式为持久化 
    org.quartz.jobStore.class :org.quartz.impl.jdbcjobstore.JobStoreTX
    //表的前缀 
    org.quartz.jobStore.tablePrefix : QRTZ_
    //设置为TRUE不会出现序列化非字符串类到 BLOB 时产生的类版本问题
    //org.quartz.jobStore.useProperties : true
    //加入集群 true 为集群 false不是集群
    org.quartz.jobStore.isClustered : false
    //调度实例失效的检查时间间隔 
    org.quartz.jobStore.clusterCheckinInterval:20000 
    //容许的最大作业延长时间 
    org.quartz.jobStore.misfireThreshold :60000
    //ThreadPool 实现的类名 
    org.quartz.threadPool.class:org.quartz.simpl.SimpleThreadPool
    //线程数量 
    org.quartz.threadPool.threadCount : 10
    //线程优先级 
    org.quartz.threadPool.threadPriority : 5(threadPriority 属性的最大值是常量 java.lang.Thread.MAX_PRIORITY,等于10。最小值为常量 java.lang.Thread.MIN_PRIORITY,为1)
    //自创建父线程
    //org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread: true 
    //数据库别名
    org.quartz.jobStore.dataSource : qzDS
    //设置数据源
    org.quartz.dataSource.qzDS.driver:com.mysql.jdbc.Driver
    org.quartz.dataSource.qzDS.URL:jdbc:mysql://localhost:3306/quartz
    org.quartz.dataSource.qzDS.user:root
    org.quartz.dataSource.qzDS.password:123456
    org.quartz.dataSource.qzDS.maxConnection:10
    
    

    三 demo

    由于Quartz的存储方式分为RAM和JDBC,分别对这两种进行简单的说明。

    RAM方式

    依赖

    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.zyc</groupId>
        <artifactId>quartzDemo</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <dependencies>
    
            <!-- quartz -->
            <dependency>
                <groupId>org.quartz-scheduler</groupId>
                <artifactId>quartz</artifactId>
                <version>2.2.1</version>
            </dependency>
            <dependency>
                <groupId>org.quartz-scheduler</groupId>
                <artifactId>quartz-jobs</artifactId>
                <version>2.2.1</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.0.11</version>
            </dependency>
    
    
        </dependencies>
    
    
    </project>
    

    Job类

    里面写定时任务的执行代码

    package com.zyc;
    
    import java.util.Date;
    import org.quartz.Job;
    import org.quartz.JobExecutionContext;
    import org.quartz.JobExecutionException;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class RAMJob implements Job{
    
        private static Logger logger = LoggerFactory.getLogger(RAMJob.class);
    
    
        public void execute(JobExecutionContext arg0) throws JobExecutionException {
    
            logger.info("Say hello to Quartz" + new Date());
        }
    
    }
    

    测试类

    CronScheduleBuilder

    
    import java.util.Date;
    
    import org.quartz.CronScheduleBuilder;
    import org.quartz.JobBuilder;
    import org.quartz.JobDetail;
    import org.quartz.Scheduler;
    import org.quartz.SchedulerException;
    import org.quartz.SchedulerFactory;
    import org.quartz.SimpleScheduleBuilder;
    import org.quartz.Trigger;
    import org.quartz.TriggerBuilder;
    import org.quartz.impl.StdSchedulerFactory;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    /**
     * This is a RAM Store Quartz!
     * @author dufy
     * @date 2017.02.04
     *
     */
    public class RAMQuartzTest {
    
        private static Logger _log = LoggerFactory.getLogger(RAMQuartzTest.class);
    
        public static void main(String[] args) throws SchedulerException {
            //1.创建Scheduler的工厂
            SchedulerFactory sf = new StdSchedulerFactory();
            //2.从工厂中获取调度器实例
            Scheduler scheduler = sf.getScheduler();
    
    
            //3.创建JobDetail
            JobDetail jb = JobBuilder.newJob(RAMJob.class)
                    .withDescription("this is a ram job") //job的描述
                    .withIdentity("ramJob", "ramGroup") //job 的name和group
                    .build();
    
            //任务运行的时间,SimpleSchedle类型触发器有效
            long time=  System.currentTimeMillis() + 13*1000L; //13秒后启动任务
            Date statTime = new Date(time);
    
            //4.创建Trigger
            //使用SimpleScheduleBuilder或者CronScheduleBuilder
            Trigger t = TriggerBuilder.newTrigger()
                    .withDescription("")
                    .withIdentity("ramTrigger", "ramTriggerGroup")
                    //.withSchedule(SimpleScheduleBuilder.simpleSchedule())
                    .startAt(statTime)  //默认当前时间启动
                    .withSchedule(CronScheduleBuilder.cronSchedule("0/2 * * * * ?")) //两秒执行一次
                    .build();
    
            //5.注册任务和定时器
            scheduler.scheduleJob(jb, t);
    
            //6.启动 调度器
            scheduler.start();
            _log.info("启动时间 : " + new Date());
            //scheduler.shutdown();
    
        }
    }
    

    SimpleScheduleBuilder

            //4.创建Trigger
            //使用SimpleScheduleBuilder或者CronScheduleBuilder
            Trigger t = TriggerBuilder.newTrigger()
                    .withDescription("")
                    .withIdentity("ramTrigger", "ramTriggerGroup")
                    .withSchedule(SimpleScheduleBuilder.simpleSchedule())
                    .startAt(statTime)  //默认当前时间启动
    //                .withSchedule(CronScheduleBuilder.cronSchedule("0/2 * * * * ?")) //两秒执行一次
                    .build();
    

    参考

    1. 精进 Quartz—Quartz大致介绍(一)
    2. 精进Quartz—Quartz简单入门Demo(二)
    3. 定时任务框架Quartz-(一)Quartz入门与Demo搭建
    4. http://how2j.cn/k/quartz/quartz-job/1708.html#nowhere

    相关文章

      网友评论

          本文标题:Quartz(一) 定义和demo

          本文链接:https://www.haomeiwen.com/subject/cmvokctx.html