系统中实现定时任务的抽象类

公司代码中一个非常好的定时更新类, 贴在这里以学习


/**
 * 封装了定时更新的逻辑,子类只需要指定更新间隔,并实现{@link #update()}方法即可。
 * 如果使用spring annotation进行api管理,直接使用autowired的实例即可;
 * 如果使用spring xml初始化api对象,需要配置init-method="init";
 * 如果直接使用new生成对象,需要new之后调用init方法初始化。
 * <p />
 * <b>注意</b>:在{@link #update()}方法中执行的代码,在服务器宕机等情况下会被打断,
 * 因此请务必考虑被打断的后果,必要的时候可增加事务等额外机制保证数据完整性。
 * <p />
 * <b>注意</b>:包含PostConstruct方法的类,若出现在循环引用的链条上,会导致在未完成自动注入的情况下,
 * PostConstruct方法被执行,若此时PostConstruct方法恰好使用了未完成注入的字段就会抛空指针错误。
 * {@link ScheduledService}中包含PostConstruct方法,因此使用时需要格外小心。
 * 在必要的情况下,可以仅保留{@link ScheduledService}的{@link #update()}方法,最大限度的避免其他类引用该Service,
 * 从而防止该问题的发生。
 */
public abstract class ScheduledService extends BaseService {

    private static final ScheduledThreadPoolExecutor SCHEDULER = new ScheduledThreadPoolExecutor(
            20,
            new ThreadFactory("ScheduledService", true));

    private static final AtomicInteger RUNNING_TASK_COUNT = new AtomicInteger(0);

    /** 一个可以停止所有定时更新的开关,以便在重启服务的时候暂时停止定时更新 */
    private static volatile boolean runnable = true;

    /** 在定时更新停止后是否需要输出定时更新停止警告 */
    private static volatile boolean scheduleStoppedWarning = true;

    /**
     * 是否在启动时同步执行一次update
     * <p />
     * 一般情况下需要在启动时同步执行一次update,以便在启动后缓存的数据是正确的,
     * 但这样会增加启动时间,部分耗时的定时任务可以不必在启动时运行
     *
     * @return 是否需要在启动时同步执行一次update
     */
    protected boolean runPreUpdate() {
        return true;
    }

    /**
     * 更新的具体代码,子类通过实现该方法实现定时更新。
     */
    public abstract void update();

    /**
     * 返回定时更新的时间间隔,子类通过实现该方法指定更新的时间间隔
     *
     * @return 缓存主动更新的时间间隔,单位是秒
     */
    public abstract int updatePeriod();

    /** 防止误调用导致的多次初始化 */
    private volatile boolean alreadyInit = false;

    /**
     * 获取当前正在执行的定时任务的数量,以便判断是否可以重启服务器
     *
     * @return
     */
    public static int runningTaskCount() {
        return RUNNING_TASK_COUNT.get();
    }

    /**
     * 启动或者暂定所有的定时任务,使用时务必小心!
     *
     * @param value
     */
    public static void setRunnable(boolean value) {
        runnable = value;
    }

    public static void setScheduleStoppedWarning(boolean value) {
        scheduleStoppedWarning = value;
    }

    /**
     * 初始化定时更新任务,初始化过程中会同步调用一次{@link #update()}
     */
    @PostConstruct
    public synchronized void init() {
        if (alreadyInit) {
            return;
        }
        int period = updatePeriod();
        if (runPreUpdate()) {
            updateCacheWithoutException();
        }
        SCHEDULER.scheduleWithFixedDelay(new Runnable() {
            @Override
            public void run() {
                updateCacheWithoutException();
            }
        }, 30 + (int) (Math.random() * 30), period, TimeUnit.SECONDS);
        alreadyInit = true;
    }

    private void updateCacheWithoutException() {
        if (!runnable) {
            if (scheduleStoppedWarning) {
                LogUtils.info("ScheduledService: schedule service stop!");
            }
            return;
        }
        RUNNING_TASK_COUNT.incrementAndGet();
        try {
            update();
        } catch (Exception e) {
            // 异常不应该影响后续执行
            e.printStackTrace();
        } finally {
            RUNNING_TASK_COUNT.decrementAndGet();
        }
    }

}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,692评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,482评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,995评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,223评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,245评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,208评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,091评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,929评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,346评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,570评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,739评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,437评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,037评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,677评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,833评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,760评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,647评论 2 354

推荐阅读更多精彩内容