RxJS Subject 詳解

iafa6945 8年前發布 | 18K 次閱讀 RxJS JavaScript開發

Observer Pattern

觀察者模式定義

觀察者模式又叫發布訂閱模式(Publish/Subscribe),它定義了一種一對多的關系,讓多個觀察者對象同時監聽某一個主題對象,這個主題對象的狀態發生變化時就會通知所有的觀察者對象,使得它們能夠自動更新自己。

我們可以使用日常生活中,期刊訂閱的例子來形象地解釋一下上面的概念。期刊訂閱包含兩個主要的角色:期刊出版方和訂閱者,他們之間的關系如下:

  • 期刊出版方 - 負責期刊的出版和發行工作
  • 訂閱者 - 只需執行訂閱操作,新版的期刊發布后,就會主動收到通知,如果取消訂閱,以后就不會再收到通知

在觀察者模式中也有兩個主要角色:Subject (主題) 和 Observer (觀察者) 。它們分別對應例子中的期刊出版方和訂閱者。接下來我們來看張圖,從而加深對上面概念的理解。

觀察者模式結構

觀察者模式實戰

Subject 類定義

class Subject {

constructor() {
    this.observerCollection = [];
}

addObserver(observer) { // 添加觀察者
    this.observerCollection.push(observer);
}

deleteObserver(observer) { // 移除觀察者
    let index = this.observerCollection.indexOf(observer);
    if(index >= 0) this.observerCollection.splice(index, 1);
}

notifyObservers() { // 通知觀察者
    this.observerCollection.forEach((observer)=>observer.notify());
}

}</code></pre>

Observer 類定義

class Observer {
    constructor(name) {
        this.name = name;
    }

notify() {
    console.log(`${this.name} has been notified.`);
}

}</code></pre>

使用示例

let subject = new Subject(); // 創建主題對象

let observer1 = new Observer('semlinker'); // 創建觀察者A - 'semlinker' let observer2 = new Observer('lolo'); // 創建觀察者B - 'lolo'

subject.addObserver(observer1); // 注冊觀察者A subject.addObserver(observer2); // 注冊觀察者B

subject.notifyObservers(); // 通知觀察者

subject.deleteObserver(observer1); // 移除觀察者A

subject.notifyObservers(); // 驗證是否成功移除</code></pre>

以上代碼成功運行后控制臺的輸出結果:

semlinker has been notified.
lolo has been notified.
lolo has been notified.

Observable subscribe

在介紹RxJS - Subject 之前,我們先來看個示例:

const interval$ = Rx.Observable.interval(1000).take(3);

interval$.subscribe({ next: value => console.log('Observer A get value: ' + value); });

setTimeout(() => { interval$.subscribe({ next: value => console.log('Observer B get value: ' + value); }); }, 1000);</code></pre>

以上代碼運行后,控制臺的輸出結果:

Observer A get value: 0
Observer A get value: 1
Observer B get value: 0
Observer A get value: 2
Observer B get value: 1
Observer B get value: 2

通過以上示例,我們可以得出以下結論:

  • Observable 對象可以被重復訂閱
  • Observable 對象每次被訂閱后,都會重新執行

上面的示例,我們可以簡單地認為兩次調用普通的函數,具體參考以下代碼:

function interval() {
  setInterval(() => console.log('..'), 1000);
}

interval();

setTimeout(() => { interval(); }, 1000);</code></pre>

Observable 對象的默認行為,適用于大部分場景。但有些時候,我們會希望在第二次訂閱的時候,不會從頭開始接收 Observable 發出的值,而是從第一次訂閱當前正在處理的值開始發送,我們把這種處理方式成為組播 (multicast),那我們要怎么實現呢 ?回想一下我們剛才介紹過觀察者模式,你腦海中是不是已經想到方案了。沒錯,我們可以通過自定義 Subject 來實現上述功能。

自定義 Subject

Subject 類定義

