当当Elastic-Job —— 利用zk轻松开启分布式定时任务

悠悠 2023-06-18 11:53 14阅读 0赞

# **Elastic-Job** #

## Elastic-Job有什么用 ##

Elastic-job解决以下问题，我们开发定时任务一般都是使用quartz或者spring-task，无论是使用quartz还是spring-task，我们都会至少遇到两个痛点：

*  不敢轻易跟着应用服务多节点部署，可能会重复多次执行而引发系统逻辑的错误。
 *  quartz的集群仅仅只是用来HA，节点数量的增加并不能给我们的每次执行效率带来提升，即不能实现水平扩展。

> 简单来说也就是在当下分布式、集群盛行的背景下解决多台机器重复执行定时任务或需求修改配置指定单独固定的定时任务执行机器的烦恼，同时避免如果特定的某台定时任务执行机器宕机导致定时任务无法执行的尴尬场面。

废话不多说我想大家在其他地方都能看到这些介绍，我们直接上干货！

## 一、Mavne依赖 ##

<dependency>
    	<groupId>com.dangdang</groupId>
    	<artifactId>elastic-job-lite-core</artifactId>
    	<version>2.1.3</version>
    </dependency>
    <dependency>
    	<groupId>com.dangdang</groupId>
    	<artifactId>elastic-job-lite-spring</artifactId>
    	<version>2.1.3</version>
    </dependency>

## 二、创建定时作业业务类 ##

package com.zhibo.elastic.job;
    
    import com.dangdang.ddframe.job.api.ShardingContext;
    import com.dangdang.ddframe.job.api.simple.SimpleJob;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.stereotype.Component;
    
    /**
     * @author zhibo.lv
     * @title: TestJob
     * @description: Test定时任务
     * @date 2019/12/2 14:15
     */
    @Slf4j
    @Component
    public class TestJob implements SimpleJob {
        @Override
        public void execute(ShardingContext shardingContext) {
            log.info("[elastic job TestJob] begin----------------");
            //如有设置分片获取当前任务的分片编号
            int shardingItem = shardingContext.getShardingItem();
            System.out.println("Job 分片处理：" + shardingItem);
            //自行添加业务代码 ----
            log.info("[elastic job TestJob] end----------------");
        }
    }

## 三、配置elasticJob.xml ##

digest=" z o o k e e p e r . u s e r n a m e : \{zookeeper.username\}: zookeeper.username:\{zookeeper.password\}" 这个配置一般用不上 下文会有介绍

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xmlns:reg="http://www.dangdang.com/schema/ddframe/reg"
           xmlns:job="http://www.dangdang.com/schema/ddframe/job"
           xsi:schemaLocation="http://www.springframework.org/schema/beans
                            http://www.springframework.org/schema/beans/spring-beans.xsd
                            http://www.dangdang.com/schema/ddframe/reg
                            http://www.dangdang.com/schema/ddframe/reg/reg.xsd
                            http://www.dangdang.com/schema/ddframe/job
                            http://www.dangdang.com/schema/ddframe/job/job.xsd">
    
         <reg:zookeeper id="regCenter" server-lists="${job.registry.address}" namespace="zhibo-elastic-job"
                        base-sleep-time-milliseconds="10000" max-retries="3" max-sleep-time-milliseconds="30000"
                        digest="${zookeeper.username}:${zookeeper.password}"/>
    
         <job:simple id="activeAdminInfoJob" class="com.zhibo.elastic.job.TestJob"
                     registry-center-ref="regCenter"
                     sharding-total-count="1"
                     cron="0 * * * * ? "
                     sharding-item-parameters="0=0"
                     monitor-execution="false"
                     monitor-port="9888"
                     failover="true"
                     description="Test Job"
                     disabled="false"
                     overwrite="true"/>
    </beans>

> 别忘了在applicationContext.xml里面引入elasticJob.xml

### reg:zookeeper 命名空间属性详细说明 ###

