rxjs 源碼分析1-(fromEvent)

時間  2019-11-21
標籤 rxjs 源碼 分析 fromevent 简体版
原文   原文鏈接

前言

Rxjs是使用 Observables 的響應式編程的庫，它使編寫異步或基於回調的代碼更容易。咱們如今針對Rxjs 6 來進行源碼分析，分析其實現的基本原理， 咱們能夠根據中文文檔來學習Rxjs 的基本使用，可是這個文檔是Rxjs 5 的版本。其最基本的使用區別以下,Rxjs 6的操做符都放在pipe (管道)中配置，而Rxjs 5 的版本是直接調用javascript

Rxjs 5

fromEvent(addBtn, 'click')
    .throttleTime(3000)
    .subscribe(() => {
        nameInput.value = +(nameInput.value) + 1
    })
複製代碼

Rxjs 6

fromEvent(addBtn, 'click')
    .pipe(throttleTime(3000))
    .subscribe(() => {
        nameInput.value = +(nameInput.value) + 1
    })
複製代碼

fromEvent

使用方法

咱們先從咱們最經常使用的事件處理開始，Rxjs 對事件的處理有一個fromEvent 方法， 其最簡單的一個範例以下：java

import {fromEvent } from './esm2015';

const addBtn = document.getElementById('add')
const minusBtn = document.getElementById('minus')
const nameInput = document.getElementById('name');
fromEvent(addBtn, 'click')  
    .subscribe(() => {
        nameInput.value = +(nameInput.value) + 1
    })

fromEvent(minusBtn, 'click')
    .subscribe(() => {
        nameInput.value = +(nameInput.value) - 1
    })
複製代碼

其實現的效果以下圖：git

咱們點擊加號或者減號 button 去給Input賦值。

原理

從上面咱們已經能夠知道怎麼去簡單使用fromEvent, 下面咱們根據源代碼來一步步深刻分析，其基本原理：github

export function fromEvent(target, eventName, options, resultSelector) {
    if (isFunction(options)) {
        resultSelector = options;
        options = undefined;
    }
    if (resultSelector) {
        return fromEvent(target, eventName, options).pipe(map(args => isArray(args) ? resultSelector(...args) : resultSelector(args)));
    }
    return new Observable(subscriber => {
        function handler(e) {
            if (arguments.length > 1) {
                subscriber.next(Array.prototype.slice.call(arguments));
            }
            else {
                subscriber.next(e);
            }
        }
        setupSubscription(target, eventName, handler, subscriber, options);
    });
}
複製代碼

fromEvent 其實就是一個方法， 能夠傳入四個參數，咱們上面的Demo 只是傳遞了兩個參數，咱們先只分析只傳遞兩個參數的狀況： fromEvent 最終會返回一個Observable對象， 咱們能夠將上面的Demo 代碼，進行簡單的處理，以下：編程

import { fromEvent } from './esm2015';

const addBtn = document.getElementById('add')
const minusBtn = document.getElementById('minus')
const nameInput = document.getElementById('name')
const addFromEventObj = fromEvent(addBtn, 'click')
addFromEventObj.subscribe(() => {
    nameInput.value = +(nameInput.value) + 1
})

const minusFromEventObj = fromEvent(minusBtn, 'click')
minusFromEventObj.subscribe(() => {
    nameInput.value = +(nameInput.value) - 1
})
複製代碼

咱們將以下代碼分紅了兩個步驟，bash

fromEvent(addBtn, 'click')  
    .subscribe(() => {
        nameInput.value = +(nameInput.value) + 1
    })

複製代碼

const addFromEventObj = fromEvent(addBtn, 'click')咱們能夠查看addFromEventObj對象，以下截圖：異步

很簡單，就是 Observable 對象，其中有一個重要的屬性 _subscribe的屬性， 執行的就是 fromEvent 中 return對象的傳入的參數： 

