Panduan Untuk CompletableFuture

1. Perkenalan

Tutorial ini adalah panduan untuk fungsionalitas dan kasus penggunaan kelas CompletableFuture yang diperkenalkan sebagai penyempurnaan Java 8 Concurrency API.

2. Komputasi Asinkron di Jawa

Komputasi asinkron sulit untuk dipikirkan. Biasanya kami ingin menganggap komputasi apa pun sebagai rangkaian langkah, tetapi dalam kasus komputasi asinkron, tindakan yang direpresentasikan sebagai callback cenderung tersebar di seluruh kode atau sangat bersarang di dalam satu sama lain . Hal-hal menjadi lebih buruk ketika kami perlu menangani kesalahan yang mungkin terjadi selama salah satu langkah.

The Future antarmuka telah ditambahkan di Jawa 5 untuk melayani sebagai hasil dari perhitungan asynchronous, tetapi tidak memiliki metode untuk menggabungkan perhitungan ini atau menangani kemungkinan kesalahan.

Java 8 memperkenalkan kelas CompletableFuture . Bersamaan dengan antarmuka Future , itu juga mengimplementasikan antarmuka CompletionStage . Antarmuka ini mendefinisikan kontrak untuk langkah komputasi asinkron yang dapat kita gabungkan dengan langkah lain.

CompletableFuture pada saat yang sama merupakan blok penyusun dan kerangka kerja, dengan sekitar 50 metode berbeda untuk menyusun, menggabungkan, dan menjalankan langkah-langkah komputasi asinkron dan menangani kesalahan .

API sebesar itu bisa sangat membebani, tetapi ini sebagian besar termasuk dalam beberapa kasus penggunaan yang jelas dan berbeda.

3. Menggunakan CompletableFuture sebagai Masa Depan yang Sederhana

Pertama-tama, kelas CompletableFuture mengimplementasikan antarmuka Future , sehingga kita dapat menggunakannya sebagai implementasi Future , tetapi dengan logika penyelesaian tambahan .

Misalnya, kita dapat membuat instance kelas ini dengan konstruktor no-arg untuk mewakili beberapa hasil di masa mendatang, memberikannya kepada konsumen, dan menyelesaikannya di masa mendatang menggunakan metode lengkap . Konsumen dapat menggunakan metode get untuk memblokir utas saat ini hingga hasil ini diberikan.

Dalam contoh di bawah ini, kami memiliki metode yang membuat instance CompletableFuture , lalu memutar beberapa komputasi di thread lain dan segera mengembalikan Future .

Saat komputasi selesai, metode tersebut menyelesaikan Future dengan memberikan hasil ke metode lengkap :

public Future calculateAsync() throws InterruptedException { CompletableFuture completableFuture = new CompletableFuture(); Executors.newCachedThreadPool().submit(() -> { Thread.sleep(500); completableFuture.complete("Hello"); return null; }); return completableFuture; }

Untuk menjalankan komputasi, kami menggunakan Executor API. Metode pembuatan dan penyelesaian CompletableFuture ini dapat digunakan bersama dengan mekanisme konkurensi atau API, termasuk thread mentah.

Perhatikan bahwa yang calculateAsync metode mengembalikan Masa Depan contoh .

Kita cukup memanggil metode tersebut, menerima instance Future , dan memanggil metode get di atasnya ketika kita siap untuk memblokir hasilnya.

Perhatikan juga bahwa metode get melontarkan beberapa pengecualian yang dicentang, yaitu ExecutionException (merangkum pengecualian yang terjadi selama komputasi) dan InterruptedException (pengecualian yang menandakan bahwa utas yang menjalankan metode telah diinterupsi):

Future completableFuture = calculateAsync(); // ... String result = completableFuture.get(); assertEquals("Hello", result);

Jika kita sudah mengetahui hasil komputasi , kita bisa menggunakan metode completeFuture statis dengan argumen yang mewakili hasil komputasi ini. Akibatnya, metode get dari Future tidak akan pernah diblokir, langsung mengembalikan hasil ini sebagai gantinya:

Future completableFuture = CompletableFuture.completedFuture("Hello"); // ... String result = completableFuture.get(); assertEquals("Hello", result);

Sebagai skenario alternatif, kami mungkin ingin membatalkan eksekusi Future .

4. CompletableFuture dengan Logika Perhitungan Terenkapsulasi

Kode di atas memungkinkan kita untuk memilih mekanisme apa pun dari eksekusi bersamaan, tetapi bagaimana jika kita ingin melewati boilerplate ini dan cukup mengeksekusi beberapa kode secara asinkron?

Metode statis runAsync dan supplyAsync memungkinkan kita membuat instance CompletableFuture dari jenis fungsional Runnable dan Pemasok yang sesuai.

Baik Runnable dan Supplier adalah antarmuka fungsional yang memungkinkan penerusan instansnya sebagai ekspresi lambda berkat fitur Java 8 yang baru.

