Ръководство за java.util.concurrent.Future

1. Общ преглед

В тази статия ще научим за бъдещето . Интерфейс, който съществува от Java 1.5 и може да бъде доста полезен при работа с асинхронни обаждания и едновременна обработка.

2. Създаване на фючърси

Просто казано, класът Future представлява бъдещ резултат от асинхронно изчисление - резултат, който в крайна сметка ще се появи в бъдещето след завършване на обработката.

Нека да видим как да напишем методи, които създават и връщат бъдещ екземпляр.

Дълго работещите методи са добри кандидати за асинхронна обработка и интерфейс Future . Това ни позволява да изпълним някакъв друг процес, докато чакаме задачата, капсулирана в Future, да завърши.

Някои примери за операции, които биха използвали асинхронния характер на бъдещето, са:

  • интензивни изчислителни процеси (математически и научни изчисления)
  • манипулиране на големи структури от данни (големи данни)
  • отдалечени извиквания на методи (изтегляне на файлове, HTML бракуване, уеб услуги).

2.1. Прилагане на фючърси с FutureTask

За нашия пример ще създадем много прост клас, който изчислява квадрата на цяло число . Това определено не отговаря на категорията "дългосрочни" методи, но ние ще поставим извикване на Thread.sleep () , за да продължи 1 секунда за завършване:

public class SquareCalculator { private ExecutorService executor = Executors.newSingleThreadExecutor(); public Future calculate(Integer input) { return executor.submit(() -> { Thread.sleep(1000); return input * input; }); } }

Битовият код, който действително извършва изчислението, се съдържа в метода call () , предоставен като ламбда израз. Както можете да видите, че има нищо специално за него, с изключение на сън () повикване споменах по-рано.

Става по-интересно, когато насочим вниманието си към използването на Callable и ExecutorService .

Callable е интерфейс, представляващ задача, която връща резултат и има метод с едно извикване () . Тук създадохме негов екземпляр, използвайки ламбда израз.

Създаването на екземпляр на Callable не ни отвежда никъде, все пак трябва да го предадем на изпълнител, който ще се погрижи за стартирането на тази задача в нова нишка и ще ни върне ценния обект Future . Това е мястото, където влиза ExecutorService .

Има няколко начина, по които можем да намерим екземпляр на ExecutorService , повечето от тях се предоставят от статичните фабрични методи на Executors на помощния клас . В този пример използвахме основния newSingleThreadExecutor () , който ни дава ExecutorService, способен да обработва по една нишка в даден момент.

След като имаме обект ExecutorService , просто трябва да извикаме submit (), предавайки Callable като аргумент. submit () ще се погрижи за стартиране на задачата и ще върне обект FutureTask , който е реализация на интерфейса Future .

3. Потребление на фючърси

До този момент научихме как да създадем екземпляр на бъдещето .

В този раздел ще научим как да работим с този екземпляр, като изследваме всички методи, които са част от API на Future .

3.1. Използване на isDone () и get () за получаване на резултати

Сега трябва да извикаме calcu () и да използваме върнатото Future, за да получим полученото цяло число . Два метода от API на Future ще ни помогнат с тази задача.

Future.isDone () ни казва дали изпълнителят е завършил обработката на задачата. Ако задачата е изпълнена, тя ще върне true в противен случай, връща false .

Методът, който връща действителния резултат от изчислението, е Future.get () . Забележете, че този метод блокира изпълнението, докато задачата не завърши, но в нашия пример това няма да е проблем, тъй като първо ще проверим дали задачата е завършена чрез извикване на isDone () .

Използвайки тези два метода, можем да стартираме друг код, докато чакаме основната задача да приключи:

Future future = new SquareCalculator().calculate(10); while(!future.isDone()) { System.out.println("Calculating..."); Thread.sleep(300); } Integer result = future.get();

В този пример ние пишем просто съобщение на изхода, за да уведомим потребителя, че програмата извършва изчислението.

Методът get () ще блокира изпълнението, докато задачата приключи. Но не трябва да се притесняваме за това, тъй като нашият пример стига до точката, в която се извиква get (), след като се уверим, че задачата е завършена. Така че, в този сценарий, future.get () винаги ще се връща незабавно.

Струва си да се спомене, че get () има претоварена версия, която взема време на изчакване и TimeUnit като аргументи:

Integer result = future.get(500, TimeUnit.MILLISECONDS);

Разликата между get (long, TimeUnit) и get () е, че първият ще хвърли TimeoutException, ако задачата не се върне преди посочения период на изчакване.

3.2. Отмяна на бъдеще с анулиране ()

Suppose we've triggered a task but, for some reason, we don't care about the result anymore. We can use Future.cancel(boolean) to tell the executor to stop the operation and interrupt its underlying thread:

Future future = new SquareCalculator().calculate(4); boolean canceled = future.cancel(true);

Our instance of Future from the code above would never complete its operation. In fact, if we try to call get() from that instance, after the call to cancel(), the outcome would be a CancellationException. Future.isCancelled() will tell us if a Future was already canceled. This can be quite useful to avoid getting a CancellationException.