class Subject {
constructor() { this.observers = []; }

addObserver(observer) { 
    this.observers.push(observer);
}

next(value) {  
    this.observers.forEach(o => o.next(value));    
}

error(error){ 
    this.observers.forEach(o => o.error(error));
}

complete() {
    this.observers.forEach(o => o.complete());
}

}</code></pre>

使用示例

const interval$ = Rx.Observable.interval(1000).take(3);
let subject = new Subject();

let observerA = { next: value => console.log('Observer A get value: ' + value), error: error => console.log('Observer A error: ' + error), complete: () => console.log('Observer A complete!') };

var observerB = { next: value => console.log('Observer B get value: ' + value), error: error => console.log('Observer B error: ' + error), complete: () => console.log('Observer B complete!') };

subject.addObserver(observerA); // 添加觀察者A interval$.subscribe(subject); // 訂閱interval$對象 setTimeout(() => { subject.addObserver(observerB); // 添加觀察者B }, 1000);</code></pre>

以上代碼運行后,控制臺的輸出結果:

Observer A get value: 0
Observer A get value: 1
Observer B get value: 1
Observer A get value: 2
Observer B get value: 2
Observer A complete!
Observer B complete!

通過自定義 Subject,我們實現了前面提到的功能。接下來我們進入正題 - RxJS Subject。

RxJS Subject

首先我們通過 RxJS Subject 來重寫一下上面的示例:

const interval$ = Rx.Observable.interval(1000).take(3);
let subject = new Rx.Subject();

let observerA = { next: value => console.log('Observer A get value: ' + value), error: error => console.log('Observer A error: ' + error), complete: () => console.log('Observer A complete!') };

var observerB = { next: value => console.log('Observer B get value: ' + value), error: error => console.log('Observer B error: ' + error), complete: () => console.log('Observer B complete!') };

subject.subscribe(observerA); // 添加觀察者A interval$.subscribe(subject); // 訂閱interval$對象 setTimeout(() => { subject.subscribe(observerB); // 添加觀察者B }, 1000);</code></pre>

RxJS Subject 源碼片段

/**

  • Suject繼承于Observable */ export class Subject extends Observable { constructor() {

     super();
     this.observers = []; // 觀察者列表
     this.closed = false;
     this.isStopped = false;
     this.hasError = false;
     this.thrownError = null;
    

    }

    next(value) {

     if (this.closed) {
         throw new ObjectUnsubscribedError();
     }
     if (!this.isStopped) {
         const { observers } = this;
         const len = observers.length;
         const copy = observers.slice();
         for (let i = 0; i < len; i++) { // 循環調用觀察者next方法,通知觀察者
             copy[i].next(value);
         }
     }
    

    }

    error(err) {

     if (this.closed) {
         throw new ObjectUnsubscribedError();
     }
     this.hasError = true;
     this.thrownError = err;
     this.isStopped = true;
     const { observers } = this;
     const len = observers.length;
     const copy = observers.slice();
     for (let i = 0; i < len; i++) { // 循環調用觀察者error方法
         copy[i].error(err);
     }
     this.observers.length = 0;
    

    }

    complete() {

     if (this.closed) {
         throw new ObjectUnsubscribedError();
     }
     this.isStopped = true;
     const { observers } = this;
     const len = observers.length;
     const copy = observers.slice();
     for (let i = 0; i < len; i++) { // 循環調用觀察者complete方法
         copy[i].complete();
     }
     this.observers.length = 0; // 清空內部觀察者列表
    

    } }</code></pre>

    通過 RxJS Subject 示例和源碼片段,對于 Subject 我們可以得出以下結論:

    • Subject 既是 Observable 對象,又是 Observer 對象
    • 當有新消息時,Subject 會對內部的 observers 列表進行組播 (multicast)

    Angular 2 RxJS Subject 應用

    在 Angular 2 中,我們可以利用 RxJS Subject 來實現組件通信,具體示例如下:

    message.service.ts

    import { Injectable } from '@angular/core';
    import { Observable } from 'rxjs';
    import { Subject } from 'rxjs/Subject';