return new Observable(subscriber => {
        function handler(e) {
            if (arguments.length > 1) {
                subscriber.next(Array.prototype.slice.call(arguments));
            }
            else {
                subscriber.next(e);
            }
        }
        setupSubscription(target, eventName, handler, subscriber, options);
    });
複製代碼

其實fromEvent 方法，很簡單，就是返回一個Observable 對象， 其餘的基本就沒有什麼了。 其中點仍是返回的這個對象，咱們下面來深刻分析Observable 對象.async

Observable

Observable 的中文翻譯就是可觀察的, 表示一個可觀察的對象，既然是一個可觀察的對象，那觀察到變化後，是否是要通知相應的觀察者 呢？函數

構造函數

咱們首先分析Observable 的構造函數：源碼分析

constructor(subscribe) {
        this._isScalar = false;
        if (subscribe) {
            this._subscribe = subscribe;
        }
    }
複製代碼

其構造函數就接收一個參數subscribe ，其中文意思就是訂閱 ，其實訂閱 就是觀察者 的概念，而後咱們的可觀察的對象 和觀察者 對象就關聯起來了。

const addFromEventObj = fromEvent(addBtn, 'click') 中addFromEventObj表示建立了一個可觀察的 對象， 有了可觀察的 對象，咱們就須要對這個對象進行訂閱 了， 咱們下面就來分析subscribe方法

subscribe

subscribe的源碼以下：

subscribe(observerOrNext, error, complete) {
        const { operator } = this;
        const sink = toSubscriber(observerOrNext, error, complete);
        if (operator) {
            operator.call(sink, this.source);
        }
        else {
            sink.add(
                this.source || 
                (config.useDeprecatedSynchronousErrorHandling && !sink.syncErrorThrowable) ?
                this._subscribe(sink) :
                this._trySubscribe(sink)
            );
        }
        if (config.useDeprecatedSynchronousErrorHandling) {
            if (sink.syncErrorThrowable) {
                sink.syncErrorThrowable = false;
                if (sink.syncErrorThrown) {
                    throw sink.syncErrorValue;
                }
            }
        }
        return sink;
    }
複製代碼

咱們目前先不考慮添加operator (操做符)的狀況，咱們下面來一一分析這個方法：

  1. const sink = toSubscriber(observerOrNext, error, complete); 建立了一個Subscriber 方法，
  2. 由於operator 爲undefined, 因此條件判斷語句會進入else,
sink.add(
                this.source || 
                (config.useDeprecatedSynchronousErrorHandling && !sink.syncErrorThrowable) ?
                this._subscribe(sink) :
                this._trySubscribe(sink)
            );
複製代碼

其中add()方法裏面會先執行this._trySubscribe(sink), 而後執行： return this._subscribe(sink);, 咱們應該還記得this._subscribe,是咱們調用fromEvent方法， 返回Observable對象，傳入構造函數的參數，代碼以下：

subscriber => {
        function handler(e) {
            if (arguments.length > 1) {
                subscriber.next(Array.prototype.slice.call(arguments));
            }
            else {
                subscriber.next(e);
            }
        }
        setupSubscription(target, eventName, handler, subscriber, options);
    }
複製代碼

這裏就是給真實的Dom 元素進行事件的綁定，如今咱們點擊button ， 就會調用如上的handler方法， 主要實現是subscriber.next(e);, 其'subscriber' 也就是const sink = toSubscriber(observerOrNext, error, complete); 建立的sink對象，其對應就是esm2015\internal\Subscriber.js對象，如今咱們查看其對應的next()方法， 其指向的是：

_next(value) {
        this.destination.next(value);
    }
複製代碼

其this.destination 屬性， 是在Subscriber 構造函數賦值的, 是一個SafeSubscriber對象

default:
        this.syncErrorThrowable = true;
        this.destination = new SafeSubscriber(this, destinationOrNext, error, complete);
        break;
複製代碼

其中destinationOrNext 對應的是subscribe 方法傳入的參數，以下：

const addFromEventObj = fromEvent(addBtn, 'click')
addFromEventObj.subscribe(() => {
    nameInput.value = +(nameInput.value) + 1
})
複製代碼