The Runnable interface antarmuka lama yang sama yang digunakan dalam benang dan tidak memungkinkan untuk mengembalikan nilai.

The Pemasok antarmuka adalah antarmuka fungsional generik dengan metode tunggal yang tidak memiliki argumen dan mengembalikan nilai dari jenis parameter.

Ini memungkinkan kami untuk memberikan contoh Pemasok sebagai ekspresi lambda yang melakukan kalkulasi dan mengembalikan hasilnya . Ini sesederhana:

CompletableFuture future = CompletableFuture.supplyAsync(() -> "Hello"); // ... assertEquals("Hello", future.get());

5. Memproses Hasil Perhitungan Asynchronous

Cara paling umum untuk memproses hasil komputasi adalah dengan memasukkannya ke suatu fungsi. The thenApply metode tidak tepat; itu menerima instance Fungsi , menggunakannya untuk memproses hasilnya, dan mengembalikan Future yang menyimpan nilai yang dikembalikan oleh suatu fungsi:

CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> "Hello"); CompletableFuture future = completableFuture .thenApply(s -> s + " World"); assertEquals("Hello World", future.get());

Jika kita tidak perlu mengembalikan nilai ke rantai Future , kita dapat menggunakan instance dari antarmuka fungsional Konsumen . Metode tunggalnya mengambil parameter dan mengembalikan void .

Ada metode untuk kasus penggunaan ini di CompletableFuture. The thenAccept Metode menerima Konsumen dan dibagikan hasil perhitungan. Kemudian panggilan future.get () terakhir mengembalikan sebuah instance dari tipe Void :

CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> "Hello"); CompletableFuture future = completableFuture .thenAccept(s -> System.out.println("Computation returned: " + s)); future.get();

Terakhir, jika kita tidak memerlukan nilai komputasi, atau ingin mengembalikan beberapa nilai di akhir rantai, maka kita bisa meneruskan lambda Runnable ke metode thenRun . Dalam contoh berikut, kami hanya mencetak baris di konsol setelah memanggil future.get ():

CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> "Hello"); CompletableFuture future = completableFuture .thenRun(() -> System.out.println("Computation finished.")); future.get();

6. Menggabungkan Futures

The best part of the CompletableFuture API is the ability to combine CompletableFuture instances in a chain of computation steps.

The result of this chaining is itself a CompletableFuture that allows further chaining and combining. This approach is ubiquitous in functional languages and is often referred to as a monadic design pattern.

In the following example we use the thenCompose method to chain two Futures sequentially.

Notice that this method takes a function that returns a CompletableFuture instance. The argument of this function is the result of the previous computation step. This allows us to use this value inside the next CompletableFuture‘s lambda:

CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> "Hello") .thenCompose(s -> CompletableFuture.supplyAsync(() -> s + " World")); assertEquals("Hello World", completableFuture.get());

The thenCompose method, together with thenApply, implement basic building blocks of the monadic pattern. They closely relate to the map and flatMap methods of Stream and Optional classes also available in Java 8.

Both methods receive a function and apply it to the computation result, but the thenCompose (flatMap) method receives a function that returns another object of the same type. This functional structure allows composing the instances of these classes as building blocks.

If we want to execute two independent Futures and do something with their results, we can use the thenCombine method that accepts a Future and a Function with two arguments to process both results:

CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> "Hello") .thenCombine(CompletableFuture.supplyAsync( () -> " World"), (s1, s2) -> s1 + s2)); assertEquals("Hello World", completableFuture.get());

A simpler case is when we want to do something with two Futures‘ results, but don't need to pass any resulting value down a Future chain. The thenAcceptBoth method is there to help:

CompletableFuture future = CompletableFuture.supplyAsync(() -> "Hello") .thenAcceptBoth(CompletableFuture.supplyAsync(() -> " World"), (s1, s2) -> System.out.println(s1 + s2));

7. Difference Between thenApply() and thenCompose()

In our previous sections, we've shown examples regarding thenApply() and thenCompose(). Both APIs help chain different CompletableFuture calls, but the usage of these 2 functions is different.

7.1. thenApply()

We can use this method to work with a result of the previous call. However, a key point to remember is that the return type will be combined of all calls.

So this method is useful when we want to transform the result of a CompletableFuture call:

CompletableFuture finalResult = compute().thenApply(s-> s + 1);

7.2. thenCompose()

The thenCompose() method is similar to thenApply() in that both return a new Completion Stage. However, thenCompose() uses the previous stage as the argument. It will flatten and return a Future with the result directly, rather than a nested future as we observed in thenApply():

CompletableFuture computeAnother(Integer i){ return CompletableFuture.supplyAsync(() -> 10 + i); } CompletableFuture finalResult = compute().thenCompose(this::computeAnother);

So if the idea is to chain CompletableFuture methods then it’s better to use thenCompose().

Also, note that the difference between these two methods is analogous to the difference between map() and flatMap().

8. Running Multiple Futures in Parallel