@Injectable() export class MessageService { private subject = new Subject<any>();

sendMessage(message: string) {
    this.subject.next({ text: message });
}

clearMessage() {
    this.subject.next();
}

getMessage(): Observable<any> {
    return this.subject.asObservable();
}

}</code></pre>

home.component.ts

import { Component } from '@angular/core';

import { MessageService } from '../_services/index';

@Component({ moduleId: module.id, templateUrl: 'home.component.html' })

export class HomeComponent { constructor(private messageService: MessageService) {}

sendMessage(): void { // 發送消息
    this.messageService.sendMessage('Message from Home Component to App Component!');
}

clearMessage(): void { // 清除消息
    this.messageService.clearMessage();
}

}</code></pre>

app.component.ts

import { Component, OnDestroy } from '@angular/core';
import { Subscription } from 'rxjs/Subscription';

import { MessageService } from './_services/index';

@Component({ moduleId: module.id, selector: 'app', templateUrl: 'app.component.html' })

export class AppComponent implements OnDestroy { message: any; subscription: Subscription;

constructor(private messageService: MessageService) {
    this.subscription = this.messageService.getMessage()
          .subscribe(message => { this.message = message; });
}

ngOnDestroy() {
    this.subscription.unsubscribe();
}

}</code></pre>

以上示例實現的功能是組件之間消息通信,即 HomeComponent 子組件,向 AppComponent 父組件發送消息。代碼運行后,瀏覽器的顯示結果如下:

Plunker 示例

Subject 存在的問題

因為 Subject 在訂閱時,是把 observer 存放到觀察者列表中,并在接收到新值的時候,遍歷觀察者列表并調用觀察者上的 next 方法,具體如下:

next(value) {
        if (this.closed) {
            throw new ObjectUnsubscribedError();
        }
        if (!this.isStopped) {
            const { observers } = this;
            const len = observers.length;
            const copy = observers.slice();
            for (let i = 0; i < len; i++) { // 循環調用觀察者next方法,通知觀察者
                copy[i].next(value);
            }
        }
}

這樣會有一個大問題,如果某個 observer 在執行時出現異常,卻沒進行異常處理,就會影響到其它的訂閱者,具體示例如下:

const source = Rx.Observable.interval(1000);
const subject = new Rx.Subject();

const example = subject.map(x => { if (x === 1) { throw new Error('oops'); } return x; }); subject.subscribe(x => console.log('A', x)); example.subscribe(x => console.log('B', x)); subject.subscribe(x => console.log('C', x));

source.subscribe(subject);</code></pre>

以上代碼運行后,控制臺的輸出結果:

A 0
B 0
C 0
A 1
Rx.min.js:74 Uncaught Error: oops

JSBin - Subject Problem Demo

在代碼運行前,大家會認為觀察者B 會在接收到 1 值時拋出異常,觀察者 A 和 C 仍會正常運行。但實際上,在當前的 RxJS 版本中若觀察者 B 報錯,觀察者 A 和 C 也會停止運行。那么應該如何解決這個問題呢?目前最簡單的方式就是為所有的觀察者添加異常處理,更新后的代碼如下:

const source = Rx.Observable.interval(1000);
const subject = new Rx.Subject();

const example = subject.map(x => { if (x === 1) { throw new Error('oops'); } return x; });

subject.subscribe( x => console.log('A', x), error => console.log('A Error:' + error) );

example.subscribe( x => console.log('B', x), error => console.log('B Error:' + error) );

subject.subscribe( x => console.log('C', x), error => console.log('C Error:' + error) );

source.subscribe(subject);</code></pre>

JSBin - RxJS Subject Problem Solved Demo

RxJS Subject & Observable

Subject 其實是觀察者模式的實現,所以當觀察者訂閱 Subject 對象時,Subject 對象會把訂閱者添加到觀察者列表中,每當有 subject 對象接收到新值時,它就會遍歷觀察者列表,依次調用觀察者內部的 next() 方法,把值一一送出。