就是

() => {
    nameInput.value = +(nameInput.value) + 1
}
複製代碼

下面咱們繼續來分析this.destination.next(value);, 其代碼以下：

next(value) {
        if (!this.isStopped && this._next) {
            const { _parentSubscriber } = this;
            if (!config.useDeprecatedSynchronousErrorHandling || !_parentSubscriber.syncErrorThrowable) {
                this.__tryOrUnsub(this._next, value);
            }
            else if (this.__tryOrSetError(_parentSubscriber, this._next, value)) {
                this.unsubscribe();
            }
        }
    }
複製代碼

最終實現方法是this.__tryOrUnsub(this._next, value);, 這個方法傳遞了兩個參數：

  1. this._next， 其在SafeSubscriber 構造函數中對其進行了賦值： next = observerOrNext;,也就是構造函數的第二個參數， 咱們上面已經分析了建立SafeSubscriber 對象的地方this.destination = new SafeSubscriber(this, destinationOrNext, error, complete);, 這個destinationOrNext就是subscribe方法傳入的參數，以下：
const addFromEventObj = fromEvent(addBtn, 'click')
addFromEventObj.subscribe(() => {
    nameInput.value = +(nameInput.value) + 1
})
複製代碼
  1. value, 也就是click 事件的對象MouseEvent

咱們接下來具體分析**__tryOrUnsub** 方法，代碼以下：

__tryOrUnsub(fn, value) {
        try {
            fn.call(this._context, value);
        }
        catch (err) {
            this.unsubscribe();
            if (config.useDeprecatedSynchronousErrorHandling) {
                throw err;
            }
            else {
                hostReportError(err);
            }
        }
    }
複製代碼

其主要實現就是fn.call(this._context, value);, 就會執行了subscribe 裏面的方法了， 也就是執行：

() => {
    nameInput.value = +(nameInput.value) + 1
}
複製代碼

pipe

上面咱們已經基本理解了fromEvent 的基本使用方法，主要分析的是subscribe 方法，咱們如今有個需求，咱們要控制Button , 在3s 時間內， 咱們只能點擊一次， 以防止，惡意點擊按鈕.Rxjs 都是基於流來操做，Observable 對象提供了一個pipe(管道)的方法， 在進入到subscribe 訂閱者方法以前，因此的數據須要進行加工，異常處理， 以保證subscribe收到的是正確的數據。咱們下面來深刻分析pipe 方法。 咱們將咱們的Demo 修改以下：

import { fromEvent } from './esm2015';
import { throttleTime } from './esm2015/operators'

const addBtn = document.getElementById('add')
const minusBtn = document.getElementById('minus')
const nameInput = document.getElementById('name')
const addFromEventObj = fromEvent(addBtn, 'click')
const pipeObj = addFromEventObj
    .pipe(throttleTime(1000 * 3))
pipeObj.subscribe(() => {
        nameInput.value = +(nameInput.value) + 1
    })

const minusFromEventObj = fromEvent(minusBtn, 'click')

minusFromEventObj
    .pipe(throttleTime(1000 * 3))
    .subscribe(() => {
        nameInput.value = +(nameInput.value) - 1
    })
複製代碼

上面咱們經過.pipe(throttleTime(1000 * 3))添加了管道 ,其中傳入了一個throttleTime (節流)操做符， 下面是pipe 方法的代碼：

pipe(...operations) {
        if (operations.length === 0) {
            return this;
        }
        var opts = pipeFromArray(operations);
        var result = opts(this);
         return result;
    }
複製代碼

從上面方法，咱們能夠看出pipe 方法，能夠傳入多個操做符， 咱們如今先只看下簡單的，只傳入一個操做符的狀況， 若是隻傳入一個參數var opts = pipeFromArray(operations); 中opts對應的就是咱們傳入的throttleTime函數返回的方法，也就是以下：

