java.util.concurrent.CompletableFuture
sites Появившийся в Java8 класс CompletableFuture — средство для передачи информации между параллельными потоками исполнения. По существу это блокирующая очередь, способная передать только одно ссылочное значение. В отличие от обычной очереди, передает также исключение, если оно возникло при вычислении передаваемого значения.
(Для краткости вместо “объект типа CompletableFuture” будем говорить “фьючерс”)
Как средство передачи данных, класс CompletableFuture имеет два суб-интерфейса — для записи и для чтения, которые в свою очередь делятся на непосредственные (синхронные) и опосредованные (асинхронные).
1. Интерфейс непосредственной записи значения/Exception для передачи
Базовых методов, понятно, два — записать значение и записать исключение:
boolean complete(T value)boolean completeExceptionally(Throwable ex)с очевидной семантикой.
Прочие методы:
boolean cancel(boolean mayInterruptIfRunning)эквивалентен completeExceptionally(new CancellationException). Введен для совместимости с java.util.concurrent.Future.
static <U> CompletableFuture<U> completedFuture(U value)эквивалентен CompletableFuture res=new CompletableFuture(); res.complete(value).
void obtrudeValue(T value)void obtrudeException(Throwable ex)Насильно перезаписывают хранящееся значение. Верный способ выстрелить себе в ногу.
2. Интерфейс непосредственного чтения, получения значения
boolean isDone()Проверяет, был ли уже записан результат в данный фьючерс.
T get()Ждет, если результат еще не записан, и возвращает значение. Если было записано исключение, бросает ExecutionException.
Прочие методы:
boolean isCancelled()проверяет, было ли записано исключение с помощью метода cancel().
T join()То же, что get(), но бросает CompletionException.
T get(long timeout, TimeUnit unit)get() с тайм-аутом.
T getNow(T valueIfAbsent)возвращает результат немедленно. Если результат еще не записан, возвращает значение параметра valueIfAbsent.
int getNumberOfDependents()примерное число других CompletableFuture, ждущих заполнения данного.
3. Интерфейс опосредованной записи
static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier)Запускается задача с функцией supplier, и результат выполнения записывается во фьючерс. Запуск задачи производится на стандартном пуле потоков.
static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier, Executor executor)То же самое, но запуск на пуле потоков, указанном параметром executor.
static CompletableFuture<Void> runAsync(Runnable runnable)static CompletableFuture<Void> runAsync(Runnable runnable, Executor executor)То же самое, что и supplyAsync, но акция типа Runnable и, соответственно, результат будет типа Void.
4. Интерфейс опосредованного чтения
Предписывает выполнить заданное действие (реакцию) немедленно по заполнению этого (и/или другого) фьючерса. Самый обширный суб-интерфейс. Классифицируем его составляющие по двум признакам:
а) способ запуска реакции на заполнение: возможно запустить ее синхронно как метод при заполнении фьючерса, или асинхронно как задачу на пуле потоков. В случае асинхронного запуска используются методы с суффиксом Async (в двух вариантах — запуск на общем потокеForkJoinPool.commonPool(), либо на потоке, указанном дополнительным параметром). Далее будут описываться только методы для синхронного запуска.
б) топология зависимости между данным фьючерсом и реакцией на его заполнение: линейная, типа “any“ и типа ”all”.
— линейная зависимость: один фьючерс поставляет одно значение в реакцию
— способ “any” — на входе два или более фьючерса; первый (по времени) результат, появившийся в одном из фьючерсов, передается в реакцию; остальные результаты игнорируются
— способ “all” — на входе два или более фьючерса; результаты всех фьючерсов накапливаются и затем передаются в реакцию.
4.1 Выполнить реакцию по заполнению данного фьючерса (линейная зависимость)
Эти методы имеют имена, начинающиеся с префикса then, имеют один параметр — реакцию, и возвращают новый фьючерс типа CompletableFutureдля доступа к результату исполнения реакции. Различаются по типу реакции.
<U> CompletableFuture<U> thenApply(Function<? super T,? extends U> fn)Основной метод, в котором реакция получает значение из данного фьючерса и возвращаемое значения передается в результирующий фьючерс.
CompletableFuture<Void> thenAccept(Consumer<? super T> block)Реакция получает значение из данного фьючерса, но не возвращает значения, так что
значение результирующего фьючерса имеет тип Void.
CompletableFuture<Void> thenRun(Runnable action)Реакция не получает и не возвращает значение.
4.2 Выполнить реакцию по заполнению любого из многих фьючерсов
static CompletableFuture<Object> anyOf(CompletableFuture<?>... cfs)Возвращает новый фьючерс, который заполняется когда заполняется любой из фьючерсов, переданных параметром cfs. Результат совпадает с результатом завершившегося фьючерса.
4.3 Выполнить реакцию по заполнению любого из двух фьючерсов
Основной метод:
<U> CompletableFuture<U> applyToEither(CompletableFuture<? extends T> other, Function<? super T,U> fn)Возвращает новый фьючерс, который заполняется когда заполняется данный фьючерс либо фьючерс, переданный параметром other. Результат совпадает с результатом завершившегося фьючерса.
4.4 Выполнить реакцию по заполнению двух фьючерсов
<U,V> CompletableFuture<V> thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)Основной метод. Имеет на входе два фьючерса, результаты которых накапливаются и затем передаются в реакцию, являющейся функцией от двух параметров.
4.5 Выполнить реакцию по заполнению многих фьючерсов
static CompletableFuture<Void> allOf(CompletableFuture<?>... cfs)Возвращает CompletableFuture, завершающееся по завершению всех фьючерсов в списке параметров. Очевидный недостаток этого метода — в результирующий фьючерс не передаются значения, полученные во фьючерсах-параметрах, так что если они нужны, их нужно передавать каким-то другим способом.
4.6. Перехват ошибок исполнения
Если на каком-то этапе фьючерс завершается аварийно, исключение передается дальше по цепочке фьючерсов. Чтобы среагировать на ошибку и вернуться к нормальному исполнению, можно воспользоваться методами перехвата исключений.
CompletableFuture<T> exceptionally(Function<Throwable,? extends T> fn)Если данный фьючерс завершился аварийно, то результирующий фьючерс завершится с результатом, выработанным функцией fn. Если данный фьючерс завершился нормально, то результирующий фьючерс завершится нормально с тем же результатом.
<U> CompletableFuture<U> handle(BiFunction<? super T,Throwable,? extends U> fn)В этом методе реакция вызывается всегда, независимо от того, заваершился ли данный фьючерс нормально или аварийно. Если фьючерс завершился нормально с результатом r, то в реакцию будут переданы параметры (r, null), если аварийно с исключением ex, то в реакцию будут переданы параметры (null, ex). Результат реакции может быть другого типа, нежели результат данного фьючерса.
Полная версия: https://habrahabr.ru/post/213319/