Subject 之所以具有 Observable 中的所有方法,是因為 Subject 類繼承了 Observable 類,在 Subject 類中有五個重要的方法:

  • next - 每當 Subject 對象接收到新值的時候,next 方法會被調用
  • error - 運行中出現異常,error 方法會被調用
  • complete - Subject 訂閱的 Observable 對象結束后,complete 方法會被調用
  • subscribe - 添加觀察者
  • unsubscribe - 取消訂閱 (設置終止標識符、清空觀察者列表)

BehaviorSubject

BehaviorSubject 定義

BehaviorSubject 源碼片段

export class BehaviorSubject extends Subject {
    constructor(_value) { // 設置初始值
        super();
        this._value = _value;
    }
    get value() { // 獲取當前值
        return this.getValue();
    }
    _subscribe(subscriber) {
        const subscription = super._subscribe(subscriber);
        if (subscription && !subscription.closed) {
            subscriber.next(this._value); // 為新的訂閱者發送當前最新的值
        }
        return subscription;
    }
    getValue() {
        if (this.hasError) {
            throw this.thrownError;
        }
        else if (this.closed) {
            throw new ObjectUnsubscribedError();
        }
        else {
            return this._value;
        }
    }
    next(value) { // 調用父類Subject的next方法,同時更新當前值
        super.next(this._value = value);
    }
}

BehaviorSubject 應用

有些時候我們會希望 Subject 能保存當前的最新狀態,而不是單純的進行事件發送,也就是說每當新增一個觀察者的時候,我們希望 Subject 能夠立即發出當前最新的值,而不是沒有任何響應。具體我們先看一下示例:

var subject = new Rx.Subject();

var observerA = { next: value => console.log('Observer A get value: ' + value), error: error => console.log('Observer A error: ' + error), complete: () => console.log('Observer A complete!') };

var observerB = { next: value => console.log('Observer B get value: ' + value), error: error => console.log('Observer B error: ' + error), complete: () => console.log('Observer B complete!') };

subject.subscribe(observerA);

subject.next(1); subject.next(2); subject.next(3);

