分布式调度平台 OhMyScheduler 快速入门

概述

OhMyScheduler是新一代分布式调度与计算框架，支持CRON、API、固定频率、固定延迟等调度策略，提供工作流来编排任务解决依赖关系，使用简单，功能强大，文档齐全，开箱即用！

为什么选择 OhMyScheduler ？

当前市面上流行的作业调度框架有老牌的Quartz、基于Quartz的elastic-job和原先基于Quartz后面移除依赖的xxl-job，这里分别谈一些这些框架现存的缺点。

Quartz可以视为第一代调度框架，基本上是现有所有分布式调度框架的“祖宗”。由于历史原因，它不提供Web界面，只能通过API完成任务的配置，使用起来不够方便和灵活，同时它仅支持单机执行，无法有效利用整个集群的计算能力。

xxl-job可以视为第二代调度框架，在一定程度上解决了Quartz的不足，在过去几年中是个非常优秀的调度框架，不过放到今天来看，还是存在着一些不足的，具体如下：

• 数据库支持单一：仅支持MySQL，使用其他DB需要自己魔改代码
• 有限的分布式计算能力：仅支持静态分片，无法很好的完成复杂任务的计算
• 不支持工作流：无法配置各个任务之间的依赖关系，不适用于有DAG需求的场景

正所谓长江后浪推前浪，在如今这个数据量日益增长、业务越来越复杂的年代，急需一款更为强大的任务调度框架来解决上诉问题，而OhMyScheudler就是这个“救世主”。

我将OhMyScheduler称为第三代调度框架，在任务调度的基础上，额外提供分布式计算和工作流功能，其主要特性如下：

• 使用简单：提供前端Web界面，允许开发者可视化地完成调度任务的管理（增、删、改、查）、任务运行状态监控和运行日志查看等功能。
• 定时策略完善：支持CRON表达式、固定频率、固定延迟和API四种定时调度策略。
• 执行模式丰富：支持单机、广播、Map、MapReduce四种执行模式，其中Map/MapReduce处理器能使开发者寥寥数行代码便获得集群分布式计算的能力。
• DAG工作流支持：支持在线配置任务依赖关系，可视化得对任务进行编排，同时还支持上下游任务间的数据传递
• 执行器支持广泛：支持Spring Bean、内置/外置Java类、Shell、Python等处理器，应用范围广。
• 运维便捷：支持在线日志功能，执行器产生的日志可以在前端控制台页面实时显示，降低debug成本，极大地提高开发效率。
• 依赖精简：最小仅依赖关系型数据库（MySQL/PostgreSQL/Oracle/MS SQLServer...），同时支持所有Spring Data JPA所支持的关系型数据库。
• 高可用&高性能：调度服务器经过精心设计，一改其他调度框架基于数据库锁的策略，实现了无锁化调度。部署多个调度服务器可以同时实现高可用和性能的提升（支持无限的水平扩展）。
• 故障转移与恢复：任务执行失败后，可根据配置的重试策略完成重试，只要执行器集群有足够的计算节点，任务就能顺利完成。

适用场景

• 有定时执行需求的业务场景：如每天凌晨全量同步数据、生成业务报表等。
• 有需要全部机器一同执行的业务场景：如使用广播执行模式清理集群日志。
• 有需要分布式处理的业务场景：比如需要更新一大批数据，单机执行耗时非常长，可以使用Map/MapReduce处理器完成任务的分发，调动整个集群加速计算。

项目地址与文档

项目地址：https://github.com/KFCFans/OhMyScheduler

官方文档：https://www.yuque.com/ohmyscheduler/guidence/ztn4i5

快速开始

OhMyScheduler由调度服务器（oms-server）和执行器(oms-worker)两部分组成，oms-server负责提供Web服务和完成任务的调度，oms-worker则负责执行用户所编写的任务代码，同时提供分布式计算能力。

PS：本文主要面向入门用户，因此以下为本地开发环境运行教程，有丰富经验的同学可以直接阅读官方文档。

初始化项目

1. git clone https://github.com/KFCFans/OhMyScheduler.git
2. 导入 IDEA，源码结构如下，我们需要启动调度服务器（oms-server），同时在samples工程中编写自己的处理器代码

image.png

启动调度服务器

