SandGlass

⏳ SandGlass 是一款为 java 设计的分布式任务调度工具。

创作目标

定时工作是业务需要中十分常见的

比方：

（1）每天给本人爱人发晚安

什么你还是独身？，那看完本篇文章就有了。

（2）每个月告诉本人要还信用卡

可能还有其余的手机费、生活费之类的，反正又是一个没钱的一个月。

（3）每个月 14 日都是情人节

这个扯远了……

有了场景，那咱们如何实现呢？

java 已有的实现任务调度的支流工具如下：

为什么须要从新实现一个任务调度框架呢？

老马的日常开发中，简略的调度工作会应用 jdk 中的 ScheduledExecutor 实现。

当波及到 cron 表达式时，个别会应用 quartz，毕竟老牌调度框架，性能十分欠缺。

然而比照 spring schedule，quartz 的应用就显得有些麻烦，须要开发者指定较多的配置。

那间接应用 spring schedule 不就好了吗？

spring schedule 的毛病也很显著，不反对数据的长久化，不反对散布式调度。

那间接引入一个分布式任务调度零碎呢？

有时候就显得杀鸡用牛刀，而且保护老本比拟高。

读到这里，必定会有聪慧的小伙伴们提问了：“难道就不能写一个能够独立于 spring 应用，又能够整合 spring 应用，能够单机调度，又能够散布式调度的任务调度工具吗？”

是的，sandglass 就是一个渐进式，满足下面各种利用场景的任务调度工具 。

sandglass 的一点改良

• sandglass 领有 quartz 的弱小性能，spring schedule 的应用便捷性。
• sandglass 的实现简洁，便于零碎学习调度零碎的原理。
• sandglass 基于分布式理念设计，便于作为散布式调度零碎的实现基石。
• sandglass 所有实现都是基于接口，用户能够自定义实现本人的策略。

个性

• 高性能任务调度
• 反对工作 MIS-FIRE 解决策略
• 反对工作是否并发解决
• 反对不依赖 spring，齐全独立运行
• 反对整合 spring
• 反对整合 springboot
• 反对用户高度自定义
• 真正意义上的分布式任务调度零碎
• 从零开始纯自研调度框架，便于用户学习原理

疾速开始

maven 引入

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>sandglass-core</artifactId>
    <version>1.7.1</version>
</dependency>

入门例子

测试代码

//1.1 定义工作
IJob job = new AbstractJob() {
    @Override
    public void execute(IJobContext context) {LOG.info("HELLO");
    }
};

//1.2 定义触发器
ITrigger trigger = new CronTrigger("*/5 * * * * ?");

//2. 执行
SandGlassHelper.schedule(job, trigger);

日志输入

依据 cron 表达式，5s 执行一次工作。

[INFO] [2021-12-07 21:47:40.008] [pool-1-thread-1] [c.g.h.s.c.u.SandGlassHelperTest.doExecute] - HELLO
[INFO] [2021-12-07 21:47:45.003] [pool-1-thread-2] [c.g.h.s.c.u.SandGlassHelperTest.doExecute] - HELLO
[INFO] [2021-12-07 21:47:50.005] [pool-1-thread-3] [c.g.h.s.c.u.SandGlassHelperTest.doExecute] - HELLO

Trigger 触发器

cron

通过 cron 表达式创立 trigger，能够通过办法：

Triggers.cron(String cronExpression);

period

通过指定工夫距离创立 trigger，应用办法：

Triggers.period(long period);
Triggers.period(long period, TimeUnit timeUnit);

疏导类

阐明

SandGlass 也反对疏导类自定义，默认配置等价于：

