Common Listener

If the job processes the files of the job server and deletes the files after the processing is completed, consider using each node to perform the cleaning task. This type of task is simple to implement, and there is no need to consider whether the global distributed task is completed. You should try to use this type of listener.

  2. public class MyJobListener implements ElasticJobListener {
  4.     @Override
  5.     public void beforeJobExecuted(ShardingContexts shardingContexts) {
  6.         // do something ...
  7.     }
  9.     @Override
  10.     public void afterJobExecuted(ShardingContexts shardingContexts) {
  11.         // do something ...
  12.     }
  14.     @Override
  15.     public String getType() {
  16.         return "simpleJobListener";
  17.     }
  18. }

Distributed Listener

If the job processes database data, only one node needs to complete the data cleaning task after the processing is completed. This type of task is complicated to process and needs to synchronize the status of the job in a distributed environment. Timeout settings are provided to avoid deadlocks caused by job out of sync. It should be used with caution.

  2. public class MyDistributeOnceJobListener extends AbstractDistributeOnceElasticJobListener {
  4.     public TestDistributeOnceElasticJobListener(long startTimeoutMills, long completeTimeoutMills) {
  5.         super(startTimeoutMills, completeTimeoutMills);
  6.     }
  8.     @Override
  9.     public void doBeforeJobExecutedAtLastStarted(ShardingContexts shardingContexts) {
  10.         // do something ...
  11.     }
  13.     @Override
  14.     public void doAfterJobExecutedAtLastCompleted(ShardingContexts shardingContexts) {
  15.         // do something ...
  16.     }
  18.     @Override
  19.     public String getType() {
  20.         return "distributeOnceJobListener";
  21.     }
  22. }

Add SPI implementation

Put JobListener implementation to module infra-common, resources/META-INF/services/org.apache.shardingsphere.elasticjob.infra.listener.ElasticJobListener