對xxl-job進行simpleTrigger並動態建立任務擴充套件

大萌小路發表於2019-05-09
套件

業務場景

需求上要求能實現quartz的simpleTrigger任務，同時還需要動態的建立任務而非在控制皮膚上建立，查閱xxl-job官方文件發現simpelTrigger其暫時還躺在to do list，而動態建立可以呼叫JobInfoController其add和start介面(但是有個弊端，start/stop/remove等方法都只要求傳送id，這點上可以自己擴充套件介面實現)，還需要放開登入許可權，接下來就老夫上去就上一梭子，開幹。

job_info欄位調整說明

CREATE TABLE `XXL_JOB_QRTZ_TRIGGER_INFO` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `job_group` int(11) NOT NULL COMMENT '執行器主鍵ID',
  `job_cron` varchar(128) DEFAULT NULL COMMENT '任務執行CRON',
  `job_desc` varchar(255) NOT NULL,
  `add_time` datetime DEFAULT NULL,
  `update_time` datetime DEFAULT NULL,
  `author` varchar(64) DEFAULT NULL COMMENT '作者',
  `alarm_email` varchar(255) DEFAULT NULL COMMENT '報警郵件',
  `executor_route_strategy` varchar(50) DEFAULT NULL COMMENT '執行器路由策略',
  `executor_handler` varchar(255) DEFAULT NULL COMMENT '執行器任務handler',
  `executor_param` varchar(512) DEFAULT NULL COMMENT '執行器任務引數',
  `executor_block_strategy` varchar(50) DEFAULT NULL COMMENT '阻塞處理策略',
  `executor_timeout` int(11) NOT NULL DEFAULT '0' COMMENT '任務執行超時時間，單位秒',
  `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失敗重試次數',
  `glue_type` varchar(50) NOT NULL COMMENT 'GLUE型別',
  `glue_source` mediumtext COMMENT 'GLUE原始碼',
  `glue_remark` varchar(128) DEFAULT NULL COMMENT 'GLUE備註',
  `glue_updatetime` datetime DEFAULT NULL COMMENT 'GLUE更新時間',
  `child_jobid` varchar(255) DEFAULT NULL COMMENT '子任務ID，多個逗號分隔',
  `ext_reamrk` varchar(255) DEFAULT NULL,
  `job_start_time` bigint(20) DEFAULT NULL COMMENT 'trigger開始時間於當前時間的時間間隔 單位毫秒\n',
  `job_end_time` datetime DEFAULT NULL COMMENT 'trigger結束時間',
  `job_repeat_count` bigint(7) DEFAULT '-1' COMMENT 'simple_trigger 執行次數 ',
  `job_repeat_interval` bigint(12) DEFAULT NULL COMMENT 'simple_trigger 時間間隔 單位毫秒',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
  • job_cron設為空，支援simpleTrigger；
  • ext_reamrk自定義擴充套件欄位，可以根據它來刷選job從而避免start/stop/remove介面只有id作為引數；
  • job_repeat_count，simplerTrigger的執行次數，預設-1即為無限次，0的話是執行1次；
  • job_repeat_interval，simplerTrigger每次執行的時間間隔，單位毫秒；
  • job_start_time，trigger開始時間和當前時間的時間間隔，單位毫秒；
  • job_end_time，trigger結束時間

重寫啟動任務

xxl-job在新建任務的時候只是把job資料儲存到資料庫裡，只有啟動的時候才會建立jobDetail和trigger並由scheduler來啟動job。

重寫XxlJobDynamicScheduler的addJob方法：根據jobInfo中的值構建cron的trigger還是simple的trigger。

public static boolean addJob(XxlJobInfo xxlJobInfo) throws SchedulerException {
        String jobName = String.valueOf(xxlJobInfo.getId());
        String cronExpression = xxlJobInfo.getJobCron();
        Integer jobRepeatCount = xxlJobInfo.getJobRepeatCount();
        Long jobRepeatInterval = xxlJobInfo.getJobRepeatInterval();

        // 1、job key
        TriggerKey triggerKey = TriggerKey.triggerKey(jobName);
        JobKey jobKey = new JobKey(jobName);

        // 2、valid trigger
        if(scheduler.checkExists(triggerKey)) {
            return true;
        }

        // 3.1、corn trigger
        Trigger trigger = null;
        if (!StringUtils.isEmpty(cronExpression)) {
            CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(cronExpression).withMisfireHandlingInstructionDoNothing();   // withMisfireHandlingInstructionDoNothing 忽略掉排程終止過程中忽略的排程
            TriggerBuilder<CronTrigger> builder = TriggerBuilder.newTrigger().withIdentity(triggerKey)
                    .withSchedule(cronScheduleBuilder)
                    .endAt(xxlJobInfo.getJobEndTime());
            Optional.ofNullable(xxlJobInfo.getJobStartTime())
                    .ifPresent(start -> builder.startAt(new Date(System.currentTimeMillis() + start)));
            trigger = builder.build();
        } else
        // 3.2、simple trigger
        if (Objects.nonNull(jobRepeatInterval) && Objects.nonNull(jobRepeatCount)) {
            SimpleScheduleBuilder simpleScheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                    .withIntervalInMilliseconds(jobRepeatInterval)
                    .withRepeatCount(jobRepeatCount);
            TriggerBuilder<SimpleTrigger> builder = TriggerBuilder.newTrigger().withIdentity(triggerKey)
                    .withSchedule(simpleScheduleBuilder)
                    .endAt(xxlJobInfo.getJobEndTime());
            Optional.ofNullable(xxlJobInfo.getJobStartTime())
                    .ifPresent(start -> builder.startAt(new Date(System.currentTimeMillis() + start)));
            trigger = builder.build();
        }
        // 3.3、valid trigger
        if(Objects.isNull(trigger)) {
            return true;
        }

        // 4、job detail
        Class<? extends Job> jobClass_ = RemoteHttpJobBean.class;   // Class.forName(jobInfo.getJobClass());
        JobDetail jobDetail = JobBuilder.newJob(jobClass_).withIdentity(jobKey).build();

        /*if (jobInfo.getJobData()!=null) {
            JobDataMap jobDataMap = jobDetail.getJobDataMap();
            jobDataMap.putAll(JacksonUtil.readValue(jobInfo.getJobData(), Map.class));  
            // JobExecutionContext context.getMergedJobDataMap().get("mailGuid");
        }*/
        
        // 5、schedule job
        Date date = scheduler.scheduleJob(jobDetail, trigger);

        logger.info(">>>>>>>>>>> addJob success(quartz), jobDetail:{}, trigger:{}, date:{}", jobDetail, trigger, date);
        return true;
    }

效果圖

img

image-20190508165249933

image-20190508165315058

可以看到將資料庫裡3任務改為間隔3秒，job_repeat_count為1，任務實際會執行2次。

額外的工作

  1. 雖然支援cron或simple，但是在控制檯節目只能維護cron的trigger，並且優先cron，同時cron設為可以為空，但是管理平臺上沒有simple的相關資料，如果需要的話要重新修改對應的頁面和add和update的邏輯；
  2. job狀態取的是trigger的狀態，所以可能看到的是simpleTrigger的狀態。
  3. 目前job的trigger是在cron和simple中二者取一，但是也可以擴充套件啟動任務的方法，使其支援擴充套件多trigger，但是triggerKey需要重新定義而非取jobName（因為trigger的hash是triggerKey的hash），本身xxl-job的jobKey取的是job的id，triggerKey取的也是job的id，沒有使用到groupName。

相關文章