如何实现动态注册或注销@Scheduled cron定时任务？

该文章为原创（转载请注明出处）：如何实现动态注册或注销@Scheduled cron定时任务？ - 简书 (jianshu.com)

真实业务场景

Spring中，@Scheduled 可以通过读取配置或者硬编码的方式指定 cron表达式，来实现触发某个时间的定时任务的功能
但我们需要不重启服务，来实现动态地修改定时任务的触发时间，原有功能无法实现。

@Scheduled原理

1. @EnableScheduling注解引入SchedulingConfiguration配置类
2. SchedulingConfiguration注册ScheduledAnnotationBeanPostProcessor Scheduled注解后处理器实例
3. ScheduledAnnotationBeanPostProcessor#postProcessAfterInitializationScheduled注解后处理器扫描带
   org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor#postProcessAfterInitialization
@Scheduled的方法 根据注解中定义的属性，构建并注册定时任务

实现思路

1. 找到Scheduled注解后处理器 注册的部分，查看源码
   a. 是否预留可扩展的部分（例如 部分存在逻辑转发，转发到其他接口实例或者其他抽象方法）
   b. 是否可以继承
   c. 关键方法是否为protected
   d. 使用反射（下下策）
2. 找到扩展方法，封装 注册/注销逻辑

具体实现思路

1. 定时任务注册逻辑在ScheduledAnnotationBeanPostProcessor#processScheduled方法中，方法为protected，创建子类，可以访问该方法。
2. 方法需要传入 Scheduled注解实例，创建代理，构建注解对象实例
   a. 寻找现有框架逻辑
   i. 寻找Annotation开头的Utils方法、Factory方法
   ii. Jdk存在创建注解实例的方法 sun.reflect.annotation.AnnotationParser#annotationForMap
   iii. hibernate 存在类似方法 AnnotationDescriptor.Builder可以构建org.hibernate.validator.internal.util.annotation.AnnotationFactory#create
   iv. Spring框架存在类似方法org.springframework.core.annotation.AnnotationUtils#synthesizeAnnotation(java.util.Map<java.lang.String,java.lang.Object>, java.lang. Class<A>, java.lang.reflect.AnnotatedElement)
   b. 拷贝框架逻辑（下策）
   c. 自己编写创建代理实例（下下策）
3. 定时任务注销类似逻辑在ScheduledAnnotationBeanPostProcessor#postProcessBeforeDestruction
   a. scheduledTasks私有属性无法访问，只能使用反射

具体代码逻辑

import com.google.common.collect.Maps;
import org.redisson.liveobject.misc.ClassUtils;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor;
import org.springframework.scheduling.config.CronTask;
import org.springframework.scheduling.config.ScheduledTask;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;
import java.util.Map;
import java.util.Set;

import static java.util.Collections.emptySet;

/**
 * @author uhfun
 */
@Component
public class ConfigurableScheduler {
    private final InnerScheduledAnnotationBeanPostProcessor postProcessor;

    public ConfigurableScheduler(InnerScheduledAnnotationBeanPostProcessor postProcessor) {
        this.postProcessor = postProcessor;
    }

    public void registerCronTask(String cron, Method method, Object target) {
        postProcessor.registerCronTask(cron, method, target);
    }

    public void unregisterCronTask(String cron, Object target) {
        postProcessor.unregisterCronTask(target, cron);
    }

    @Component
    public static class InnerScheduledAnnotationBeanPostProcessor extends ScheduledAnnotationBeanPostProcessor {

        private final Map<Object, Set<ScheduledTask>> scheduledTasksMap;

        public InnerScheduledAnnotationBeanPostProcessor() {
            // ScheduledAnnotationBeanPostProcessor 不提供remove 某个任务的逻辑
            // 实现注销定时任务 需要访问scheduledTasks属性，但是ScheduledAnnotationBeanPostProcessor中为私有，因此只能使用反射或者scheduledTasks实例
            scheduledTasksMap = ClassUtils.getField(this, "scheduledTasks");
        }

        public void registerCronTask(String cron, Method method, Object bean) {
            // 调用父类 prtotected方法
            Map<String, Object> attributes = Maps.newHashMap();
            attributes.put("cron", cron);
            Scheduled scheduled = AnnotationUtils.synthesizeAnnotation(attributes, Scheduled.class, null);
            super.processScheduled(scheduled, method, bean);
        }

        public void unregisterCronTask(Object bean, String cron) {
            synchronized (scheduledTasksMap) {
                Set<ScheduledTask> tasks = getScheduledTasks();
                for (ScheduledTask task : tasks) {
                    if (task.getTask() instanceof CronTask
                            // cron表达式相同时，取消并从scheduledTasks中的实例
                            && ((CronTask) task.getTask()).getExpression().equals(cron)) {
                        task.cancel();
                        scheduledTasksMap.getOrDefault(bean, emptySet()).remove(task);
                    }
                }
            }
        }
    }
}

最终效果

// cron变更 注销
public modifyScheduleTask(String newCron, String oldCron) {
    if (oldCron!= null && !oldCron.equals(newCron)) {
            Method xxxMethod = ClassUtils.getMethod(StatisticsSchedules.class, "xxxMethod");
            configurableScheduler.unregisterCronTask(oldCron, this);
            if (newCron != null) {
                configurableScheduler.registerCronTask(newCron, xxxMethod, this);
            }           
    }
}

public void xxxMethod() {
  // 定时任务方法
  // do something...
}

该文章为原创（转载请注明出处）：如何实现动态注册或注销@Scheduled cron定时任务？ - 简书 (jianshu.com)