grails中使用quartz编写定时任务

grails可以使用两种方法来编写quartz定时任务

一、使用grails quartz plugin
关于使用quartz插件来做定时任务非常的方便，这里只是把grails对quartz做的插件文档搬了过来，一看应该就明白了

1.引用quartz

这里我使用的是2.0.0.M4版本，官方文档上是1.0.2，这里随意，大丈夫

dependencies {
    compile 'org.grails.plugins:quartz:2.0.0.M4'
}

2.使用quartz

★★Scheduling Jobs
To create a new job run the “grails create-job” command and enter the name of the job. Grails will create a new job and place it in the “grails-app/jobs” directory:
这里使用的是命令行创建，如果不想用命令行，直接在grails-app/jobs下创建Job类即可，但是路径必须是grails-app/jobs这个路径，否则会出错。

class MyJob {
  static triggers = {
    simple name: 'mySimpleTrigger', startDelay: 60000, repeatInterval: 1000  
  }
  def group = "MyGroup"
  def description = "Example job with Simple Trigger"
  def execute(){
    print "Job run!"
  }
}

The above example will wait for 1 minute and after that will call the ‘execute’ method every second. The ‘repeatInterval’ and ‘startDelay’ properties are specified in milliseconds and must have Integer or Long type. If these properties are not specified default values are applied (1 minute for ‘repeatInterval’ property and 30 seconds for ‘startDelay’ property). Jobs can optionally be placed in different groups. The triggers name property must be unique across all triggers in the application.
simple name：triggers 名称——整个项目中不能重复
startDelay：延迟时间（毫秒单位）——多少毫秒后开始执行任务
repeatInterval：任务循环时间（毫秒单位）——任务以多少毫秒循环执行（注意：0：表示执行一次，-1：表示不执行）
By default, jobs will not be executed when running under the test environment.
（默认 任务在test环境下不会执行）

★★Scheduling a Cron Job
Jobs can be scheduled using a cron expression. For those unfamiliar with “cron”, this means being able to create a firing schedule such as: “At 8:00am every Monday through Friday” or “At 1:30am every last Friday of the month”. (See the API docs for the CronTrigger class in Quartz for more info on cron expressions):

class MyJob  {
  static triggers = {
    cron name: 'myTrigger', cronExpression: "0 0 6 * * ?"
  }
 def group = "MyGroup"
 def description = "Example job with Cron Trigger"
 def execute(){
   print "Job run!"
 }
}

The fields in the cronExpression are: (summarizing the Quartz CronTrigger Tutorial)

