解決SpringBoot使用Quartz沒法注入Bean的問題

時間 2019-11-07

標籤解決 springboot 使用 quartz 沒法注入 bean 問題欄目 Spring 简体版

原文原文鏈接

依賴

<dependency>  
    <groupId>org.quartz-scheduler</groupId>  
    <artifactId>quartz</artifactId>  
    <version>2.2.1</version>  
</dependency>

任務工廠 JobFactory

// 解決SpringBoot不能再Quartz中注入Bean的問題
@Component
public class JobFactory extends AdaptableJobFactory {
    /**
     * AutowireCapableBeanFactory接口是BeanFactory的子類
     * 能夠鏈接和填充那些生命週期不被Spring管理的已存在的bean實例
     */
    private AutowireCapableBeanFactory factory;

    public JobFactory(AutowireCapableBeanFactory factory) {
        this.factory = factory;
    }

    /**
     * 建立Job實例
     */
    @Override
    protected Object createJobInstance(TriggerFiredBundle bundle) throws Exception {

        // 實例化對象
        Object job = super.createJobInstance(bundle);
        // 進行注入（Spring管理該Bean）
        factory.autowireBean(job);
        //返回對象
        return job;
    }
}

任務調度器 Scheduler

@Configuration
public class QuartzConfig {

    private JobFactory jobFactory;

    public QuartzConfig(JobFactory jobFactory){
        this.jobFactory = jobFactory;
    }

    /**
     * 配置SchedulerFactoryBean
     *
     * 將一個方法產生爲Bean並交給Spring容器管理
     */
    @Bean
    public SchedulerFactoryBean schedulerFactoryBean() {
        // Spring提供SchedulerFactoryBean爲Scheduler提供配置信息,並被Spring容器管理其生命週期
        SchedulerFactoryBean factory = new SchedulerFactoryBean();
        // 設置自定義Job Factory，用於Spring管理Job bean
        factory.setJobFactory(jobFactory);
        return factory;
    }

    @Bean(name = "scheduler")
    public Scheduler scheduler() {
        return schedulerFactoryBean().getScheduler();
    }
}

QuartzManager 工具類

@Service
public class QuartzManager {

    private Scheduler scheduler;

    public QuartzManager(Scheduler scheduler){
        this.scheduler = scheduler;
    }

