Java执行程序:如何在任务完成时通知而不阻塞?

时间:2009-05-05 18:13:57

标签: java callback notify executor

假设我有一个充满任务的队列,我需要将其提交给执行程序服务。我希望他们一次处理一个。我能想到的最简单的方法是:

  1. 从队列中获取任务
  2. 将其提交给遗嘱执行人
  3. 在返回的Future上调用.get并阻止,直到结果可用
  4. 从队列中取出另一项任务......
  5. 但是,我试图完全避免阻塞。如果我有10,000个这样的队列,需要一次处理一个任务,我将耗尽堆栈空间,因为它们中的大多数将保持被阻塞的线程。

    我想要的是提交任务并提供在任务完成时调用的回叫。我将使用该回叫通知作为发送下一个任务的标志。 (functionaljava和jetlang显然使用了这种非阻塞算法,但我无法理解他们的代码)

    如何使用JDK的java.util.concurrent,而不是编写自己的执行器服务?

    (向我提供这些任务的队列本身可以阻止,但这是一个需要解决的问题)

11 个答案:

答案 0 :(得分:127)

定义一个回调接口,以接收您希望在完成通知中传递的任何参数。然后在任务结束时调用它。

您甚至可以为Runnable任务编写一般包装器,并将它们提交给ExecutorService。或者,请参阅下面的Java 8中内置的机制。

class CallbackTask implements Runnable {

  private final Runnable task;

  private final Callback callback;

  CallbackTask(Runnable task, Callback callback) {
    this.task = task;
    this.callback = callback;
  }

  public void run() {
    task.run();
    callback.complete();
  }

}

使用CompletableFuture,Java 8包含了更复杂的方法来组成流程,其中流程可以异步和有条件地完成。这是一个人为但完整的通知示例。

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;

public class GetTaskNotificationWithoutBlocking {

  public static void main(String... argv) throws Exception {
    ExampleService svc = new ExampleService();
    GetTaskNotificationWithoutBlocking listener = new GetTaskNotificationWithoutBlocking();
    CompletableFuture<String> f = CompletableFuture.supplyAsync(svc::work);
    f.thenAccept(listener::notify);
    System.out.println("Exiting main()");
  }

  void notify(String msg) {
    System.out.println("Received message: " + msg);
  }

}

class ExampleService {

  String work() {
    sleep(7000, TimeUnit.MILLISECONDS); /* Pretend to be busy... */
    char[] str = new char[5];
    ThreadLocalRandom current = ThreadLocalRandom.current();
    for (int idx = 0; idx < str.length; ++idx)
      str[idx] = (char) ('A' + current.nextInt(26));
    String msg = new String(str);
    System.out.println("Generated message: " + msg);
    return msg;
  }

  public static void sleep(long average, TimeUnit unit) {
    String name = Thread.currentThread().getName();
    long timeout = Math.min(exponential(average), Math.multiplyExact(10, average));
    System.out.printf("%s sleeping %d %s...%n", name, timeout, unit);
    try {
      unit.sleep(timeout);
      System.out.println(name + " awoke.");
    } catch (InterruptedException abort) {
      Thread.currentThread().interrupt();
      System.out.println(name + " interrupted.");
    }
  }

  public static long exponential(long avg) {
    return (long) (avg * -Math.log(1 - ThreadLocalRandom.current().nextDouble()));
  }

}

答案 1 :(得分:47)

在Java 8中,您可以使用CompletableFuture。以下是我在代码中使用的示例,我使用它从我的用户服务中获取用户,将它们映射到我的视图对象,然后更新我的视图或显示错误对话框(这是一个GUI应用程序) ):

    CompletableFuture.supplyAsync(
            userService::listUsers
    ).thenApply(
            this::mapUsersToUserViews
    ).thenAccept(
            this::updateView
    ).exceptionally(
            throwable -> { showErrorDialogFor(throwable); return null; }
    );

它以异步方式执行。我使用了两种私有方法:mapUsersToUserViewsupdateView

答案 2 :(得分:46)

使用Guava's listenable future API并添加回调。参看来自网站:

ListeningExecutorService service = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(10));
ListenableFuture<Explosion> explosion = service.submit(new Callable<Explosion>() {
  public Explosion call() {
    return pushBigRedButton();
  }
});
Futures.addCallback(explosion, new FutureCallback<Explosion>() {
  // we want this handler to run immediately after we push the big red button!
  public void onSuccess(Explosion explosion) {
    walkAwayFrom(explosion);
  }
  public void onFailure(Throwable thrown) {
    battleArchNemesis(); // escaped the explosion!
  }
});

答案 3 :(得分:24)

您可以扩展FutureTask类,并覆盖done()方法,然后将FutureTask对象添加到ExecutorService,以便调用done()方法当FutureTask立即完成时。

答案 4 :(得分:14)

ThreadPoolExecutor还有beforeExecuteafterExecute个钩子方法,您可以覆盖并使用它们。以下是ThreadPoolExecutor的{​​{3}}的说明。

  

钩子方法

     

此类提供在执行每个任务之前和之后调用的受保护的可覆盖JavadocsbeforeExecute(java.lang.Thread, java.lang.Runnable)方法。这些可以用来操纵执行环境;例如,重新初始化ThreadLocals,收集统计信息或添加日志条目。此外,可以覆盖方法afterExecute(java.lang.Runnable, java.lang.Throwable)以执行Executor完全终止后需要执行的任何特殊处理。如果钩子或回调方法抛出异常,内部工作线程可能会失败并突然终止。

答案 5 :(得分:6)

使用CountDownLatch

它来自java.util.concurrent,它正是在继续之前等待多个线程完成执行的方式。