cronExpression: "s m h D M W Y"
                 | | | | | | `- Year [optional]
                 | | | | | `- Day of Week, 1-7 or SUN-SAT, ?
                 | | | | `- Month, 1-12 or JAN-DEC
                 | | | `- Day of Month, 1-31, ?
                 | | `- Hour, 0-23
                 | `- Minute, 0-59
                 `- Second, 0-59

Year is the only optional field and may be omitted, the rest are mandatory
Day-of-Week and Month are case insensitive, so “DEC” = “dec” = “Dec”
Either Day-of-Week or Day-of-Month must be “?”, or you will get an error since support by the underlying library is not complete. So you can’t specify both fields, nor leave both as the all values wildcard “*”; this is a departure from the unix crontab specification.
See the CronTrigger Tutorial for an explanation of all the special characters you may use.
这里主要说的是quartz的一种定时设置规则，详细的规则可以搜索quartz的定时规则，这里也只是粗略的说了一下

3.配置quartz
以上面的方式配置完毕后，任务默认会以配置的定时方式在项目开启时执行，如果不想设置自启动，可修改配置

Since 0.3 version plugin supports configuration file which is stored in grails-app/conf/QuartzConfig.groovy. The syntax is the same as default Grails configuration file Config.groovy . You could also use per-environment configuration feature (more info).

To have an initial Quartz config file generated for you, type the following in the command line: ‘grails install-quartz-config’ . This will generate a file that looks like this:

quartz {
    autoStartup = true
    jdbcStore = false
}
environments {
    test {
        quartz {
            autoStartup = false
        }
    }
}

Currently supported options:
●autoStartup ：controls automatic startup of the Quartz scheduler during application bootstrap (default: true )
●jdbcStore ：set to true if you want Quartz to persist jobs in your DB (default: false ), you’ll also need to provide quartz.properties file and make sure that required tables exist in your db (see Clustering section below for the sample config and automatic tables creation using Hibernate)

You could also create grails-app/conf/quartz.properties file and provide different options to the Quartz scheduler (see Quartz configuration reference for details).
Logging
A log is auto-injected into your task Job class without having to enable it. To set the logging level, just add something like this to your grails-app/conf/Config.groovy log4j configuration.

debug 'grails.app.jobs'

Hibernate Sessions and Jobs
Jobs are configured by default to have Hibernate Session bounded to thread each time job is executed. This is required if you are using Hibernate code which requires open session (such as lazy loading of collections) or working with domain objects with unique persistent constraint (it uses Hibernate Session behind the scene). If you want to override this behavior (rarely useful) you can use ‘sessionRequired’ property:

def sessionRequired = false

Configuring concurrent execution
By default Jobs are executed in concurrent fashion, so new Job execution can start even if previous execution of the same Job is still running. If you want to override this behavior you can use ‘concurrent’ property, in this case Quartz’s StatefulJob will be used (you can find more info about it here):

def concurrent = false

Configuring description
Quartz allows for each job to have a short description. This may be configured by adding a description field to your Job. The description can be accessed at runtime using the JobManagerService and inspecting the JobDetail object.

def description = "Example Job Description"

Clustering
●Quartz plugin doesn’t support clustering out-of-the-box now. However, you could use standard Quartz clustering configuration. Take a look at the example provided by Burt Beckwith. You’ll also need to set jdbcStore configuration option to true .
●There are also two parameters for configuring store/clustering on jobs ( volatility and durability , both are true by default) and one for triggers ( volatility , also true by default). Volatile job and trigger will not persist between Quartz runs, and durable job will live even when there is no triggers referring to it.
●Read Quartz documentation for more information on clustering and job stores as well as volatility and durability.
●Now that the plugin supports Quartz 2.1.x, you can now use current versions of open source Terracotta see https://github.com/rvanderwerf/terracotta-grails-demo for an example app.

4.延伸理解trigger Understanding Triggers - Reference Documentation

Scheduling configuration syntax
Currently plugin supports three types of triggers:

●simple — executes once per defined interval (ex. “every 10 seconds”);
●cron — executes job with cron expression (ex. “at 8:00am every Monday through Friday”);
●custom — your implementation of Trigger interface.
Multiple triggers per job are allowed.

class MyJob {
  static triggers = {
    simple name:'simpleTrigger', startDelay:10000, repeatInterval: 30000, repeatCount: 10
    cron name:'cronTrigger', startDelay:10000, cronExpression: '0/6 * 15 * * ?'
    custom name:'customTrigger', triggerClass:MyTriggerClass, myParam:myValue, myAnotherParam:myAnotherValue
  }
  def execute() {
    println "Job run!"
  }
}

With this configuration job will be executed 11 times with 30 seconds interval with first run in 10 seconds after scheduler startup (simple trigger), also it’ll be executed each 6 second during 15th hour (15:00:00, 15:00:06, 15:00:12, … — this configured by cron trigger) and also it’ll be executed each time your custom trigger will fire.
Three kinds of triggers are supported with the following parameters:
●simple:
name — the name that identifies the trigger;
startDelay — delay (in milliseconds) between scheduler startup and first job’s execution;
repeatInterval — timeout (in milliseconds) between consecutive job’s executions;
repeatCount — trigger will fire job execution (1 + repeatCount) times and stop after that (specify 0 here to have one-shot job or -1 to repeat job executions indefinitely);
●cron:
name — the name that identifies the trigger;
startDelay — delay (in milliseconds) between scheduler startup and first job’s execution;
cronExpression — cron expression
●custom:
triggerClass — your class which implements Trigger interface;

any params needed by your trigger.

Dynamic Jobs Scheduling

Starting from 0.4.1 version you have the ability to schedule job executions dynamically.
These methods are available:

// creates cron trigger;
MyJob.schedule(String cronExpression, Map params?)
//  creates simple trigger: repeats job repeatCount+1 times with delay of repeatInterval milliseconds;
MyJob.schedule(Long repeatInterval, Integer repeatCount?, Map params?) )

// schedules one job execution to the specific date;
MyJob.schedule(Date scheduleDate, Map params?)

//schedules job's execution with a custom trigger;
MyJob.schedule(Trigger trigger)

// force immediate execution of the job.
MyJob.triggerNow(Map params?)

// Each method (except the one for custom trigger) takes optional 'params' argument. 
// You can use it to pass some data to your job and then access it from the job:
class MyJob { 
  def execute(context) {
    println context.mergedJobDataMap.get('foo')
  }
}
// now in your controller (or service, or something else):

MyJob.triggerNow([foo:"It Works!"])

二、使用传统quartz的配置

1.编写任务

class MyJob implements Job {

    public void execute(JobExecutionContext jobExecutionContext) {
        //编写任务
    }
}

2.配置quartz

/**
 * 定时任务配置
 * @param jobName 任务名称
 * @param triggerName 定时器名称
 * @param groupName 任务组名称
 * @param regularRules 定时规则
 * @return
 */
class QuartzUtil {

    private static Scheduler scheduler ;

    private  static CronTrigger trigger;

    /**
     * 添加一个Job任务
     * @param jobName
     * @param triggerName
     * @param groupName
     * @param regularRules
     * @return
     * @throws Exception
     */
    static createJobAndStart(String jobName,String triggerName,String groupName,String regularRules) throws Exception{

        scheduler = new StdSchedulerFactory().getScheduler();
        JobDetail jobDetail = null;
        //创建job
        jobDetail = JobBuilder.newJob(MyJob.class)
                .withIdentity(jobName,groupName).build();

        // 创建trigger
        trigger = TriggerBuilder.newTrigger()
                .withIdentity(triggerName,groupName)
                .withSchedule(CronScheduleBuilder.cronSchedule(regularRules))
                .build();
        scheduler.scheduleJob(jobDetail, trigger);
        startQuartz();
    }

    /**
     * 启动调度器
     */
    static startQuartz(){
        scheduler.start();
    }

    /**
     * 关闭调度器
     * @return
     */
    static shutdownQuartz(){
        scheduler.shutdown(false);
    }

    /**
     * 替换一个job
     */
    static replaceJob(String jobName,String groupName){
        JobDetail jobDetail = JobBuilder.newJob(MyOtherJob.class)
                .withIdentity(jobName,groupName).build();
        scheduler.addJob(jobDetail,true);
    }

    /**
    * 判断trigger是否存在
    */
    static ifExistByTrigger(){
        if(trigger){
           return true;
        }
        else return false;
    }
    /**
     * 更新一个trigger
     */
    static boolean updateTrigger(String triggerName ,String groupName,String regularRules,String type){
        boolean flag = false;
        scheduler = new StdSchedulerFactory().getScheduler();
        try {
            if(trigger && trigger.getKey()){
                CronTrigger trigger1 = TriggerBuilder.newTrigger()
                        .withIdentity(triggerName,groupName)
                        .withSchedule(CronScheduleBuilder.cronSchedule(regularRules))
                        .build();
                scheduler.rescheduleJob(trigger.getKey(), trigger1);
            }
            else{
                createJobAndStart("job1",triggerName,groupName,regularRules,type)
            }
            flag = true;
        } catch (Exception e) {
            LogUtil.logError("Quartz定时器更新Trigger出错，错误信息："+e.message);
        }
        return flag;
    }

    /**
     * @Description: 移除一个任务
     *
     * @param jobName
     * @param jobGroupName
     * @param triggerName
     * @param triggerGroupName
     */
    public static void removeJob(String jobName, String jobGroupName,
                                 String triggerName, String triggerGroupName) {
        try {
            scheduler = new StdSchedulerFactory().getScheduler();
            scheduler.pauseTrigger(triggerName, triggerGroupName);// 停止触发器
            scheduler.unscheduleJob(triggerName, triggerGroupName);// 移除触发器
            scheduler.deleteJob(jobName, jobGroupName);// 删除任务
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * @Description: 移除类中的trigger
     *
     */
    public static void removeTrigger() {
        if(trigger != null){
            trigger = null;
        }
    }
}

3.启动任务

try {
                            boolean quartzFlag = QuartzUtil.updateTrigger("trigger1","group1","0 0/10 * * * ?");
                        } catch (Exception e) {
                            LogUtil.logError(e.message);
                            return;
                        }

我这里把创建和更新任务放到一个方法去了，因为业务涉及到了更新任务，如果不需要则可以直接调用创建方法即可