setTimeout(() => { subject.subscribe(observerB); // 1秒后訂閱 }, 1000);</code></pre>

以上代碼運行后,控制臺的輸出結果:

Observer A get value: 1
Observer A get value: 2
Observer A get value: 3

通過輸出結果,我們發現在 observerB 訂閱 Subject 對象后,它再也沒有收到任何值了。因為 Subject 對象沒有再調用 next() 方法。但很多時候我們會希望 Subject 對象能夠保存當前的狀態,當新增訂閱者的時候,自動把當前最新的值發送給訂閱者。要實現這個功能,我們就需要使用 BehaviorSubject。

BehaviorSubject 跟 Subject 最大的不同就是 BehaviorSubject 是用來保存當前最新的值,而不是單純的發送事件。BehaviorSubject 會記住最近一次發送的值,并把該值作為當前值保存在內部的屬性中。接下來我們來使用 BehaviorSubject 重新一下上面的示例:

var subject = new Rx.BehaviorSubject(0); // 設定初始值

var observerA = { next: value => console.log('Observer A get value: ' + value), error: error => console.log('Observer A error: ' + error), complete: () => console.log('Observer A complete!') };

var observerB = { next: value => console.log('Observer B get value: ' + value), error: error => console.log('Observer B error: ' + error), complete: () => console.log('Observer B complete!') };

subject.subscribe(observerA);

subject.next(1); subject.next(2); subject.next(3);

setTimeout(() => { subject.subscribe(observerB); // 1秒后訂閱 }, 1000);</code></pre>

以上代碼運行后,控制臺的輸出結果:

Observer A get value: 0
Observer A get value: 1
Observer A get value: 2
Observer A get value: 3
Observer B get value: 3

JSBin - BehaviorSubject

ReplaySubject

ReplaySubject 定義

ReplaySubject 源碼片段

export class ReplaySubject extends Subject {
    constructor(bufferSize = Number.POSITIVE_INFINITY, 
                windowTime = Number.POSITIVE_INFINITY, 
                scheduler) {
        super();
        this.scheduler = scheduler;
        this._events = []; // ReplayEvent對象列表
        this._bufferSize = bufferSize < 1 ? 1 : bufferSize; // 設置緩沖區大小
        this._windowTime = windowTime < 1 ? 1 : windowTime;
    }

next(value) {
    const now = this._getNow();
    this._events.push(new ReplayEvent(now, value));
    this._trimBufferThenGetEvents();
    super.next(value);
}

_subscribe(subscriber) { const _events = this._trimBufferThenGetEvents(); // 過濾ReplayEvent對象列表 let subscription; if (this.closed) { throw new ObjectUnsubscribedError(); } ... else { this.observers.push(subscriber); subscription = new SubjectSubscription(this, subscriber); } ... const len = _events.length; // 重新發送設定的最后bufferSize個值 for (let i = 0; i < len && !subscriber.closed; i++) { subscriber.next(_events[i].value); } ... return subscription; } }

class ReplayEvent { constructor(time, value) { this.time = time; this.value = value; } }</code></pre>

ReplaySubject 應用

有些時候我們希望在 Subject 新增訂閱者后,能向新增的訂閱者重新發送最后幾個值,這時我們就可以使用 ReplaySubject ,具體示例如下:

var subject = new Rx.ReplaySubject(2); // 重新發送最后2個值

var observerA = { next: value => console.log('Observer A get value: ' + value), error: error => console.log('Observer A error: ' + error), complete: () => console.log('Observer A complete!') };

var observerB = { next: value => console.log('Observer B get value: ' + value), error: error => console.log('Observer B error: ' + error), complete: () => console.log('Observer B complete!') };

subject.subscribe(observerA);

subject.next(1); subject.next(2); subject.next(3);

setTimeout(() => { subject.subscribe(observerB); // 1秒后訂閱 }, 1000);</code></pre>

以上代碼運行后,控制臺的輸出結果:

Observer A get value: 1
Observer A get value: 2
Observer A get value: 3
Observer B get value: 2
Observer B get value: 3

可能會有人認為 ReplaySubject(1) 是不是等同于 BehaviorSubject,其實它們是不一樣的。在創建BehaviorSubject 對象時,是設置初始值,它用于表示 Subject 對象當前的狀態,而 ReplaySubject 只是事件的重放。

JSBin - ReplaySubject

AsyncSubject

AsyncSubject 定義

AsyncSubject 源碼片段

export class AsyncSubject extends Subject {
    constructor() {
        super(...arguments);
        this.value = null;
        this.hasNext = false;
        this.hasCompleted = false; // 標識是否已完成
    }
    _subscribe(subscriber) {
        if (this.hasError) {
            subscriber.error(this.thrownError);
            return Subscription.EMPTY;
        }
        else if (this.hasCompleted && this.hasNext) { // 等到完成后,才發出最后的值
            subscriber.next(this.value);
            subscriber.complete();
            return Subscription.EMPTY;
        }
        return super._subscribe(subscriber);
    }
    next(value) {
        if (!this.hasCompleted) { // 若未完成,保存當前的值
            this.value = value;
            this.hasNext = true;
        }
    }
}

AsyncSubject 應用

AsyncSubject 類似于 last 操作符,它會在 Subject 結束后發出最后一個值,具體示例如下:

var subject = new Rx.AsyncSubject();

var observerA = { next: value => console.log('Observer A get value: ' + value), error: error => console.log('Observer A error: ' + error), complete: () => console.log('Observer A complete!') };

var observerB = { next: value => console.log('Observer B get value: ' + value), error: error => console.log('Observer B error: ' + error), complete: () => console.log('Observer B complete!') };

subject.subscribe(observerA);

subject.next(1); subject.next(2); subject.next(3);

subject.complete();

setTimeout(() => { subject.subscribe(observerB); // 1秒后訂閱 }, 1000);</code></pre>

以上代碼運行后,控制臺的輸出結果:

Observer A get value: 3
Observer A complete!
Observer B get value: 3
Observer B complete!

JSBin - AsyncSubject

參考資源

 

來自:https://juejin.im/post/58dca39861ff4b006b03b80c

 

 本文由用戶 iafa6945 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!