SandGlassBs.newInstance()
        .appName(SandGlassConst.DEFAULT_APP_NAME)
        .envName(SandGlassConst.DEFAULT_ENV_NAME)
        .machineIp(SandGlassConst.DEFAULT_MACHINE_IP)
        .machinePort(SandGlassConst.DEFAULT_MACHINE_PORT)
        .workPoolSize(SandGlassConst.DEFAULT_WORKER_POOL_SIZE)
        .waitTakeTimeSleepMills(SandGlassConst.WAIT_TAKE_TIME_SLEEP_MILLS)
        .triggerLockTryMills(SandGlassConst.TRIGGER_LOCK_TRY_MILLS)
        .triggerStore(new TriggerStore())
        .triggerDetailStore(new TriggerDetailStore())
        .triggerListener(new TriggerListener())
        .triggerLock(Locks.none())
        .triggerIdGenerator(IdGenerators.classSlim())
        .triggerLockKeyGenerator(new TriggerLockKeyGenerator())
        .jobStore(new JobStore())
        .jobDetailStore(new JobDetailStore())
        .jobListener(new JobListener())
        .jobTriggerStore(new JobTriggerStore())
        .jobTriggerStoreListener(new JobTriggerStoreListener())
        .jobTriggerMappingStore(new JobTriggerMappingStore())
        .jobTriggerNextTakeTimeStore(new JobTriggerNextTakeTimeStore())
        .jobIdGenerator(IdGenerators.classSlim())
        .taskLogStore(new TaskLogStore())
        .timer(SystemTimer.getInstance())
        .scheduleListener(new ScheduleListener())
        .start();

所有实现都是基于接口，用于能够依据理论业务进行调整。

属性阐明

可配置的属性列表如下：

spring 整合

maven 引入

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>sandglass-spring</artifactId>
    <version>1.7.1</version>
</dependency>

定时工作定义

相似于 spring 的任务调度，咱们能够通过注解指定办法。

@Service
public class MyJobService {@PeriodSchedule(period = 2000)
    public void logTime() {System.out.println("---------------- TIME");
    }

    @CronSchedule("*/5 * * * * ?")
    public void logName() {System.out.println("---------------- NAME");
    }

}

@PeriodSchedule 用于指定 period 执行的工作，@CronSchedule 用于指定 cron 表达式对应的工作。

@PeriodSchedule 注解

用于指定基于 period 执行的工作办法。

可配置属性列表如下：

@CronSchedule 注解

用于指定基于 cron 表达式 执行的工作办法。

可配置属性列表如下：

定时工作启用

间接指定 @EnableSandGlass 注解即可，无需额定配置。

@Configurable
@ComponentScan(basePackages = "com.github.houbb.sandglass.test.spring")
@EnableSandGlass
public class SpringConfig {}

注解其定义

@EnableSandGlass 容许用户进行自定义。

可配置的属性列表如下：

默认的策略和 SandglassBs 疏导类保持一致。

自定义形式：实现对应接口，在注解中对应对应的 bean 名称即可。

阐明：上面 3 个属性和业务无关，只和执行的环境的配置无关，所以不反对注解指定。能够通过配置自定义。

springboot 整合

maven 引入

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>sandglass-springboot-starter</artifactId>
    <version>1.7.1</version>
</dependency>

其余什么都不须要，就能够相似 spring 整合一样应用定时工作了。

办法定义

同 spring 整合

模块介绍

子模块

sandglass 共计 5 个子模块：

采纳渐进式的 MVP 设计理念，根本能够满足日常开发中的常见场景。

当然，分布式的任务调度服务会简单的多，将会以 sandglass 为根底进行拓展实现。

产品矩阵

常言道，独木不成林。

sandglass 作为一个任务调度外围实现，只是分布式任务调度的基石。

若要实现一个残缺的散布式调度零碎，还须要如下的工具撑持。

目前经验几十个迭代和几十个不眠的夜晚，基本功能实现实现，后续思考陆续开源。

拓展浏览

开源地址

为了便于大家独特学习，开源地址如下：

https://github.com/houbb/sandglass

https://gitee.com/houbinbin/sandglass

文章

为了吃瓜通宵 7 天写了一个网站

开源分布式任务调度工具，和你一起记住生命中每一个重要的时刻