export function throttleTime(duration, scheduler = async, config = defaultThrottleConfig) {
    return (source) => {
        return source.lift(new ThrottleTimeOperator(duration, scheduler, config.leading, config.trailing));
    }
}
複製代碼

其中source 就是上面的this, 也就是Observable 對象，咱們下面能夠繼續看下lift 方法：

lift(operator) {
        const observable = new Observable();
        observable.source = this;
        observable.operator = operator;
        return observable;
    }
複製代碼

返回了一個新的observable 對象，只是在添加了operator 屬性。以下代碼：

const addFromEventObj = fromEvent(addBtn, 'click')
const pipeObj = addFromEventObj
    .pipe(throttleTime(1000 * 3))
複製代碼

pipeObj 以下圖所示：

因此pipe 方法就是將一個(組)操做符掛載在一個新的observable 對象的operator 屬性上。 咱們還須要從新分析subscribe 方法

subscribe(observerOrNext, error, complete) {
        const { operator } = this;
        const sink = toSubscriber(observerOrNext, error, complete);
        if (operator) {
            operator.call(sink, this.source);
        }
        else {
            sink.add(
                this.source || 
                (config.useDeprecatedSynchronousErrorHandling && !sink.syncErrorThrowable) ?
                this._subscribe(sink) :
                this._trySubscribe(sink)
            );
        }
        if (config.useDeprecatedSynchronousErrorHandling) {
            if (sink.syncErrorThrowable) {
                sink.syncErrorThrowable = false;
                if (sink.syncErrorThrown) {
                    throw sink.syncErrorValue;
                }
            }
        }
        return sink;
    }
複製代碼

咱們在調用subscribe 方法以前，咱們已經調用了pipe 方法,pipe 方法返回的對象， 已經有了operator 操做符，因此上面的邏輯分支會走if operator.call(sink, this.source);, call 代碼以下：

call(subscriber, source) {
        return source.subscribe(new ThrottleTimeSubscriber(subscriber, this.duration, this.scheduler, this.leading, this.trailing));
    }
複製代碼

從新調用了subscribe 方法， 只是傳入的第一個參數observerOrNext 是一個ThrottleTimeSubscriber對象， 咱們從新回到subscribe 方法，const sink = toSubscriber(observerOrNext, error, complete);, 查看下：

export function toSubscriber(nextOrObserver, error, complete) {
    if (nextOrObserver) {
        if (nextOrObserver instanceof Subscriber) {
            return nextOrObserver;
        }
        if (nextOrObserver[rxSubscriberSymbol]) {
            return nextOrObserver[rxSubscriberSymbol]();
        }
    }
    if (!nextOrObserver && !error && !complete) {
        return new Subscriber(emptyObserver);
    }
    return new Subscriber(nextOrObserver, error, complete);
}
複製代碼

從代碼能夠分析出，若是第一個參數nextOrObserver 是一個Subscriber類型， 就直接返回這個對象， 而咱們的ThrottleTimeSubscriber 是繼承與Subscriber對象的，因此sink 就是一個ThrottleTimeSubscriber對象。 咱們又從新回到fromEvent 方法, 其中的subscriber指向的就是一個ThrottleTimeSubscriber對象。subscriber.next(e);調用的也是ThrottleTimeSubscriber對象的next 方法。

return new Observable(subscriber => {
        function handler(e) {
            if (arguments.length > 1) {
                subscriber.next(Array.prototype.slice.call(arguments));
            }
            else {
                subscriber.next(e);
            }
        }
        setupSubscription(target, eventName, handler, subscriber, options);
    });
複製代碼

後面咱們來繼續分析， 這個operator 操做符是怎麼起做用的。

throttleTime

上面咱們已經分析，pipe 方法就是將一個(組)操做符掛載在一個新的observable 對象的operator 屬性上。如今咱們來分析操做符具體是怎麼工做的，咱們能夠先以throttleTime 操做符來進行分析。

上面咱們已經分析了，咱們在點擊Button 的時候，會調用handler方法， 其中subscriber已是一個ThrottleTimeSubscriber對象。

