RxJS 备忘清单

RxJS（Reactive Extensions for JavaScript）是一个强大的库，用于处理异步事件和数据流。以下是 RxJS 的一些关键概念、操作符和方法的总结。

入门

安装 RxJS

npm install rxjs

清晰

RxJS 的强大之处在于它使用纯函数生成值的能力。这意味着您的代码更不容易出错。通常情况下，您会创建一个不纯的函数，而代码的其他部分可能会弄乱您的状态。

let count = 0;
document.addEventListener('click', () => {
  console.log(`Clicked ${++count} times`)
});

使用 RxJS 可以隔离状态。

import { fromEvent, scan } from 'rxjs';

fromEvent(document, 'click')
  .pipe(scan((count) => count + 1, 0))
  .subscribe((count) => {
    console.log(`Clicked ${count} times`)
  });

扫描操作符的工作原理与数组的 reduce 类似。它接受一个暴露给回调函数的值。回调的返回值将成为下次回调运行时公开的下一个值。

流

RxJS 拥有一整套运算符，可以帮助您控制事件如何流经您的可观察对象。这是使用纯 JavaScript 每秒最多允许一次点击的方式：

let count = 0;
let rate = 1000;
let lastClick = Date.now() - rate;
document.addEventListener('click', () => {
  if (Date.now() - lastClick >= rate) {
    console.log(`Clicked ${++count}times`);
    lastClick = Date.now();
  }
});

使用 RxJS：

import { fromEvent, throttleTime, scan
  } from 'rxjs';

fromEvent(document, 'click')
  .pipe(throttleTime(1000),
      scan((count) => count + 1, 0)
  )
  .subscribe((count) => {
    console.log(`Clicked ${count} times`)
  });

第一个示例

通常情况下，您需要注册事件监听器。

document.addEventListener('click', () => {
  console.log('Clicked!')
});

使用 RxJS，您可以创建一个可观察对象。

import { fromEvent } from 'rxjs';

fromEvent(document, 'click')
  .subscribe(() => {
    console.log('Clicked!')
  });

导入所需的 Observable 和操作符

import { Observable, of, from, interval, fromEvent } from 'rxjs';

import { map, filter, switchMap, mergeMap, catchError, debounceTime, 
  distinctUntilChanged, take, tap, concatMap, delay, retryWhen, scan, 
  combineLatest, concat, merge, forkJoin, withLatestFrom, startWith, reduce
} from 'rxjs/operators';

创建 Observable

of

const obs = of(1, 2, 3);
obs.subscribe(console.log);
// 输出: 1 2 3

创建一个立即发送指定值并完成的 Observable

from

const obs = from([1, 2, 3]);
obs.subscribe(console.log);
// 输出: 1 2 3

从 Promise、数组、可迭代对象创建 Observable

interval

const obs = interval(1000);
obs.subscribe(console.log);
// 每秒输出一次递增的数字

创建一个定时发送递增整数的 Observable

fromEvent

const button = document.querySelector('button');
const obs = fromEvent(button, 'click');
obs.subscribe(event => {
  console.log('Button clicked!', event)
});

从 DOM 事件创建 Observable

操作符

map

const obs = of(1, 2, 3).pipe(
  map(x => x * 2)
);
obs.subscribe(console.log);
// 输出: 2 4 6

对 Observable 发出的每个值应用一个函数

filter

const obs = of(1, 2, 3).pipe(
  filter(x => x % 2 === 0)
);
obs.subscribe(console.log);
// 输出: 2

过滤 Observable 发出的值

switchMap

const obs = interval(1000).pipe(
  switchMap(() => of('Hello'))
);

obs.subscribe(console.log);
// 每秒输出一次 "Hello"

将 Observable 每个值映射成 Observable 并订阅，前一个订阅将被取消

mergeMap

const obs = interval(1000).pipe(
  mergeMap(() => of('Hello'))
);

obs.subscribe(console.log);
// 每秒输出一次 "Hello"

类似 switchMap，但允许多个内部 Observable 并发执行

catchError