It is possible that a call to cancel() fails. In that case, its returned value will be false. Notice that cancel() takes a boolean value as an argument – this controls whether the thread executing this task should be interrupted or not.

4. More Multithreading With Thread Pools

Our current ExecutorService is single threaded since it was obtained with the Executors.newSingleThreadExecutor. To highlight this “single threadness”, let's trigger two calculations simultaneously:

SquareCalculator squareCalculator = new SquareCalculator(); Future future1 = squareCalculator.calculate(10); Future future2 = squareCalculator.calculate(100); while (!(future1.isDone() && future2.isDone())) { System.out.println( String.format( "future1 is %s and future2 is %s", future1.isDone() ? "done" : "not done", future2.isDone() ? "done" : "not done" ) ); Thread.sleep(300); } Integer result1 = future1.get(); Integer result2 = future2.get(); System.out.println(result1 + " and " + result2); squareCalculator.shutdown();

Now let's analyze the output for this code:

calculating square for: 10 future1 is not done and future2 is not done future1 is not done and future2 is not done future1 is not done and future2 is not done future1 is not done and future2 is not done calculating square for: 100 future1 is done and future2 is not done future1 is done and future2 is not done future1 is done and future2 is not done 100 and 10000

It is clear that the process is not parallel. Notice how the second task only starts once the first task is completed, making the whole process take around 2 seconds to finish.

To make our program really multi-threaded we should use a different flavor of ExecutorService. Let's see how the behavior of our example changes if we use a thread pool, provided by the factory method Executors.newFixedThreadPool():

public class SquareCalculator { private ExecutorService executor = Executors.newFixedThreadPool(2); //... }

With a simple change in our SquareCalculator class now we have an executor which is able to use 2 simultaneous threads.

If we run the exact same client code again, we'll get the following output:

calculating square for: 10 calculating square for: 100 future1 is not done and future2 is not done future1 is not done and future2 is not done future1 is not done and future2 is not done future1 is not done and future2 is not done 100 and 10000

This is looking much better now. Notice how the 2 tasks start and finish running simultaneously, and the whole process takes around 1 second to complete.

There are other factory methods that can be used to create thread pools, like Executors.newCachedThreadPool() that reuses previously used Threads when they are available, and Executors.newScheduledThreadPool() which schedules commands to run after a given delay.

For more information about ExecutorService, read our article dedicated to the subject.

5. Overview of ForkJoinTask

ForkJoinTask is an abstract class which implements Future and is capable of running a large number of tasks hosted by a small number of actual threads in ForkJoinPool.

In this section, we are going to quickly cover the main characteristics of ForkJoinPool. For a comprehensive guide about the topic, check our Guide to the Fork/Join Framework in Java.

Then the main characteristic of a ForkJoinTask is that it usually will spawn new subtasks as part of the work required to complete its main task. It generates new tasks by calling fork() and it gathers all results with join(), thus the name of the class.

There are two abstract classes that implement ForkJoinTask: RecursiveTask which returns a value upon completion, and RecursiveAction which doesn't return anything. As the names imply, those classes are to be used for recursive tasks, like for example file-system navigation or complex mathematical computation.

Let's expand our previous example to create a class that, given an Integer, will calculate the sum squares for all its factorial elements. So, for instance, if we pass the number 4 to our calculator, we should get the result from the sum of 4² + 3² + 2² + 1² which is 30.

First of all, we need to create a concrete implementation of RecursiveTask and implement its compute() method. This is where we'll write our business logic:

public class FactorialSquareCalculator extends RecursiveTask { private Integer n; public FactorialSquareCalculator(Integer n) { this.n = n; } @Override protected Integer compute() { if (n <= 1) { return n; } FactorialSquareCalculator calculator = new FactorialSquareCalculator(n - 1); calculator.fork(); return n * n + calculator.join(); } }

Notice how we achieve recursiveness by creating a new instance of FactorialSquareCalculator within compute(). By calling fork(), a non-blocking method, we ask ForkJoinPool to initiate the execution of this subtask.

The join() method will return the result from that calculation, to which we add the square of the number we are currently visiting.

Now we just need to create a ForkJoinPool to handle the execution and thread management:

ForkJoinPool forkJoinPool = new ForkJoinPool(); FactorialSquareCalculator calculator = new FactorialSquareCalculator(10); forkJoinPool.execute(calculator);

6. Conclusion

In this article, we had a comprehensive view of the Future interface, visiting all its methods. We've also learned how to leverage the power of thread pools to trigger multiple parallel operations. The main methods from the ForkJoinTask class, fork() and join() were briefly covered as well.

We have many other great articles on parallel and asynchronous operations in Java. Here are three of them that are closely related to the Future interface (some of them are already mentioned in the article):

  • Guide to CompletableFuture – an implementation of Future with many extra features introduced in Java 8
  • Ръководство за рамката Fork / Join в Java - повече за ForkJoinTask, която разгледахме в раздел 5
  • Ръководство за Java ExecutorService - посветено на интерфейса ExecutorService

Проверете изходния код, използван в тази статия в нашето хранилище на GitHub.