Apache ShardingSphere ElasticJob 监听器开发指南

Apache ShardingSphere ElasticJob 监听器开发指南

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

概述

Apache ShardingSphere ElasticJob 作为一款分布式任务调度框架，提供了强大的监听器机制，允许开发者在任务执行前后插入自定义逻辑。本文将详细介绍 ElasticJob 中两种监听器的使用场景和实现方式。

监听器类型

ElasticJob 提供了两种类型的监听器，适用于不同的业务场景：

1. 常规监听器 (ElasticJobListener)

常规监听器是最基础的监听器类型，每个作业节点都会执行监听逻辑。

适用场景：

• 每个节点都需要执行的预处理或后处理操作
• 不涉及全局状态的操作
• 简单的日志记录或本地资源清理

实现示例：

public class MyJobListener implements ElasticJobListener {
    
    @Override
    public void beforeJobExecuted(ShardingContexts shardingContexts) {
        // 作业执行前的逻辑
        System.out.println("作业即将执行，分片上下文：" + shardingContexts);
    }
    
    @Override
    public void afterJobExecuted(ShardingContexts shardingContexts) {
        // 作业执行后的逻辑
        System.out.println("作业执行完成，分片上下文：" + shardingContexts);
    }
    
    @Override
    public String getType() {
        return "simpleJobListener";
    }
}

特点：

• 实现简单，无需考虑分布式协调
• 每个节点独立执行，无全局状态同步
• 适合处理本地资源，如临时文件清理等

2. 分布式监听器 (AbstractDistributeOnceElasticJobListener)

分布式监听器是高级监听器类型，确保在分布式环境下某些操作只执行一次。

适用场景：

• 需要全局只执行一次的操作
• 涉及共享资源（如数据库）的清理
• 需要协调多个节点状态的操作

实现示例：

public class MyDistributeOnceJobListener extends AbstractDistributeOnceElasticJobListener {
    
    private static final long startTimeoutMills = 3000;
    private static final long completeTimeoutMills = 3000;

    public MyDistributeOnceJobListener() {
        super(startTimeoutMills, completeTimeoutMills);
    }
    
    @Override
    public void doBeforeJobExecutedAtLastStarted(ShardingContexts shardingContexts) {
        // 分布式环境下，最后一个节点启动时执行的逻辑
        System.out.println("最后一个节点启动，准备执行作业");
    }
    
    @Override
    public void doAfterJobExecutedAtLastCompleted(ShardingContexts shardingContexts) {
        // 分布式环境下，最后一个节点完成时执行的逻辑
        System.out.println("最后一个节点完成作业，可以进行全局清理");
    }
    
    @Override
    public String getType() {
        return "distributeOnceJobListener";
    }
}

特点：

• 提供了超时机制，避免死锁
• 确保关键操作只执行一次
• 需要处理分布式协调问题
• 适合处理共享资源，如数据库记录清理等

监听器注册

实现监听器后，需要通过 SPI 机制进行注册：

1. 在项目的 resources 目录下创建 META-INF/services 目录
2. 在该目录下创建文件：org.apache.shardingsphere.elasticjob.infra.listener.ElasticJobListener
3. 在文件中写入监听器的全限定类名，例如：

com.example.MyJobListener
com.example.MyDistributeOnceJobListener

最佳实践建议

1. 选择合适的监听器类型：

   • 优先考虑常规监听器，除非确实需要分布式协调
   • 分布式监听器会增加系统复杂度，应谨慎使用

2. 性能考虑：

   • 监听器中的逻辑应尽量轻量
   • 避免在监听器中执行耗时操作

3. 异常处理：

   • 监听器中应妥善处理异常
   • 考虑异常对作业执行的影响

4. 超时设置：

   • 对于分布式监听器，合理设置超时时间
   • 过短的超时可能导致误判，过长则影响系统响应

通过合理使用 ElasticJob 的监听器机制，开发者可以灵活地扩展作业功能，实现各种复杂的业务需求。

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