时间: 2020-08-24|tag:33次围观|0 条评论

本文介绍SpringBoot整合Elastic-Job分布式调度任务(简单任务)。

1.有关Elastic-Job

Elastic-Job是当当网开源的分布式任务调度解决方案,是业内使用较多的分布式调度解决方案。

SpringBoot使用Elastic-Job插图
image

这里主要介绍Elastic-Job-Lite,Elastic-Job-Lite定位为轻量级无中心化解决方案,使用jar包的形式提供最轻量级的分布式任务的协调服务,外部依赖仅Zookeeper。

架构图如下:

SpringBoot使用Elastic-Job插图1
image

Elastic-Job官网地址:http://elasticjob.io/index_zh.html
Elastic-Job-Lite官方文档地址:http://elasticjob.io/docs/elastic-job-lite/00-overview/intro/

2.使用Elastic-Job

2.1 加入依赖

新建项目,在项目中加入Elastic-Job依赖,完整pom如代码清单所示。

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-starter-parent</artifactId>        <version>2.0.3.RELEASE</version>        <relativePath/> <!-- lookup parent from repository -->    </parent>    <groupId>com.dalaoyang</groupId>    <artifactId>springboot2_elasticjob</artifactId>    <version>0.0.1-SNAPSHOT</version>    <name>springboot2_elasticjob</name>    <description>springboot2_elasticjob</description>    <properties>        <java.version>1.8</java.version>    </properties>    <dependencies>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-test</artifactId>            <scope>test</scope>        </dependency>        <dependency>            <groupId>com.dangdang</groupId>            <artifactId>elastic-job-lite-core</artifactId>            <version>2.1.5</version>        </dependency>        <dependency>            <groupId>com.dangdang</groupId>            <artifactId>elastic-job-lite-spring</artifactId>            <version>2.1.5</version>        </dependency>    </dependencies>    <build>        <plugins>            <plugin>                <groupId>org.springframework.boot</groupId>                <artifactId>spring-boot-maven-plugin</artifactId>            </plugin>        </plugins>    </build></project>

2.2 配置文件

配置文件中需要配置一下zookeeper地址和namespace名称,注意:这个不是必须要配置的,在文件中直接写死也是可以的,配置文件如下所示。

spring.application.name=springboot2_elasticjobregCenter.serverList=localhost:2181regCenter.namespace=springboot2_elasticjob

2.3 配置zookeeper

接下来需要配置一下zookeeper,创建一个JobRegistryCenterConfig,内容如下:

@Configuration@ConditionalOnExpression("'${regCenter.serverList}'.length() > 0")public class JobRegistryCenterConfig {    @Bean(initMethod = "init")    public ZookeeperRegistryCenter regCenter(@Value("${regCenter.serverList}") final String serverList,                                             @Value("${regCenter.namespace}") final String namespace) {        return new ZookeeperRegistryCenter(new ZookeeperConfiguration(serverList, namespace));    }}

2.4 定义Elastic-Job任务

配置一个简单的任务,这里以在日志中打印一些参数为例,如下所示。

public class MySimpleJob implements SimpleJob {    Logger logger = LoggerFactory.getLogger(MySimpleJob.class);    @Override    public void execute(ShardingContext shardingContext) {        logger.info(String.format("Thread ID: %s, 作业分片总数: %s, " +                        "当前分片项: %s.当前参数: %s," +                        "作业名称: %s.作业自定义参数: %s"                ,                Thread.currentThread().getId(),                shardingContext.getShardingTotalCount(),                shardingContext.getShardingItem(),                shardingContext.getShardingParameter(),                shardingContext.getJobName(),                shardingContext.getJobParameter()        ));    }}

2.5 配置任务

配置任务的时候,这里定义了四个参数,分别是:

  • cron:cron表达式,用于控制作业触发时间。
  • shardingTotalCount:作业分片总数
  • shardingItemParameters:分片序列号和参数用等号分隔,多个键值对用逗号分隔
    分片序列号从0开始,不可大于或等于作业分片总数
    如:
    0=a,1=b,2=c
  • jobParameters:作业自定义参数
    作业自定义参数,可通过传递该参数为作业调度的业务方法传参,用于实现带参数的作业
    例:每次获取的数据量、作业实例从数据库读取的主键等。

至于其他参数请参考文档,http://elasticjob.io/docs/elastic-job-lite/02-guide/config-manual/

本文配置如下:

@Configurationpublic class MyJobConfig {    private final String cron = "0/5 * * * * ?";    private final int shardingTotalCount = 3;    private final String shardingItemParameters = "0=A,1=B,2=C";    private final String jobParameters = "parameter";    @Autowired    private ZookeeperRegistryCenter regCenter;    @Bean    public SimpleJob stockJob() {        return new MySimpleJob();    }    @Bean(initMethod = "init")    public JobScheduler simpleJobScheduler(final SimpleJob simpleJob) {        return new SpringJobScheduler(simpleJob, regCenter, getLiteJobConfiguration(simpleJob.getClass(),                cron, shardingTotalCount, shardingItemParameters, jobParameters));    }    private LiteJobConfiguration getLiteJobConfiguration(final Class<? extends SimpleJob> jobClass,                                                         final String cron,                                                         final int shardingTotalCount,                                                         final String shardingItemParameters,                                                         final String jobParameters) {        // 定义作业核心配置        JobCoreConfiguration simpleCoreConfig = JobCoreConfiguration.newBuilder(jobClass.getName(), cron, shardingTotalCount).                shardingItemParameters(shardingItemParameters).jobParameter(jobParameters).build();        // 定义SIMPLE类型配置        SimpleJobConfiguration simpleJobConfig = new SimpleJobConfiguration(simpleCoreConfig, jobClass.getCanonicalName());        // 定义Lite作业根配置        LiteJobConfiguration simpleJobRootConfig = LiteJobConfiguration.newBuilder(simpleJobConfig).overwrite(true).build();        return simpleJobRootConfig;    }}

3.测试

启动项目,就可以看到控制台的输出了,如下所示:

SpringBoot使用Elastic-Job插图2
image

4.源码

源码地址:https://gitee.com/dalaoyang/springboot_learn/tree/master/springboot2_elasticjob

文章转载于:https://www.jianshu.com/p/f1aeff776bf1

原著是一个有趣的人,若有侵权,请通知删除

本博客所有文章如无特别注明均为原创。
复制或转载请以超链接形式注明转自起风了,原文地址《SpringBoot使用Elastic-Job
   

还没有人抢沙发呢~