marble: A JavaScript repository from lilinjun1884

Marble简介
Marble使用
- 接入Marble步骤
  - - 接入Marble - 服务端
  - - 接入Marble - OFFLINE端
Marble原理介绍
存在的问题+后续计划
关于作者

摘要：实际项目中需要用到JOB的场景非常多，通常需要JOB的业务都需要如下基本功能： 1）集群环境单实例调度； 2）JOB可视化启停； 3）JOB频率可视化配置；单应用使用JOB开发适配的需求的调度功能过滤繁琐，开销太大，考虑提供统一的调度系统对外提供JOB的调度服务。

# Marble简介

Marble是一款基于Quartz的计划任务调度系统，提供基本的任务定时调度功能。Marble包含两部分：

1）Marble OFFLINE: 一套可视化的JOB配置系统。包含JOB的启停、频率配置、调度日志查看等功能；
2）Marble AGENT：以Jar包形式整合进接入Marble的第三方应用，透明化Job的调度过程；详情见<< Marble使用>>章节

OFFLINE>> 为了可视化管理JOB，提供一个前端基于Bootstrap, 后端采用SpringMVC + MyBatis + MySql结构的控制台。提供基本的JOB的增删改查，启动/暂停等操作。

Marble部署图如下：

目前版本Marble提供的功能如下：

基本JOB管理（增删改查、暂停/启动）；
JOB执行参数传递的支持；
同步JOB和异步JOB支持；
CRON表达式生成控件；
多种Misfire策略配置；
集群环境部署（不重复执行）；
集群的软负载均衡；
Spring整合；

#Marble使用 ##接入Marble步骤

服务端=>

引入相关Jar包(Netty等)
定义Job的具体实现类（Spring中的Bean）
Spring中配置Job的实现类

OFFLINE端=>

配置对应应用和Job信息（配合权限管理）

####接入Marble - 服务端

引入相关Jar包（以Maven为例）
注：依赖marble-agent包（自己通过源代码的marble-server模块生成）和Thrift包

<!-- Marble相关 -->
  <dependency>
    <groupId>com.github.jxdong</groupId>
    <artifactId>marble-agent</artifactId>
    <version>1.0.1</version>
</dependency>
 
<!-- thrift相关（2.0.0之前版本需要） -->
<dependency>
	<groupId>org.apache.thrift</groupId>
	<artifactId>libthrift</artifactId>
	<version>0.9.3</version>
</dependency>

<!-- Netty相关 -->
<dependency>
	<groupId>io.netty</groupId>
	<artifactId>netty-all</artifactId>
	<version>4.0.4.Final</version>
</dependency>

2.定义Job具体实现类
定义java类继承父类MarbleJob，覆盖方法execute (当Job被调用时会执行execute下的内容)。

//异步JOB
@Component
public class TestMarbleJob1 extends MarbleJob {
    private Logger logger = LoggerFactory.getLogger(TestMarbleJob1.class);
    @Override
    public void execute(String param) {
        logger.info(" 异步 JOB1 执行正常： {}", param);
    }
}
//同步JOB
@Component
public class TestSyncMarbleJob1 extends MarbleJob {
    private Logger logger = LoggerFactory.getLogger(TestSyncMarbleJob1.class);
 
    @Override
    public Result executeSync(String param) {
        logger.info(" 同步 JOB1(3S) 执行正常： {}", param);
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return Result.SUCCESS();
    }
}

Spring中添加Job配置

marble框架中已经自定义了Spring标签<marble ..>方便直接配置。示例配置如下：

<marble:scheduler id="Scheduler001" port="9091" appCode="8890">
    <marble:job name="Job1" description="jobDescription1" ref="testMarbleJob1"/>
    <marble:job name="Job2" description="jobDescription2" ref="testSyncMarbleJob1"/>
</marble:scheduler>

配置解释：

配置了一个名称为Scheduler001的计划任务（job组），在9091端口上暴露服务。
Scheduler001下包含了两个Job：job1和job2.
Job1的实现类是 Spring bean - testMarbleJob1
Job2的实现类是Spring Bean – testSyncMarbleJob1

Marble标签详解：
<marble:scheduler/>: 计划任务配置。一个应用可以配置多个计划任务，每个计划任务暴露在一个IP的端口下，一个计划任务中可以包含多个Job。

属性	是否必填	描述
id	必填	ID属性，英文+数字的组合来定义该计划任务的唯一标识。
host	非必填	所在服务器的IP地址。指定后Marble会尝试将服务暴露在该IP下。不是必填项。由于集群，建议该字段不填，Marble默认会自动获取；
port	必填	计划任务暴露的端口号。指明该计划任务暴露在机器的哪个端口下，Marble随Spring启动后会尝试打开本机的该端口并暴露服务。
appCode	（必填）	所在应用的APPID。为了在同一台机器上区别不同的应用，以免调用时混淆。

<marble:job/>: 计划任务下的job的配置。指明具体任务的别名以及实现类。

属性	是否必填	描述
name	必填	给当前Job起的别名，在所属的scheduler下必须唯一。
description	非必填	ob的描述信息，仅用来便于开发者自己识别，非必填。
ref	必填	Job的具体实现类，必须指向存在的一个Spring Bean。值为bean的name。且该bean必须继承自MarbleJob并覆盖execute方法。Job被调用时会执行execute方法，因此执行逻辑要写在execute中。