1. 创建数据库（仅需要创建数据库）：找到你的DB，运行SQLCREATE database if NOT EXISTS oms-daily default character set utf8mb4 collate utf8mb4_unicode_ci，搞定～
2. 修改配置文件，配置文件的说明官方文档写的非常详细，此处不再赘述。必须需要修改的地方有spring.datasource.core.jdbc-url、spring.datasource.core.username和spring.datasource.core.password，当然，有mongoDB的同学也可以修改spring.data.mongodb.uri以获取完全版体验。

oms.env=DAILY
logging.config=classpath:logback-dev.xml

####### 数据库配置 #######
spring.datasource.core.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.core.jdbc-url=jdbc:mysql://remotehost:3391/oms-daily?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8
spring.datasource.core.username=root
spring.datasource.core.password=No1Bug2Please3!
spring.datasource.core.hikari.maximum-pool-size=20
spring.datasource.core.hikari.minimum-idle=5

####### mongoDB配置，非核心依赖，可移除 #######
spring.data.mongodb.uri=mongodb://remotehost:27017/oms-daily

####### 邮件配置（启用邮件报警则需要） #######
spring.mail.host=smtp.qq.com
spring.mail.username=aaa
spring.mail.password=bbb
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true

####### 资源清理配置 #######
oms.log.retention.local=0
oms.log.retention.remote=0
oms.container.retention.local=0
oms.container.retention.remote=0
oms.instanceinfo.retention=0

3. 完成配置文件的修改后，可以直接通过启动类com.github.kfcfans.oms.server.OhMyApplication启动调度服务器，观察启动日志，查看是否启动成功～启动成功后，访问 http://127.0.0.1:7700/ ，如果能顺利出现Web界面，则说明调度服务器启动成功！
4. 注册应用：点击主页应用注册按钮，填入 oms-test，注册示例应用（当然你也可以注册其他的appName，只是别忘记在示例程序中同步修改～）

reg

编写示例代码

进入子工程（oh-my-scheduler-worker-samples），修改配置文件连接oms-server并编写自己的处理器代码。

1. 修改oms-worker的启动配置类com.github.kfcfans.oms.samples.OhMySchedulerConfig，将AppName修改为刚刚在控制台注册的名称。

@Configuration
public class OhMySchedulerConfig {
    @Bean
    public OhMyWorker initOMS() throws Exception {

        // 服务器HTTP地址（端口号为 server.port，而不是 ActorSystem port）
        List serverAddress = Lists.newArrayList("127.0.0.1:7700");

        // 1. 创建配置文件
        OhMyConfig config = new OhMyConfig();
        config.setPort(27777);
        config.setAppName("oms-test");
        config.setServerAddress(serverAddress);
        // 如果没有大型 Map/MapReduce 的需求，建议使用内存来加速计算
        config.setStoreStrategy(StoreStrategy.MEMORY);

        // 2. 创建 Worker 对象，设置配置文件
        OhMyWorker ohMyWorker = new OhMyWorker();
        ohMyWorker.setConfig(config);
        return ohMyWorker;
    }
}

2. 编写自己的处理器：随便找个地方新建类，继承你想要使用的处理器（各个处理器的介绍可见官方文档，文档非常详细），这里为了简单演示，选择使用单机处理器BasicProcessor，以下是代码示例。

@Slf4j
@Component
public class StandaloneProcessorDemo implements BasicProcessor {

    @Override
    public ProcessResult process(TaskContext context) throws Exception {

        OmsLogger omsLogger = context.getOmsLogger();
        omsLogger.info("StandaloneProcessorDemo start process,context is {}.", context);
        System.out.println("jobParams is " + context.getJobParams());
        
        return new ProcessResult(success, context + ": " + success);
    }
}

3. 启动示例程序，即直接运行主类com.github.kfcfans.oms.samples.SampleApplication，观察控制台输出信息，判断是否启动成功。

任务的配置与运行

调度服务器与示例工程都启动完毕后，再次前往Web页面（ http://127.0.0.1:7700/ ），进行任务的配置与运行。

1. 在首页输入框输入配置的应用名称，成功操作后会正式进入前端管理界面。

main

2. 点击任务管理 -> 新建任务（右上角），开始创建任务。

first

3. 完成任务创建后，即可在控制台看到刚才创建的任务，如果觉得等待调度太过于漫长，可以直接点击运行按钮，立即运行本任务。

m

4. 前往任务示例边栏，查看任务的运行状态

d

基础的教程到这里也就结束了～更多功能示例可见官方文档，工作流、MapReduce、容器等高级特性等你来探索！