### job:simple 命名空间属性详细说明 ###

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>是否必填</th> 
   <th>缺省值</th> 
   <th align="left">描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>String</td> 
   <td>是</td> 
   <td></td> 
   <td align="left">作业名称<br> 同一个命名空间下保持唯一</td> 
  </tr> 
  <tr> 
   <td>registry-center-ref</td> 
   <td>String</td> 
   <td>是</td> 
   <td></td> 
   <td align="left">注册中心Bean的引用<br> 与reg:zookeeper 的id属性的值一致即可</td> 
  </tr> 
  <tr> 
   <td>cron</td> 
   <td>String</td> 
   <td>是</td> 
   <td></td> 
   <td align="left">cron表达式，用于配置作业触发时间<br> <a href="https://blog.csdn.net/t18112925650/article/details/90677689" rel="nofollow">随便找个了表达式的学习地址</a></td> 
  </tr> 
  <tr> 
   <td>sharding-total-count</td> 
   <td>int</td> 
   <td>是</td> 
   <td></td> 
   <td align="left">作业分片总数<br> 不需要分片就写1</td> 
  </tr> 
  <tr> 
   <td>class</td> 
   <td>String</td> 
   <td>否</td> 
   <td></td> 
   <td align="left">作业实现类，需实现ElasticJob接口，脚本型作业不需要配置</td> 
  </tr> 
  <tr> 
   <td>sharding-item-parameters</td> 
   <td>String</td> 
   <td>否</td> 
   <td></td> 
   <td align="left">分片序列号和参数用等号分隔，多个键值对用逗号分隔分片序列号从0开始，不可大于或等于作业分片总数如:<br>0=a,1=b,2=c</td> 
  </tr> 
  <tr> 
   <td>job-parameter</td> 
   <td>String</td> 
   <td>否</td> 
   <td></td> 
   <td align="left">作业自定义参数<br> 代码中通过shardingContext.getJobParameter()获取</td> 
  </tr> 
  <tr> 
   <td>monitor-execution</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>true</td> 
   <td align="left">监控作业运行时状态<br>每次作业执行时间和间隔时间均非常短的情况，建议不监控作业运行时状态以提升效率。因为是瞬时状态，所以无必要监控。请用户自行增加数据堆积监控。并且不能保证数据重复选取，应在作业中实现幂等性。<br>每次作业执行时间和间隔时间均较长的情况，建议监控作业运行时状态，可保证数据不会重复选取。</td> 
  </tr> 
  <tr> 
   <td>monitor-port</td> 
   <td>int</td> 
   <td>否</td> 
   <td>-1</td> 
   <td align="left">作业监控端口</td> 
  </tr> 
  <tr> 
   <td>max-time-diff-seconds</td> 
   <td>int</td> 
   <td>否</td> 
   <td>-1</td> 
   <td align="left">最大允许的本机与注册中心的时间误差秒数 <br>如果时间误差超过配置秒数则作业启动时将抛异常<br>配置为-1表示不校验时间误差</td> 
  </tr> 
  <tr> 
   <td>failover</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>false</td> 
   <td align="left">是否开启失效转移<br>仅monitorExecution开启，失效转移才有效</td> 
  </tr> 
  <tr> 
   <td>misfire</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>true</td> 
   <td align="left">是否开启错过任务重新执行</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>否</td> 
   <td></td> 
   <td align="left">作业描述信息</td> 
  </tr> 
  <tr> 
   <td>disabled</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>false</td> 
   <td align="left">作业是否禁止启动<br>可用于部署作业时，先禁止启动，部署结束后统一启动</td> 
  </tr> 
  <tr> 
   <td>overwrite</td> 
   <td>boolean</td> 
   <td>否</td> 
   <td>false</td> 
   <td align="left">本地配置是否可覆盖注册中心配置<br>建议覆盖避免配置修改后不生效</td> 
  </tr> 
 </tbody> 
</table>