为了实现您正在寻找的回调效果,这需要一些额外的额外工作。也就是说,在一个使用CountDownLatch的单独线程中自己处理它并等待它,然后继续通知您需要通知的任何内容。回调没有原生支持,或类似的效果。


编辑:现在,我进一步了解了您的问题,我认为您已经走得太远,不必要。如果你定期SingleThreadExecutor,给它完成所有任务,它将在本地进行排队。

答案 6 :(得分:4)

如果您想确保不会同时运行任务,请使用SingleThreadedExecutor。任务将按提交的顺序处理。您甚至不需要保留任务,只需将它们提交给执行人员。

答案 7 :(得分:1)

只是为了补充Matt的答案,这有助于,这是一个更加充实的例子来展示回调的使用。

private static Primes primes = new Primes();

public static void main(String[] args) throws InterruptedException {
    getPrimeAsync((p) ->
        System.out.println("onPrimeListener; p=" + p));

    System.out.println("Adios mi amigito");
}
public interface OnPrimeListener {
    void onPrime(int prime);
}
public static void getPrimeAsync(OnPrimeListener listener) {
    CompletableFuture.supplyAsync(primes::getNextPrime)
        .thenApply((prime) -> {
            System.out.println("getPrimeAsync(); prime=" + prime);
            if (listener != null) {
                listener.onPrime(prime);
            }
            return prime;
        });
}

输出结果为:

    getPrimeAsync(); prime=241
    onPrimeListener; p=241
    Adios mi amigito

答案 8 :(得分:1)

这是使用Guava的ListenableFuture对Pache答案的扩展。

特别是,Futures.transform()返回ListenableFuture,因此可用于链接异步调用。 Futures.addCallback()返回void,因此不能用于链接,但有助于在异步完成时处理成功/失败。

// ListenableFuture1: Open Database
ListenableFuture<Database> database = service.submit(() -> openDatabase());

// ListenableFuture2: Query Database for Cursor rows
ListenableFuture<Cursor> cursor =
    Futures.transform(database, database -> database.query(table, ...));

// ListenableFuture3: Convert Cursor rows to List<Foo>
ListenableFuture<List<Foo>> fooList =
    Futures.transform(cursor, cursor -> cursorToFooList(cursor));

// Final Callback: Handle the success/errors when final future completes
Futures.addCallback(fooList, new FutureCallback<List<Foo>>() {
  public void onSuccess(List<Foo> foos) {
    doSomethingWith(foos);
  }
  public void onFailure(Throwable thrown) {
    log.error(thrown);
  }
});

注意:除了链接异步任务外,Futures.transform()还允许您在单独的执行程序上安排每项任务(本示例中未显示)。

答案 9 :(得分:1)

使用Callback

实现ExecutorService机制的简单代码
import java.util.concurrent.*;
import java.util.*;

public class CallBackDemo{
    public CallBackDemo(){
        System.out.println("creating service");
        ExecutorService service = Executors.newFixedThreadPool(5);

        try{
            for ( int i=0; i<5; i++){
                Callback callback = new Callback(i+1);
                MyCallable myCallable = new MyCallable((long)i+1,callback);
                Future<Long> future = service.submit(myCallable);
                //System.out.println("future status:"+future.get()+":"+future.isDone());
            }
        }catch(Exception err){
            err.printStackTrace();
        }
        service.shutdown();
    }
    public static void main(String args[]){
        CallBackDemo demo = new CallBackDemo();
    }
}
class MyCallable implements Callable<Long>{
    Long id = 0L;
    Callback callback;
    public MyCallable(Long val,Callback obj){
        this.id = val;
        this.callback = obj;
    }
    public Long call(){
        //Add your business logic
        System.out.println("Callable:"+id+":"+Thread.currentThread().getName());
        callback.callbackMethod();
        return id;
    }
}
class Callback {
    private int i;
    public Callback(int i){
        this.i = i;
    }
    public void callbackMethod(){
        System.out.println("Call back:"+i);
        // Add your business logic
    }
}

输出:

creating service
Callable:1:pool-1-thread-1
Call back:1
Callable:3:pool-1-thread-3
Callable:2:pool-1-thread-2
Call back:2
Callable:5:pool-1-thread-5
Call back:5
Call back:3
Callable:4:pool-1-thread-4
Call back:4

主要提示:

  1. 如果您想按FIFO顺序依次处理流程任务,请将newFixedThreadPool(5)替换为newFixedThreadPool(1)
  2. 如果您想在分析上一个任务callback的结果后处理下一个任务,只需在行下方取消评论

    //System.out.println("future status:"+future.get()+":"+future.isDone());
    
  3. 您可以将newFixedThreadPool()替换为

    之一
    Executors.newCachedThreadPool()
    Executors.newWorkStealingPool()
    ThreadPoolExecutor
    

    取决于您的使用案例。

  4. 如果要异步处理回调方法

    一个。将共享的ExecutorService or ThreadPoolExecutor传递给Callable任务

    湾将您的Callable方法转换为Callable/Runnable任务

    ℃。将回调任务推送到ExecutorService or ThreadPoolExecutor

答案 10 :(得分:0)

您可以使用Callable的实现,以便

public class MyAsyncCallable<V> implements Callable<V> {

    CallbackInterface ci;

    public MyAsyncCallable(CallbackInterface ci) {
        this.ci = ci;
    }

    public V call() throws Exception {

        System.out.println("Call of MyCallable invoked");
        System.out.println("Result = " + this.ci.doSomething(10, 20));
        return (V) "Good job";
    }
}

其中CallbackInterface是非常基本的东西,如

public interface CallbackInterface {
    public int doSomething(int a, int b);
}

现在主要类看起来像这样

ExecutorService ex = Executors.newFixedThreadPool(2);

MyAsyncCallable<String> mac = new MyAsyncCallable<String>((a, b) -> a + b);
ex.submit(mac);