7 Star 38 Fork 9

lnk / spring-scheduling-cluster

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

spring-scheduling-cluster

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

环境要求和关键技术

添加插件到项目中并启用

添加插件

  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://gitee.com/lnkToKing/open-share-code/blob/master/src/spring/scheduler/redis/RedisSchedulerImpl.java

使用 mysql数据库 做中间件

由于每个项目使用的持久化框架不一样,下面只提供了MyBatis的实现做参考,请根据自己项目框架做改动
mysql实现代码 https://gitee.com/lnkToKing/open-share-code/blob/master/src/spring/scheduler/mysql/MysqlSchedulerImpl.java
基本MyBatis实现的数据访问Mapper代码 https://gitee.com/lnkToKing/open-share-code/blob/master/src/spring/scheduler/mysql/TimedTaskMapper.java

数据库表结构
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://gitee.com/lnkToKing/open-share-code/blob/master/src/spring/scheduler/zookeeper/ZookeeperSchedulerImpl.java
然后注册成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(){
    // 更新数据
}
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Spring 定时器Scheduled分布式/集群环境下任务调度控制插件 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/lnkToKing/spring-scheduling-cluster.git
git@gitee.com:lnkToKing/spring-scheduling-cluster.git
lnkToKing
spring-scheduling-cluster
spring-scheduling-cluster
master

搜索帮助

14c37bed 8189591 565d56ea 8189591