Rxjs TakeUntil 操作符的學習筆記

TakeUntil 的官方文件對這個操作符的解釋是：

Emit values until provided observable emits.

即它可以被賦予另一個起錨定作用的 Observable，當該錨定 Observable emit 值時，原始的 Observable 就停止發射值，進入 complete 操作。

看一個實際的例子：

import { interval, timer } from 'rxjs';
import { takeUntil } from 'rxjs/operators';

//emit value every 1s
const source = interval(1000);
//after 5 seconds, emit value
const timer$ = timer(5000);
//when timer emits after 5s, complete source
const example = source.pipe(takeUntil(timer$));
//output: 0,1,2,3
const subscribe = example.subscribe(val => console.log(val));

source Observable 每個1秒的時間間隔，發射一個從 0 開始遞增間隔為 1 的整數序列。

我們構造了一個 timer Observable，超時時間間隔為 5 秒，也就是說，在第五秒時，該 Observable 會傳送一個值。這個 timer Observable 傳入 takeUntil，作為一個 notification Observable，五秒鐘之後，source Observable 就會停止發射整數。

最後上述程式執行的輸出：4 秒之內列印 0～4，然後結束。

另一個例子：

const interval = interval(1000);
const clicks = fromEvent(document, 'click');
const result = interval.pipe(takeUntil(clicks));
result.subscribe(x => console.log(x));

這個例子裡，interval 作為原始的 Observable，clicks 作為 notification Observable，整個程式的表現形式是，每個 1 秒有一個遞增1的整數序列列印，直至頁面發生點選事件時，原始 interval Observable 終止。

看另一個例子：

// RxJS v6+
import { interval } from 'rxjs/observable/interval';
import { takeUntil, filter, scan, map, withLatestFrom } from 'rxjs/operators';

//emit value every 1s
const source = interval(1000);
//is number even?
const isEven = val => val % 2 === 0;
//only allow values that are even
const evenSource = source.pipe(filter(isEven));
//keep a running total of the number of even numbers out
const evenNumberCount = evenSource.pipe(scan((acc, _) => acc + 1, 0));
//do not emit until 5 even numbers have been emitted
const fiveEvenNumbers = evenNumberCount.pipe(filter(val => val > 5));

const example = evenSource.pipe(
  //also give me the current even number count for display
  withLatestFrom(evenNumberCount),
  map(([val, count]) => `Even number (${count}) : ${val}`),
  //when five even numbers have been emitted, complete source observable
  takeUntil(fiveEvenNumbers)
);
/*
    Even number (1) : 0,
  Even number (2) : 2
    Even number (3) : 4
    Even number (4) : 6
    Even number (5) : 8
*/
const subscribe = example.subscribe(val => console.log(val));

我們逐行分析這個例子的邏輯：

const evenSource = source.pipe(filter(isEven));

產生一個每隔1秒發射一個偶數的 Observable.

const evenNumberCount = evenSource.pipe(scan((acc, _) => acc + 1, 0));

對產生的偶數的個數進行累加。

const fiveEvenNumbers = evenNumberCount.pipe(filter(val => val > 5));

當產生的偶數個數大於 5 時，發射值。這個 Observable 作為 takeUntil 的 notification Observable 使用。

const example = evenSource.pipe(
  //also give me the current even number count for display
  withLatestFrom(evenNumberCount),
  map(([val, count]) => `Even number (${count}) : ${val}`),
  //when five even numbers have been emitted, complete source observable
  takeUntil(fiveEvenNumbers)
);

使用 eventSource 和 eventNumberCount，通過 withLatestFrom 將兩個 Observable 進行連線，從而在 map Operator 裡，可以同時列印出當前發射的偶數值和偶數總量。通過 takeUntil 傳入一個只有在偶數總數個數大於 5 時才發射值的 Observable，可以做到偶數總數大於 5 之後，讓 interval 停止值的傳送。

最後的執行效果：

Rxjs TakeUntil 操作符的學習筆記

相關文章