return new Observable(subscriber => {
        function handler(e) {
            if (arguments.length > 1) {
                subscriber.next(Array.prototype.slice.call(arguments));
            }
            else {
                subscriber.next(e);
            }
        }
        setupSubscription(target, eventName, handler, subscriber, options);
    });
複製代碼

咱們下面來分析： ThrottleTimeSubscriber.next(e) 方法， 其代碼以下：

_next(value) {
        if (this.throttled) {
            if (this.trailing) {
                this._trailingValue = value;
                this._hasTrailingValue = true;
            }
        }
        else {
            this.throttled = this.scheduler.schedule(dispatchNext, this.duration, { subscriber: this })
            this.add(this.throttled);
            if (this.leading) {
                this.destination.next(value);
            }
        }
    }
複製代碼

這個方法很重要

  1. 首先加了一個throttled 標記變量， 用來標記是否已經啓動了節流開關，一開始是爲undefinded的 代碼會進入else分支，
  2. 而後執行this.throttled = this.scheduler.schedule(dispatchNext, this.duration, { subscriber: this })給throttled賦值，下一次進來的時候，throttled 就有值了。
  3. 執行this.destination.next(value);, 這個方法，會最終調用subscribe訂閱方法中傳遞的方法，也就是
addFromEventObj = addFromEventObj.subscribe(() => {
    nameInput.value = +(nameInput.value) + 1
})
複製代碼

總結：

這個方法是實現throttleTime 節流的關鍵點， 經過判斷throttled 標記來判斷是否要執行subscribe 中的方法。

下面咱們來重點分析： this.throttled = this.scheduler.schedule(dispatchNext, this.duration, { subscriber: this }).

首先： scheduler指向的是esm2015\internal\scheduler\AsyncAction.js對象， 咱們查看下其schedule方法：

schedule(state, delay = 0) {
        if (this.closed) {
            return this;
        }
        this.state = state;
        const id = this.id;
        const scheduler = this.scheduler;
        if (id != null) {
            this.id = this.recycleAsyncId(scheduler, id, delay);
        }
        this.pending = true;
        this.delay = delay;
        this.id = this.id || this.requestAsyncId(scheduler, this.id, delay);
        return this;
    }
複製代碼

其中最重要的是： this.id = this.id || this.requestAsyncId(scheduler, this.id, delay);, 這裏調用了一個requestAsyncId方法，其代碼以下：

requestAsyncId(scheduler, id, delay = 0) {
        return setInterval(scheduler.flush.bind(scheduler, this), delay);
    }
複製代碼

哈哈，這裏設置了一個定時器setInterval, 這就是throttleTime生效的一個關鍵點。

總結：

setInterval 實現的功能是定時去清除 throttled 變量值，從而達到，咱們在調用throttleTime(1000*3)這個操做符後，點擊一次按鈕後，3S內不能再次點擊，可是3S後，又能夠點擊的原理

這個定時器的第一個參數是scheduler.flush.bind(scheduler, this), 其對應的是：esm2015/internal/scheduler/AsyncScheduler.js裏的flush 方法，其代碼以下：

flush(action) {
        const { actions } = this;
        if (this.active) {
            actions.push(action);
            return;
        }
        let error;
        this.active = true;
        do {
            if (error = action.execute(action.state, action.delay)) {
                break;
            }
        } while (action = actions.shift());
        this.active = false;
        if (error) {
            while (action = actions.shift()) {
                action.unsubscribe();
            }
            throw error;
        }
    }
複製代碼

會去遍歷全部的actions, 而後去執行execute 方法， 傳入的action 就是對應的AsyncAction 對象，execute 方法以下：

execute(state, delay) {
        if (this.closed) {
            return new Error('executing a cancelled action');
        }
        this.pending = false;
        const error = this._execute(state, delay);
        if (error) {
            return error;
        }
        else if (this.pending === false && this.id != null) {
            this.id = this.recycleAsyncId(this.scheduler, this.id, null);
        }
    }