When we need to execute multiple Futures in parallel, we usually want to wait for all of them to execute and then process their combined results.

The CompletableFuture.allOf static method allows to wait for completion of all of the Futures provided as a var-arg:

CompletableFuture future1 = CompletableFuture.supplyAsync(() -> "Hello"); CompletableFuture future2 = CompletableFuture.supplyAsync(() -> "Beautiful"); CompletableFuture future3 = CompletableFuture.supplyAsync(() -> "World"); CompletableFuture combinedFuture = CompletableFuture.allOf(future1, future2, future3); // ... combinedFuture.get(); assertTrue(future1.isDone()); assertTrue(future2.isDone()); assertTrue(future3.isDone());

Notice that the return type of the CompletableFuture.allOf() is a CompletableFuture. The limitation of this method is that it does not return the combined results of all Futures. Instead, we have to manually get results from Futures. Fortunately, CompletableFuture.join() method and Java 8 Streams API makes it simple:

String combined = Stream.of(future1, future2, future3) .map(CompletableFuture::join) .collect(Collectors.joining(" ")); assertEquals("Hello Beautiful World", combined);

The CompletableFuture.join() method is similar to the get method, but it throws an unchecked exception in case the Future does not complete normally. This makes it possible to use it as a method reference in the Stream.map() method.

9. Handling Errors

For error handling in a chain of asynchronous computation steps, we have to adapt the throw/catch idiom in a similar fashion.

Instead of catching an exception in a syntactic block, the CompletableFuture class allows us to handle it in a special handle method. This method receives two parameters: a result of a computation (if it finished successfully), and the exception thrown (if some computation step did not complete normally).

In the following example, we use the handle method to provide a default value when the asynchronous computation of a greeting was finished with an error because no name was provided:

String name = null; // ... CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> { if (name == null) { throw new RuntimeException("Computation error!"); } return "Hello, " + name; })}).handle((s, t) -> s != null ? s : "Hello, Stranger!"); assertEquals("Hello, Stranger!", completableFuture.get());

As an alternative scenario, suppose we want to manually complete the Future with a value, as in the first example, but also have the ability to complete it with an exception. The completeExceptionally method is intended for just that. The completableFuture.get() method in the following example throws an ExecutionException with a RuntimeException as its cause:

CompletableFuture completableFuture = new CompletableFuture(); // ... completableFuture.completeExceptionally( new RuntimeException("Calculation failed!")); // ... completableFuture.get(); // ExecutionException

In the example above, we could have handled the exception with the handle method asynchronously, but with the get method we can use the more typical approach of a synchronous exception processing.

10. Async Methods

Most methods of the fluent API in CompletableFuture class have two additional variants with the Async postfix. These methods are usually intended for running a corresponding step of execution in another thread.

The methods without the Async postfix run the next execution stage using a calling thread. In contrast, the Async method without the Executor argument runs a step using the common fork/join pool implementation of Executor that is accessed with the ForkJoinPool.commonPool() method. Finally, the Async method with an Executor argument runs a step using the passed Executor.

Here's a modified example that processes the result of a computation with a Function instance. The only visible difference is the thenApplyAsync method, but under the hood the application of a function is wrapped into a ForkJoinTask instance (for more information on the fork/join framework, see the article “Guide to the Fork/Join Framework in Java”). This allows us to parallelize our computation even more and use system resources more efficiently:

CompletableFuture completableFuture = CompletableFuture.supplyAsync(() -> "Hello"); CompletableFuture future = completableFuture .thenApplyAsync(s -> s + " World"); assertEquals("Hello World", future.get());

11. JDK 9 CompletableFuture API

Java 9 enhances the CompletableFuture API with the following changes:

  • New factory methods added
  • Support for delays and timeouts
  • Improved support for subclassing

and new instance APIs:

  • Executor defaultExecutor()
  • CompletableFuture newIncompleteFuture()
  • CompletableFuture copy()
  • CompletionStage minimalCompletionStage()
  • CompletableFuture completeAsync(Supplier supplier, Executor executor)
  • CompletableFuture completeAsync(Supplier supplier)
  • CompletableFuture orTimeout(long timeout, TimeUnit unit)
  • CompletableFuture completeOnTimeout(T value, long timeout, TimeUnit unit)

We also now have a few static utility methods:

  • Executor delayedExecutor(long delay, TimeUnit unit, Executor executor)
  • Executor delayedExecutor(long delay, TimeUnit unit)
  • CompletionStage completedStage(U value)
  • CompletionStage failedStage(Throwable ex)
  • CompletableFuture failedFuture(Throwable ex)

Finally, to address timeout, Java 9 has introduced two more new functions:

  • orTimeout()
  • completeOnTimeout()

Here's the detailed article for further reading: Java 9 CompletableFuture API Improvements.

12. Conclusion

Dalam artikel ini, kami telah menjelaskan metode dan kasus penggunaan umum kelas CompletableFuture .

Kode sumber artikel tersedia di GitHub.