前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >聊聊reactive streams publisher的doOn方法

聊聊reactive streams publisher的doOn方法

作者头像
code4it
发布2018-09-17 15:41:21
1.2K0
发布2018-09-17 15:41:21
举报
文章被收录于专栏:码匠的流水账码匠的流水账

本文主要研究一下reactive streams Publisher的doOn方法

doOn系列方法

这里以Flux为例 reactor-core-3.1.2.RELEASE-sources.jar!/reactor/core/publisher/Flux.java

doOnSubscribe

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggered when the {@link Flux} is subscribed.
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/doonsubscribe.png" alt="">
     * <p>
     * @param onSubscribe the callback to call on {@link Subscriber#onSubscribe}
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnSubscribe(Consumer<? super Subscription> onSubscribe) {
        Objects.requireNonNull(onSubscribe, "onSubscribe");
        return doOnSignal(this, onSubscribe, null, null, null, null, null, null);
    }

doOnRequest

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggering a {@link LongConsumer} when this {@link Flux}
     * receives any request.
     * <p>
     *     Note that non fatal error raised in the callback will not be propagated and
     *     will simply trigger {@link Operators#onOperatorError(Throwable, Context)}.
     *
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/doonrequest.png" alt="">
     *
     * @param consumer the consumer to invoke on each request
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnRequest(LongConsumer consumer) {
        Objects.requireNonNull(consumer, "consumer");
        return doOnSignal(this, null, null, null, null, null, consumer, null);
    }

doOnNext

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggered when the {@link Flux} emits an item.
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/doonnext.png" alt="">
     * <p>
     * @param onNext the callback to call on {@link Subscriber#onNext}
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnNext(Consumer<? super T> onNext) {
        Objects.requireNonNull(onNext, "onNext");
        return doOnSignal(this, null, onNext, null, null, null, null, null);
    }

doOnError

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggered when the {@link Flux} completes with an error.
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/doonerror.png" alt="">
     * <p>
     * @param onError the callback to call on {@link Subscriber#onError}
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnError(Consumer<? super Throwable> onError) {
        Objects.requireNonNull(onError, "onError");
        return doOnSignal(this, null, null, onError, null, null, null, null);
    }

doOnEach

代码语言:javascript
复制
/**
     * Add behavior (side-effects) triggered when the {@link Flux} emits an item, fails with an error
     * or completes successfully. All these events are represented as a {@link Signal}
     * that is passed to the side-effect callback. Note that this is an advanced operator,
     * typically used for monitoring of a Flux.
     *
     * @param signalConsumer the mandatory callback to call on
     *   {@link Subscriber#onNext(Object)}, {@link Subscriber#onError(Throwable)} and
     *   {@link Subscriber#onComplete()}
     * @return an observed {@link Flux}
     * @see #doOnNext(Consumer)
     * @see #doOnError(Consumer)
     * @see #doOnComplete(Runnable)
     * @see #materialize()
     * @see Signal
     */
    public final Flux<T> doOnEach(Consumer<? super Signal<T>> signalConsumer) {
        return onAssembly(new FluxDoOnEach<>(this, signalConsumer));
    }

doOnComplete

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggered when the {@link Flux} completes successfully.
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/dooncomplete.png" alt="">
     * <p>
     * @param onComplete the callback to call on {@link Subscriber#onComplete}
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnComplete(Runnable onComplete) {
        Objects.requireNonNull(onComplete, "onComplete");
        return doOnSignal(this, null, null, null, onComplete, null, null, null);
    }

doOnCancel

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggered when the {@link Flux} is cancelled.
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/dooncancel.png" alt="">
     * <p>
     * @param onCancel the callback to call on {@link Subscription#cancel}
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnCancel(Runnable onCancel) {
        Objects.requireNonNull(onCancel, "onCancel");
        return doOnSignal(this, null, null, null, null, null, null, onCancel);
    }

doOnTerminate

代码语言:javascript
复制
/**
     * Add behavior (side-effect) triggered when the {@link Flux} terminates, either by
     * completing successfully or with an error.
     * <p>
     * <img class="marble" src="https://raw.githubusercontent.com/reactor/reactor-core/v3.1.1.RELEASE/src/docs/marble/doonterminate.png" alt="">
     * <p>
     * @param onTerminate the callback to call on {@link Subscriber#onComplete} or {@link Subscriber#onError}
     *
     * @return an observed  {@link Flux}
     */
    public final Flux<T> doOnTerminate(Runnable onTerminate) {
        Objects.requireNonNull(onTerminate, "onTerminate");
        return doOnSignal(this,
                null,
                null,
                e -> onTerminate.run(),
                onTerminate,
                null,
                null,
                null);
    }

doOnSignal

代码语言:javascript
复制
    @SuppressWarnings("unchecked")
    static <T> Flux<T> doOnSignal(Flux<T> source,
            @Nullable Consumer<? super Subscription> onSubscribe,
            @Nullable Consumer<? super T> onNext,
            @Nullable Consumer<? super Throwable> onError,
            @Nullable Runnable onComplete,
            @Nullable Runnable onAfterTerminate,
            @Nullable LongConsumer onRequest,
            @Nullable Runnable onCancel) {
        if (source instanceof Fuseable) {
            return onAssembly(new FluxPeekFuseable<>(source,
                    onSubscribe,
                    onNext,
                    onError,
                    onComplete,
                    onAfterTerminate,
                    onRequest,
                    onCancel));
        }
        return onAssembly(new FluxPeek<>(source,
                onSubscribe,
                onNext,
                onError,
                onComplete,
                onAfterTerminate,
                onRequest,
                onCancel));
    }

实例

代码语言:javascript
复制
static class DemoSubsriber implements Subscriber<Integer>{

        static final Logger LOGGER = LoggerFactory.getLogger(DemoSubsriber.class);

        @Override
        public void onSubscribe(Subscription s) {
            LOGGER.info("request max");
            s.request(Integer.MAX_VALUE);
        }

        @Override
        public void onNext(Integer integer) {
            LOGGER.info("get data:{}",integer);

        }

        @Override
        public void onError(Throwable t) {

        }

        @Override
        public void onComplete() {
            LOGGER.info("onComplete");
        }
    }

    @Test
    public void testDoOnMethods(){
        Flux.range(1, 3)
//                .log()
                .doOnSubscribe(e -> LOGGER.info("doOnSubscribe:{}",e))
                .doOnEach(e -> LOGGER.info("doOnEach:{}",e))
                .doOnError(e -> LOGGER.info("doOnError:{}",e))
                .doOnNext(e -> LOGGER.info("doOnNext:{}",e))
                .doOnRequest(e -> LOGGER.info("doOnRequest:{}",e))
                .doOnTerminate(new Runnable() {
                    @Override
                    public void run() {
                        LOGGER.info("doOnTerminate");
                    }
                })
                .doOnCancel(new Runnable() {
                    @Override
                    public void run() {
                        LOGGER.info("doOnCancel");
                    }
                })
                .doOnComplete(new Runnable() {
                    @Override
                    public void run() {
                        LOGGER.info("doOnComplete");
                    }
                })
                .subscribe(new DemoSubsriber());

    }

输出

代码语言:javascript
复制
23:14:16.837 [main] DEBUG reactor.util.Loggers$LoggerFactory - Using Slf4j logging framework
23:14:16.850 [main] INFO com.example.demo.FluxTest - doOnSubscribe:reactor.core.publisher.FluxRange$RangeSubscription@20398b7c
23:14:16.852 [main] INFO com.example.demo.FluxTest$DemoSubsriber - request max
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnRequest:2147483647
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnEach:reactor.core.publisher.FluxDoOnEach$DoOnEachSubscriber@2286778
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnNext:1
23:14:16.852 [main] INFO com.example.demo.FluxTest$DemoSubsriber - get data:1
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnEach:reactor.core.publisher.FluxDoOnEach$DoOnEachSubscriber@2286778
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnNext:2
23:14:16.852 [main] INFO com.example.demo.FluxTest$DemoSubsriber - get data:2
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnEach:reactor.core.publisher.FluxDoOnEach$DoOnEachSubscriber@2286778
23:14:16.852 [main] INFO com.example.demo.FluxTest - doOnNext:3
23:14:16.852 [main] INFO com.example.demo.FluxTest$DemoSubsriber - get data:3
23:14:16.853 [main] INFO com.example.demo.FluxTest - doOnEach:onComplete()
23:14:16.853 [main] INFO com.example.demo.FluxTest - doOnTerminate
23:14:16.853 [main] INFO com.example.demo.FluxTest - doOnComplete
23:14:16.856 [main] INFO com.example.demo.FluxTest$DemoSubsriber - onComplete

小结

doOn系列方法是publisher的同步钩子方法,在subscriber触发一系列事件的时候触发。

doc

  • flux
本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2018-01-13,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 码匠的流水账 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • doOn系列方法
    • doOnSubscribe
      • doOnRequest
        • doOnNext
          • doOnError
            • doOnEach
              • doOnComplete
                • doOnCancel
                  • doOnTerminate
                    • doOnSignal
                    • 实例
                    • 小结
                    • doc
                    领券
                    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档