複製代碼

而後會調用const error = this._execute(state, delay);, _execute 代碼以下：

_execute(state, delay) {
        let errored = false;
        let errorValue = undefined;
        try {
            this.work(state);
        }
        catch (e) {
            errored = true;
            errorValue = !!e && e || new Error(e);
        }
        if (errored) {
            this.unsubscribe();
            return errorValue;
        }
    }
複製代碼

其中最重要的是調用了this.work(state)方法， work是this.throttled = this.scheduler.schedule(dispatchNext, this.duration, { subscriber: this })傳遞的第一個參數

function dispatchNext(arg) {
    const { subscriber } = arg;
    subscriber.clearThrottle();
}
複製代碼

最終會調用clearThrottle 方法，其代碼以下：

clearThrottle() {
        const throttled = this.throttled;
        if (throttled) {
            if (this.trailing && this._hasTrailingValue) {
                this.destination.next(this._trailingValue);
                this._trailingValue = null;
                this._hasTrailingValue = false;
            }
            throttled.unsubscribe();
            this.remove(throttled);
            this.throttled = null;
        }
    }
複製代碼

其中很關鍵的一個步驟是將throttled 這個標記，設置爲null this.throttled = null;, 爲何說很重要呢， 還記得咱們上面有分析ThrottleTimeSubscriber, 這個class 下面的_next方法，其代碼以下：

_next(value) {
        if (this.throttled) {
            if (this.trailing) {
                this._trailingValue = value;
                this._hasTrailingValue = true;
            }
        }
        else {
            this.throttled = this.scheduler.schedule(dispatchNext, this.duration, { subscriber: this })
            this.add(this.throttled);
            if (this.leading) {
                this.destination.next(value);
            }
        }
    }
複製代碼

這個方法有判斷throttled這個標記， 若是不爲空，其實至關與什麼也不作，只有爲空的狀況下，纔會去執行this.throttled = this.scheduler.schedule(dispatchNext, this.duration, { subscriber: this }), 也就是這個方法，會去執行咱們subscribe 訂閱裏面的方法， 從而達到了，節流的效果。

let addFromEventObj = fromEvent(addBtn, 'click')
addFromEventObj = addFromEventObj.pipe(throttleTime(1000 * 10))
addFromEventObj = addFromEventObj.subscribe(() => {
    nameInput.value = +(nameInput.value) + 1
})
複製代碼

總結

上面咱們已經簡單的分析了Rxjs 的基本使用方式，下面是咱們這篇文章涉及的幾個基本概念

(Observable)可觀察的對象, (subscriber)觀察者, (pipe)管道, (throttleTime)操做符 下面咱們根據這幾個概念來總結下Rxjs基於流來處理數據的整個過程(被觀察對象-> 數據處理-> 觀察者)

  1. 首先須要建立一個可觀察對象， 在esm2015\internal\observable\文件夾下都是用來建立可觀察對象的方法， 如上面咱們Demo 用到的fromEvent就是其中一個，而後返回一個Observable對象， Observable 還有一個靜態方法create能夠直接建立一個個Observable對象
  2. pipe 就是將操做符掛載在Observable 對象的operator 屬性上， 若是pipe 傳遞了多個操做符， 則在source屬性(也是一個Observable)對象的operator， 層層遞歸，從右到左
addFromEventObj = addFromEventObj.pipe(throttleTime(1000 * 2),mapTo(1), scan((init, next) => init + next, 0))
複製代碼

其對應的對象以下圖：

  1. 而後調用subscribe方法， 裏面的第一個參數就是觀察者,以下的subscriber 方法。
let addFromEventObj = fromEvent(addBtn, 'click')
addFromEventObj = addFromEventObj.pipe(throttleTime(1000 * 2),mapTo(1), scan((init, next) => init + next, 0))
const subscriber = value => {
    nameInput.value = value
}
addFromEventObj = addFromEventObj.subscribe(subscriber)
複製代碼
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程