ElasticJob监听器接口开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00229/article/details/148441102

ElasticJob监听器接口开发指南

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

什么是ElasticJob监听器

ElasticJob提供了强大的监听器机制，允许开发者在作业执行前后插入自定义逻辑。监听器分为两种类型：常规监听器和分布式监听器，它们分别适用于不同的业务场景。

常规监听器开发

常规监听器是最基础的监听器类型，它会在每个作业节点上独立执行，不涉及分布式协调。

适用场景

每个节点需要独立执行的任务
不需要全局协调的简单操作
例如：清理节点本地临时文件、记录节点执行日志等

开发步骤

实现ElasticJobListener接口
重写beforeJobExecuted方法（作业执行前调用）
重写afterJobExecuted方法（作业执行后调用）
实现getType方法返回监听器类型标识

示例代码

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 "mySimpleJobListener";
    }
}

分布式监听器开发

分布式监听器是更高级的监听器类型，它确保在分布式环境下某些逻辑只由一个节点执行。

适用场景

需要全局只执行一次的任务
涉及分布式资源协调的操作
例如：清理共享数据库数据、发送全局通知等

开发步骤

继承AbstractDistributeOnceElasticJobListener抽象类
在构造函数中设置超时时间（避免死锁）
重写doBeforeJobExecutedAtLastStarted方法（最后一个节点启动前执行）
重写doAfterJobExecutedAtLastCompleted方法（最后一个节点完成后执行）
实现getType方法返回监听器类型标识

示例代码

public class MyDistributeOnceJobListener extends AbstractDistributeOnceElasticJobListener {
    
    // 启动超时时间（毫秒）
    private static final long startTimeoutMills = 5000;
    // 完成超时时间（毫秒）
    private static final long completeTimeoutMills = 10000;

    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 "myDistributeOnceJobListener";
    }
}