const obs = of(1, 2, 3).pipe(
  map(x => {
    if (x === 2) throw 'Error!';
    return x;
  }),
  catchError(err => of('发现一个错误：'+err))
);
obs.subscribe(console.log);
// 输出: 1 发现一个错误：Error!

捕获 Observable 链中的错误

debounceTime

const obs = fromEvent(document,'mousemove')
    .pipe(debounceTime(300));

obs.subscribe(event => {
  console.log('Mouse moved!', event)
});

延迟处理，直到源 Observable 停止发出数据一定时间

distinctUntilChanged

const obs = of(1, 1, 2, 2, 3, 3).pipe(
  distinctUntilChanged()
);
obs.subscribe(console.log);
// 输出: 1 2 3

忽略连续重复的值

take

const obs = interval(1000).pipe(
  take(3)
);
obs.subscribe(console.log);
// 输出: 0 1 2

只发出前 n 个值

组合操作符

combineLatest

const obs1 = interval(1000);
const obs2 = of('A', 'B', 'C');
const combined = combineLatest(
  [obs1, obs2]
);

combined.subscribe(console.log);
// 每秒输出一次两个 observables 的最新值

当两个 Observable 都发出新的值时，发出它们的组合

concat

const obs1 = of(1, 2, 3);
const obs2 = of(4, 5, 6);
const combined = concat(obs1, obs2);
combined.subscribe(console.log);
// 输出: 1 2 3 4 5 6

按顺序连接多个 Observable

merge

const obs1 = interval(1000).pipe(
    map(x => 'A' + x)
);
const obs2 = interval(500).pipe(
    map(x => 'B' + x)
);
const combined = merge(obs1, obs2);
combined.subscribe(console.log);
// 每秒输出 "A" 和 "B" 开头的递增数字

将多个 Observable 合并为一个

forkJoin

const obs1 = of(1, 2, 3);
const obs2 = of('A', 'B', 'C');
const combined = forkJoin([obs1, obs2]);
combined.subscribe(console.log);
// 输出: [3, 'C']

等待所有 Observable 完成，然后发出它们的最后一个值的数组

错误处理

retryWhen

const obs = throwError('出了些问题！')
  .pipe(
      retryWhen(errors =>
        errors.pipe(delayWhen(() => interval(1000)))
      )
  );
obs.subscribe(console.log, console.error);
// 输出: 出了些问题！ (每秒重试一次)

在 Observable 发出错误时重试

实用操作符

tap

const obs = of(1, 2, 3).pipe(
  tap(x => console.log(`Before: ${x}`)),
  map(x => x * 2),
  tap(x => console.log(`After: ${x}`))
);
obs.subscribe();
// 输出: Before: 1, After: 2, Before: 2, 
//      After: 4, Before: 3, After: 6

用于记录、测量或执行副作用操作

startWith

const obs = of(1, 2, 3).pipe(
  startWith(0)
);
obs.subscribe(console.log);
// 输出: 0 1 2 3

在 Observable 序列前添加值

scan

const obs = of(1, 2, 3).pipe(
  scan((acc, value) => acc + value, 0)
);
obs.subscribe(console.log);
// 输出: 1 3 6

对 Observable 发出的每个值应用累加器函数

reduce

const obs = of(1, 2, 3).pipe(reduce((acc, value) => acc + value, 0));
obs.subscribe(console.log);
// 输出: 6

对 Observable 发出的值进行累加

delay

const obs = of('Hello').pipe(delay(2000));
obs.subscribe(console.log);
// 输出: 'Hello' (延迟2秒)

延迟 Observable 发出数据的时间

调度器

调度器说明

调度器（Scheduler）控制着 RxJS 操作的执行时机。常见的调度器有：

  • asyncScheduler：异步执行任务
  • queueScheduler：按队列顺序执行任务
  • animationFrameScheduler：在浏览器的下一次重绘前执行任务

示例

const obs = of(1, 2, 3).pipe(observeOn(asyncScheduler));

console.log('Before subscribe');
obs.subscribe(console.log);
console.log('After subscribe');
// 输出: Before subscribe, After subscribe, 1, 2, 3

另见