spring-scheduling-cluster

Spring Boot 自带定时器Scheduled增加分布式/集群环境下任务调度控制插件，其原理是对任务加锁实现控制，支持能实现分布锁的中间件。 下面提供了redis缓存和mysql数据库的实现，如果使用到其它中间件暂时麻烦请自行实现，下面会讲如果实现的。

环境要求和关键技术

• JDK1.7
• Spring Boot 1.5.7.RELEASE

添加插件到项目中并启用

添加插件

1. 方式一：下载本项目源码然后加添加到项目中。
2. 方式二：下载本项目的jar包，添加到项目的libs包库中。
3. 方式三：下载本项目的jar包，添加到本地maven库中，然后在pom.xml文件添加引用

<dependency>
    <groupId>pres.lnk.springframework</groupId>
    <artifactId>spring-scheduling-cluster</artifactId>
    <version>1.0-BATE</version>
</dependency>

启用插件

1. 在 Spring 配置中用注解@EnableClusterScheduling代替注解@EnableScheduling（注意，原来用来启动定时器的注解@EnableScheduling要去掉，两个只能添加其中一个）
2. 将调度器中间件注册成Bean，参考下面的《实现调度器中间件对定时任务进行锁操作》。注意：该Bean的注册不能和定时任务@Scheduled放在同一个类下配置

@Configuration
public class MyConfig {

    @Scheduled(cron = "0/1 * * * * ?")
    public void timedTask1() {
        //TODO
    }

    /**
     * 这是错误做法，调度器中间件不能和 @Scheduled 放在同一个类，否则插件可能不会生效
     */
    @Bean
    public AbstractScheduler getScheduler() {
        // return AbstractScheduler 的实现类
    }
}

实现调度器中间件对定时任务进行锁操作

使用 redis 缓存做中间件

将下面类的代码添加到项目中，并注册成SpringBean限可
redis实现代码 https://github.com/lnkForKing/spring-scheduling-cluster/wiki/redis%E7%BC%93%E5%AD%98%E4%B8%AD%E9%97%B4%E4%BB%B6

使用 mysql数据库 做中间件

由于每个项目使用的持久化框架不一样，下面只提供了MyBatis的实现做参考，请根据自己项目框架做改动
mysql实现代码 https://github.com/lnkForKing/spring-scheduling-cluster/wiki/mysql%E6%95%B0%E6%8D%AE%E5%BA%93%E4%B8%AD%E9%97%B4%E4%BB%B6

数据库表结构
t_timed_task

字段	类型	说明
id	varchar(255) PRIMARY NOT NULL	任务id
timeout	bigint NOT NULL	锁的失效时间
value	varchar(255) DEFAULT NULL	锁对应的值

DROP TABLE IF EXISTS `t_timed_task`;

CREATE TABLE `t_timed_task` (
  `id` varchar(255) NOT NULL,
  `timeout` bigint(20) NOT NULL,
  `value` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

使用 zookeeper 做中间件

将下面类的代码添加到项目中
zookeeper实现代码 https://github.com/lnkForKing/spring-scheduling-cluster/wiki/zookeeper%E4%B8%AD%E9%97%B4%E4%BB%B6
然后注册成SpringBean

@Bean
public ZookeeperSchedulerImpl getScheduler(CuratorFramework zkClient) throws Exception {
    return new ZookeeperSchedulerImpl(zkClient);
}

需要注意一点：实现类的currentTimeMillis方法获取的是本地时间，如果集群中某些或某个服务器系统时间误差太大，可能会造成任务执行间隔缩短。所以最好修改该方法从指定的服务器获取一致的时间，例如可以获取数据库的时间。

自定义中间件

自定义类继承抽象类AbstractScheduler，实现父类的方法并注册成Spring Bean。
AbstractScheduler 方法说明

方法	必须	说明
boolean check(String id)	是	检查任务id是否没被锁，如果没被锁则表示可以执行任务，下一步就获取锁
boolean lock(String id, long timeoutMillis)	是	对任务id加锁，并在下次执行任务前释放锁，返回加锁是否成功
void relock(String id, long timeoutMillis)	是	修改任务id锁的释放时间
long currentTimeMillis()	是	获取中间件的服务器时间，做为锁的参考时间。集群所有服务器最好做时间同步，避免cron任务出现误差
void keepAlive()	如果启用优先级功能则必须重写	将服务器最高优先级别保存到中间件
int getMaxAliveLevel()	如果启用优先级功能则必须重写	获取中间件保存的最高级别
void executed(Method method, Object targer, long startTimeMillis, long endTimeMillis, String description)	否	定时任务执行结束的后续处理

设置主从服务器

主从服务器是通过设置服务器优先级实现，实现原理是优先级高的服务器定时（心跳时间）告诉中间件我还活着（运行中）， 然后优先级低的服务器则不执行任务。如果优先级高级服务器挂了，中间件不再接收到信息了，优先级低的服务器就会接替继续工作。

设置方式

在spring的yml配置文件中添加下面配置

spring:
  scheduling:
    cluster:
      level: 1      #优先级别
      heartTime: 60 #心跳时间（秒）

配置说明：
level ： 优先级别，1 等级最高，数字越大等级越低。其中 0 是该服务器不执行定时任务。 -1 是不参与集群服务调度，不受优先级影响，任务每次都会执行。
heartTime ： 心跳时间，服务器会以这个时间频率告诉中间件我还活着

重写中间件的getLevel()方法，可自定义level规则，例如根据ip判断level，这样不用每个服务器单独改配置文件

注解@ScheduledCluster

该注解用在@Scheduled的方法上，可选的，有以下属性和作用

属性	必填	说明
id	否	自定义任务id，同一个时间段内同一个id的任务只有一个能执行成功
description	否	任务描述
ignore	否	是否忽略集群控制，作用跟level=-1一样，但只针对该任务。例如定时清理本地临时文件

// @ScheduledCluster 是可选的
@ScheduledCluster(id="updateData", description = "每小时更新一次数据")
@Scheduled(cron = "0 0 0/1 * * ?")
public void update(){
    // 更新数据
}