ElasticJob 使用 Spring 命名空间配置详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00611/article/details/148441098

ElasticJob 使用 Spring 命名空间配置详解

shardingsphere-elasticjob 项目地址: https://gitcode.com/gh_mirrors/shar/shardingsphere-elasticjob

前言

ElasticJob 作为一款分布式任务调度框架，提供了与 Spring 框架深度集成的能力。通过 Spring 命名空间的支持，开发者可以更加便捷地配置和管理作业，充分利用 Spring 的依赖注入和属性占位符等特性。本文将详细介绍如何在 Spring 环境中使用 ElasticJob 的命名空间配置。

Spring 命名空间基础配置

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

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:elasticjob="http://shardingsphere.apache.org/schema/elasticjob"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                        http://www.springframework.org/schema/beans/spring-beans.xsd 
                        http://shardingsphere.apache.org/schema/elasticjob
                        http://shardingsphere.apache.org/schema/elasticjob/elasticjob.xsd">

注册中心配置

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>

作业启动方式

定时调度

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

一次性调度

对于需要手动触发的作业，可以通过注入 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>
        <prop key="email.port">${port}</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>