    /**
     * 添加一個定時任務
     *
     * @param jobName           任務名
     * @param jobGroupName      任務組名
     * @param triggerName       觸發器名
     * @param triggerGroupName  觸發器組名
     * @param jobClass          任務
     * @param cron              時間設置，參考quartz說明文檔
     */
    @SuppressWarnings({ "unchecked", "rawtypes" })
    public void addJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName, Class jobClass, String cron, Map<String, Object> params) {
        try {
            // 任務名，任務組，任務執行類
            JobDetail job = JobBuilder.newJob(jobClass).withIdentity(jobName, jobGroupName).build();
            // 任務參數
            job.getJobDataMap().putAll(params);

            // 觸發器
            TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
            // 觸發器名,觸發器組
            triggerBuilder.withIdentity(triggerName, triggerGroupName);
            triggerBuilder.startNow();
            // 觸發器時間設定
            triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
            // 建立Trigger對象
            CronTrigger trigger = (CronTrigger) triggerBuilder.build();

            // 調度容器設置JobDetail和Trigger
            scheduler.scheduleJob(job, trigger);

            // 啓動
            if (!scheduler.isShutdown()) {
                scheduler.start();
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 修改一個任務的觸發時間
     *
     * @param triggerName       觸發器名
     * @param triggerGroupName  觸發器組名
     * @param cron              時間設置，參考quartz說明文檔
     */
    public void modifyJobTime(String triggerName, String triggerGroupName, String cron) {
        try {
            TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
            CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);
            if (trigger == null) {
                return;
            }

            String oldTime = trigger.getCronExpression();
            if (!oldTime.equalsIgnoreCase(cron)) {
                // 觸發器
                TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
                // 觸發器名,觸發器組
                triggerBuilder.withIdentity(triggerName, triggerGroupName);
                triggerBuilder.startNow();
                // 觸發器時間設定
                triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
                // 建立Trigger對象
                trigger = (CronTrigger) triggerBuilder.build();
                // 方式一 ：修改一個任務的觸發時間
                scheduler.rescheduleJob(triggerKey, trigger);

            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 移除一個任務
     *
     * @param jobName           任務名
     * @param jobGroupName      任務組名
     * @param triggerName       觸發器名
     * @param triggerGroupName  觸發器組名
     */
    public void removeJob(String jobName, String jobGroupName, String triggerName, String triggerGroupName) {
        try {

            TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);

            // 中止觸發器
            scheduler.pauseTrigger(triggerKey);
            // 移除觸發器
            scheduler.unscheduleJob(triggerKey);
            // 刪除任務
            scheduler.deleteJob(JobKey.jobKey(jobName, jobGroupName));
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 獲取任務是否存在
     *
     * STATE_BLOCKED 4 阻塞
     * STATE_COMPLETE 2 完成
     * STATE_ERROR 3 錯誤
     * STATE_NONE -1 不存在
     * STATE_NORMAL 0 正常
     * STATE_PAUSED 1 暫停
     *
     */
    public  Boolean notExists(String triggerName, String triggerGroupName) {
        try {
            return scheduler.getTriggerState(TriggerKey.triggerKey(triggerName, triggerGroupName)) == Trigger.TriggerState.NONE;
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

}

舉個栗子

自定義任務 Job

@Service
public class SftpJob extends QuartzJobBean {

    // 該類必須爲public修飾
    // 該類必須含有空參數的構造器

    @Value("${sftp.root.username}")
    private String username;

    @Value("${sftp.root.password}")
    private String password;

    @Value("${sftp.host}")
    private String host;

    @Value("${sftp.port}")
    private Integer port;

    @Autowired
    private SftpRepository sftpRepository;

    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        // 傳入的參數
        JobDataMap params = context.getJobDetail().getJobDataMap();
        
        ...業務邏輯...
    }
}

管理任務

@Service
public class SftpTask {
    // 任務名前綴
    private final String job_prefix = "job_";
    // 任務組前綴
    private final String job_group_prefix = "job_group_";
    // 觸發器前綴
    private final String trigger_prefix = "trigger_";
    // 觸發組前綴
    private final String trigger_group_prefix = "trigger_group_";
    
    private QuartzManager quartzManager;
    
    public SftpTask (QuartzManager quartzManager) {
        this.quartzManager = quartzManager;
    }
    
    /**
     *  根據配置生成cron表達式
     */
    private String getCron(SftpDTO dto) {

        // 時
        Integer hour = dto.getHour();
        // 分
        Integer minute = dto.getMinute();
        // 每週幾
        Integer week = dto.getWeek();
        // 每個月幾號
        Integer day = dto.getDay();

        /* 執行時間 0天天,1每週,2每個月 */
        Integer execType = dto.getExecType();

        String cron;
        switch (execType) {
            case 0:
                cron = String.format("0 %s %s * * ?", minute, hour);
                break;
            case 1:
                week = (week + 1) % 7;
                cron = String.format("0 %s %s ? * %s", minute, hour, week == 0 ? 7: week);
                break;
            case 2:
                cron = String.format("0 %s %s %s * ?", minute, hour, day);
                break;
            default:
                cron = "0 0 0 * * ?";
                break;
        }

        return cron;
    }
    
    /**
     *  添加定時任務
     */
    private void addJob(SftpDTO dto) {

        Long id = dto.getId();

        Map<String, Object> params = Maps.newHashMap();
        params.put("id", id);

        quartzManager.addJob(
            job_prefix + id,
            job_group_prefix + id,
            trigger_prefix + id,
            trigger_group_prefix + id,
            SftpJob.class, getCron(etlSftpDTO), params
        );
    }
    
    /**
     *  修改定時任務
     */
    public void modifyJob(SftpDTO dto) {

        Long id = dto.getId();
        if (quartzManager.notExists(trigger_prefix + id, trigger_group_prefix + id)){
            // 任務不存在
            addJob(dto);
        } else {
            // 任務存在 
            quartzManager.modifyJobTime(
                trigger_prefix + id,
                trigger_group_prefix + id,
                getCron(dto)
            );
        }
    }

    /**
     *  移除定時任務
     */
    public void removeJob(Long id) {
        quartzManager.removeJob(
            job_prefix + id,
            job_group_prefix + id,
            trigger_prefix + id,
            trigger_group_prefix + id
        );
    }
    
}