Apache ShardingSphere ElasticJob 的 Spring 命名空间配置指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00219/article/details/148441469

Apache ShardingSphere ElasticJob 的 Spring 命名空间配置指南

shardingsphere-elasticjob Distributed scheduled job 项目地址: https://gitcode.com/gh_mirrors/sha/shardingsphere-elasticjob

概述

Apache ShardingSphere ElasticJob 是一个分布式任务调度解决方案，提供了与 Spring 框架深度集成的能力。通过 Spring 命名空间配置方式，开发者可以更加便捷地管理和调度分布式作业。本文将详细介绍如何使用 Spring 命名空间来配置和运行 ElasticJob 作业。

为什么使用 Spring 命名空间

Spring 命名空间为 ElasticJob 提供了以下优势：

简化配置：通过 XML 命名空间简化复杂配置
依赖注入：可以直接使用 Spring 管理的 Bean
属性占位符：支持从属性文件中取值
一致性：与 Spring 应用的其他组件保持一致的配置风格

基础配置

1. 命名空间声明

首先需要在 Spring 配置文件中声明 ElasticJob 的命名空间：

xmlns:elasticjob="http://shardingsphere.apache.org/schema/elasticjob"
xsi:schemaLocation="http://shardingsphere.apache.org/schema/elasticjob
                    http://shardingsphere.apache.org/schema/elasticjob/elasticjob.xsd"

2. 注册中心配置

ElasticJob 依赖 ZooKeeper 作为注册中心：

<elasticjob:zookeeper id="regCenter" 
    server-lists="yourhost:2181" 
    namespace="my-job" 
    base-sleep-time-milliseconds="1000" 
    max-sleep-time-milliseconds="3000" 
    max-retries="3" />

参数说明：

server-lists：ZooKeeper 服务器列表
namespace：作业命名空间
base-sleep-time-milliseconds：初始重试等待时间
max-sleep-time-milliseconds：最大重试等待时间
max-retries：最大重试次数

作业配置方式

1. 基于类的作业配置

适用于自定义作业逻辑的场景：

<!-- 定义作业Bean -->
<bean id="myJob" class="xxx.MyJob">
    <property name="fooService" ref="xxx.FooService" />
</bean>

<!-- 配置作业调度 -->
<elasticjob:job id="${myJob.id}" 
    job-ref="myJob" 
    registry-center-ref="regCenter" 
    sharding-total-count="${myJob.shardingTotalCount}" 
    cron="${myJob.cron}" />

2. 基于脚本的作业配置

适用于直接执行脚本的场景：

<elasticjob:job id="${myScriptJob.id}" 
    job-type="SCRIPT" 
    registry-center-ref="regCenter" 
    sharding-total-count="${myScriptJob.shardingTotalCount}" 
    cron="${myScriptJob.cron}">
    <props>
        <prop key="script.command.line">${myScriptJob.scriptCommandLine}</prop>
    </props>
</elasticjob:job>

作业启动方式

1. 定时调度

将配置好的 Spring XML 文件通过常规 Spring 方式启动，作业将自动按照配置的 cron 表达式定时执行。

2. 一次性调度

对于需要手动触发的作业，可以使用 OneOffJobBootstrap：

<bean id="oneOffJob" class="org.apache.shardingsphere.elasticjob.kernel.example.job.simple.SpringSimpleJob"/>
<elasticjob:job id="oneOffJobBean" job-ref="oneOffJob" ... />

Java 代码中调用：

public class SpringMain {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:META-INF/application-context.xml");
        OneOffJobBootstrap oneOffJobBootstrap = context.getBean("oneOffJobBean", OneOffJobBootstrap.class);
        oneOffJobBootstrap.execute();  // 手动执行作业
    }
}

高级配置

1. 作业快照导出

为方便调试分布式问题，可以配置作业快照导出端口：

<elasticjob:snapshot id="jobSnapshot" 
    registry-center-ref="regCenter" 
    dump-port="9999" />

配置后可以通过指定端口导出作业运行时状态信息，帮助诊断问题。

2. 错误处理策略

ElasticJob 提供了多种错误处理策略：

内置策略

<!-- 记录日志策略（默认） -->
<elasticjob:job ... job-error-handler-type="LOG" />

<!-- 抛出异常策略 -->
<elasticjob:job ... job-error-handler-type="THROW" />

<!-- 忽略异常策略 -->
<elasticjob:job ... job-error-handler-type="IGNORE" />

通知类策略

<!-- 邮件通知策略 -->
<elasticjob:job ... job-error-handler-type="EMAIL">
    <props>
        <prop key="email.host">${host}</prop>
        <!-- 其他邮件配置参数 -->
    </props>
</elasticjob:job>

<!-- 企业微信通知策略 -->
<elasticjob:job ... job-error-handler-type="WECHAT">
    <props>
        <prop key="wechat.webhook">${webhook}</prop>
        <!-- 其他企业微信配置参数 -->
    </props>
</elasticjob:job>

<!-- 钉钉通知策略 -->
<elasticjob:job ... job-error-handler-type="DINGTALK">
    <props>
        <prop key="dingtalk.webhook">${webhook}</prop>
        <!-- 其他钉钉配置参数 -->
    </props>
</elasticjob:job>