轉載請標明出處:
juejin.im/post/58ce8c…
本文出自:【張旭童的稀土掘金】(gold.xitu.io/user/56de21…)
概述
承接上一篇RxJava2 原始碼解析(一),
本系列我們的目的:
- 知道源頭(
Observable
)是如何將資料傳送出去的。 - 知道終點(
Observer
)是如何接收到資料的。 - 何時將源頭和終點關聯起來的
- 知道執行緒排程是怎麼實現的
- 知道操作符是怎麼實現的
本篇計劃講解一下4,5.
RxJava最強大的莫過於它的執行緒排程 和 花式操作符。
map操作符
map是一個高頻的操作符,我們首先拿他開刀。
例子如下,源頭Observable
傳送的是String型別的數字,利用map轉換成int型,最終在終點Observer
接受到的也是int型別資料。:
final Observable<String> testCreateObservable = Observable.create(new ObservableOnSubscribe<String>() {
@Override
public void subscribe(ObservableEmitter<String> e) throws Exception {
e.onNext("1");
e.onComplete()
}
});複製程式碼
Observable<Integer> map = testCreateObservable.map(new Function<String, Integer>() {
@Override
public Integer apply(String s) throws Exception {
return Integer.parseInt(s);
}
});
map.subscribe(new Observer<Integer>() {
@Override
public void onSubscribe(Disposable d) {
Log.d(TAG, "onSubscribe() called with: d = [" + d + "]");
}
@Override
public void onNext(Integer value) {
Log.d(TAG, "onNext() called with: value = [" + value + "]");
}
@Override
public void onError(Throwable e) {
Log.d(TAG, "onError() called with: e = [" + e + "]");
}
@Override
public void onComplete() {
Log.d(TAG, "onComplete() called");
}
});複製程式碼
我們看一下map
函式的原始碼:
public final <R> Observable<R> map(Function<? super T, ? extends R> mapper) {
//判空略過
ObjectHelper.requireNonNull(mapper, "mapper is null");
//RxJavaPlugins.onAssembly()是hook 上文提到過
return RxJavaPlugins.onAssembly(new ObservableMap<T, R>(this, mapper));
}複製程式碼
RxJavaPlugins.onAssembly()
是hook 上文提到過,所以我們只要看ObservableMap
,它就是返回到我們手裡的Observable
:
public final class ObservableMap<T, U> extends AbstractObservableWithUpstream<T, U> {
//將function變換函式類儲存起來
final Function<? super T, ? extends U> function;
public ObservableMap(ObservableSource<T> source, Function<? super T, ? extends U> function) {
//super()將上游的Observable儲存起來 ,用於subscribeActual()中用。
super(source);
this.function = function;
}
@Override
public void subscribeActual(Observer<? super U> t) {
source.subscribe(new MapObserver<T, U>(t, function));
}複製程式碼
它繼承自AbstractObservableWithUpstream
,該類繼承自Observable
,很簡單,就是將上游的ObservableSource
儲存起來,做一次wrapper,所以它也算是裝飾者模式的提現,如下:
abstract class AbstractObservableWithUpstream<T, U> extends Observable<U> implements HasUpstreamObservableSource<T> {
//將上游的`ObservableSource`儲存起來
protected final ObservableSource<T> source;
AbstractObservableWithUpstream(ObservableSource<T> source) {
this.source = source;
}
@Override
public final ObservableSource<T> source() {
return source;
}
}複製程式碼
關於ObservableSource
,代表了一個標準的無背壓的 源資料介面,可以被Observer
消費(訂閱),如下:
public interface ObservableSource<T> {
void subscribe(Observer<? super T> observer);
}複製程式碼
所有的Observable
都已經實現了它,所以我們可以認為Observable
和ObservableSource
在本文中是相等的:
public abstract class Observable<T> implements ObservableSource<T> {複製程式碼
所以我們得到的ObservableMap
物件也很簡單,就是將上游的Observable
和變換函式類Function
儲存起來。Function
的定義超級簡單,就是一個介面,給我一個T,還你一個R.
public interface Function<T, R> {
R apply(T t) throws Exception;
}複製程式碼
本例寫的是將String->int.
重頭戲,subscribeActual()
是訂閱真正發生的地方,ObservableMap
如下編寫,就一句話,用MapObserver訂閱上游Observable。:
@Override
public void subscribeActual(Observer<? super U> t) {
//用MapObserver訂閱上游Observable。
source.subscribe(new MapObserver<T, U>(t, function));
}複製程式碼
MapObserver
也是裝飾者模式,對終點(下游)Observer
修飾。
static final class MapObserver<T, U> extends BasicFuseableObserver<T, U> {
final Function<? super T, ? extends U> mapper;
MapObserver(Observer<? super U> actual, Function<? super T, ? extends U> mapper) {
//super()將actual儲存起來
super(actual);
//儲存Function變數
this.mapper = mapper;
}
@Override
public void onNext(T t) {
//done在onError 和 onComplete以後才會是true,預設這裡是false,所以跳過
if (done) {
return;
}
//預設sourceMode是0,所以跳過
if (sourceMode != NONE) {
actual.onNext(null);
return;
}
//下游Observer接受的值
U v;
//這一步執行變換,將上游傳過來的T,利用Function轉換成下游需要的U。
try {
v = ObjectHelper.requireNonNull(mapper.apply(t), "The mapper function returned a null value.");
} catch (Throwable ex) {
fail(ex);
return;
}
//變換後傳遞給下游Observer
actual.onNext(v);
}複製程式碼
到此我們梳理一下流程:
訂閱的過程,是從下游到上游依次訂閱的。
- 即終點
Observer
訂閱了map
返回的ObservableMap
。 - 然後
map
的Observable
(ObservableMap
)在被訂閱時,會訂閱其內部儲存上游Observable
,用於訂閱上游的Observer
是一個裝飾者(MapObserver
),內部儲存了下游(本例是終點)Observer
,以便上游傳送資料過來時,能傳遞給下游。 - 以此類推,直到源頭
Observable
被訂閱,根據上節課內容,它開始向Observer傳送資料。
資料傳遞的過程,當然是從上游push到下游的,
- 源頭
Observable
傳遞資料給下游Observer
(本例就是MapObserver
) - 然後
MapObserver
接收到資料,對其變換操作後(實際的function在這一步執行),再呼叫內部儲存的下游Observer
的onNext()
傳送資料給下游 - 以此類推,直到終點
Observer
。
執行緒排程subscribeOn
簡化問題,程式碼如下:
Observable.create(new ObservableOnSubscribe<String>() {
@Override
public void subscribe(ObservableEmitter<String> e) throws Exception {
Log.d(TAG, "subscribe() called with: e = [" + e + "]" + Thread.currentThread());
e.onNext("1");
e.onComplete();
}
//只是在Observable和Observer之間增加了一句執行緒排程程式碼
}).subscribeOn(Schedulers.io())
.subscribe(new Observer<String>() {
@Override
public void onSubscribe(Disposable d) {
Log.d(TAG, "onSubscribe() called with: d = [" + d + "]");
}
@Override
public void onNext(String value) {
Log.d(TAG, "onNext() called with: value = [" + value + "]");
}
@Override
public void onError(Throwable e) {
Log.d(TAG, "onError() called with: e = [" + e + "]");
}
@Override
public void onComplete() {
Log.d(TAG, "onComplete() called");
}
});複製程式碼
只是在Observable
和Observer
之間增加了一句執行緒排程程式碼:.subscribeOn(Schedulers.io())
.
檢視subscribeOn()
原始碼:
public final Observable<T> subscribeOn(Scheduler scheduler) {
//判空略過
ObjectHelper.requireNonNull(scheduler, "scheduler is null");
//拋開Hook,重點還是ObservableSubscribeOn
return RxJavaPlugins.onAssembly(new ObservableSubscribeOn<T>(this, scheduler));
}複製程式碼
等等,怎麼有種似曾相識的感覺,大家可以把文章向上翻,看看map()
的原始碼。
和subscribeOn()
的套路如出一轍,那麼我們根據上面的結論,
先猜測ObservableSubscribeOn
類也是一個包裝類(裝飾者),點進去檢視:
public final class ObservableSubscribeOn<T> extends AbstractObservableWithUpstream<T, T> {
//儲存執行緒排程器
final Scheduler scheduler;
public ObservableSubscribeOn(ObservableSource<T> source, Scheduler scheduler) {
//map的原始碼中我們分析過,super()只是簡單的儲存ObservableSource
super(source);
this.scheduler = scheduler;
}
@Override
public void subscribeActual(final Observer<? super T> s) {
//1 建立一個包裝Observer
final SubscribeOnObserver<T> parent = new SubscribeOnObserver<T>(s);
//2 手動呼叫 下游(終點)Observer.onSubscribe()方法,所以onSubscribe()方法執行在 訂閱處所在的執行緒
s.onSubscribe(parent);
//3 setDisposable()是為了將子執行緒的操作加入Disposable管理中
parent.setDisposable(scheduler.scheduleDirect(new Runnable() {
@Override
public void run() {
//4 此時已經執行在相應的Scheduler 的執行緒中
source.subscribe(parent);
}
}));
}複製程式碼
和map套路大體一致,ObservableSubscribeOn
自身同樣是個包裝類,同樣繼承AbstractObservableWithUpstream
。
建立了一個SubscribeOnObserver
類,該類按照套路,應該也是實現了Observer
、Disposable
介面的包裝類,讓我們看一下:
static final class SubscribeOnObserver<T> extends AtomicReference<Disposable> implements Observer<T>, Disposable {
//真正的下游(終點)觀察者
final Observer<? super T> actual;
//用於儲存上游的Disposable,以便在自身dispose時,連同上游一起dispose
final AtomicReference<Disposable> s;
SubscribeOnObserver(Observer<? super T> actual) {
this.actual = actual;
this.s = new AtomicReference<Disposable>();
}
@Override
public void onSubscribe(Disposable s) {
//onSubscribe()方法由上游呼叫,傳入Disposable。在本類中賦值給this.s,加入管理。
DisposableHelper.setOnce(this.s, s);
}
//直接呼叫下游觀察者的對應方法
@Override
public void onNext(T t) {
actual.onNext(t);
}
@Override
public void onError(Throwable t) {
actual.onError(t);
}
@Override
public void onComplete() {
actual.onComplete();
}
//取消訂閱時,連同上游Disposable一起取消
@Override
public void dispose() {
DisposableHelper.dispose(s);
DisposableHelper.dispose(this);
}
@Override
public boolean isDisposed() {
return DisposableHelper.isDisposed(get());
}
//這個方法在subscribeActual()中被手動呼叫,為了將Schedulers返回的Worker加入管理
void setDisposable(Disposable d) {
DisposableHelper.setOnce(this, d);
}
}複製程式碼
這兩個類根據上一節的鋪墊加上註釋,其他都好理解,稍微不好理解的應該是下面兩句程式碼:
//ObservableSubscribeOn類
//3 setDisposable()是為了將子執行緒的操作加入Disposable管理中
parent.setDisposable(scheduler.scheduleDirect(new Runnable() {
@Override
public void run() {
//4 此時已經執行在相應的Scheduler 的執行緒中
source.subscribe(parent);
}
}));
//SubscribeOnObserver類
//這個方法在subscribeActual()中被手動呼叫,為了將Schedulers返回的Worker加入管理
void setDisposable(Disposable d) {
DisposableHelper.setOnce(this, d);
}複製程式碼
其中scheduler.scheduleDirect(new Runnable()..)
方法原始碼如下:
/**
* Schedules the given task on this scheduler non-delayed execution.
* .....
*/
public Disposable scheduleDirect(Runnable run) {
return scheduleDirect(run, 0L, TimeUnit.NANOSECONDS);
}複製程式碼
從註釋和方法名我們可以看出,這個傳入的Runnable
會立刻執行。
再繼續往裡面看:
public Disposable scheduleDirect(Runnable run, long delay, TimeUnit unit) {
//class Worker implements Disposable ,Worker本身是實現了Disposable
final Worker w = createWorker();
//hook略過
final Runnable decoratedRun = RxJavaPlugins.onSchedule(run);
//開始在Worker的執行緒執行任務,
w.schedule(new Runnable() {
@Override
public void run() {
try {
//呼叫的是 run()不是 start()方法執行的執行緒的方法。
decoratedRun.run();
} finally {
//執行完畢會 dispose()
w.dispose();
}
}
}, delay, unit);
//返回Worker物件
return w;
}複製程式碼
createWorker()
是一個抽象方法,由具體的Scheduler
類實現,例如IoScheduler
對應的Schedulers.io()
.
public abstract Worker createWorker();複製程式碼
初看原始碼,為了瞭解大致流程,不宜過入深入,先點到為止。
OK,現在我們總結一下scheduler.scheduleDirect(new Runnable()..)
的重點:
- 傳入的
Runnable
是立刻執行的。 - 返回的
Worker
物件就是一個Disposable
物件, Runnable
執行時,是直接手動呼叫的run()
,而不是start()
方法.- 上一點應該是為了,能控制在
run()
結束後(包括異常終止),都會自動執行Worker
.dispose()
.
而返回的Worker
物件也會被parent.setDisposable(...)
加入管理中,以便在手動dispose()
時能取消執行緒裡的工作。
我們總結一下subscribeOn(Schedulers.xxx())
的過程:
- 返回一個
ObservableSubscribeOn
包裝類物件 - 上一步返回的物件被訂閱時,回撥該類中的
subscribeActual()
方法,在其中會立刻將執行緒切換到對應的Schedulers.xxx()
執行緒。 - 在切換後的執行緒中,執行
source.subscribe(parent);
,對上游(終點)Observable
訂閱 - 上游(終點)
Observable
開始傳送資料,根據RxJava2 原始碼解析(一),上游傳送資料僅僅是呼叫下游觀察者對應的onXXX()
方法而已,所以此時操作是在切換後的執行緒中進行。
一點擴充套件,
大家可能看過一個結論:subscribeOn(Schedulers.xxx())
切換執行緒N次,總是以第一次為準,或者說離源Observable最近的那次為準,並且對其上面的程式碼生效(這一點對比的ObserveOn()
)。
為什麼?
- 因為根據RxJava2 原始碼解析(一)中提到,訂閱流程從下游往上游傳遞
- 在
subscribeActual()
裡開啟了Scheduler的工作,source.subscribe(parent);
,從這一句開始切換了執行緒,所以在這之上的程式碼都是在切換後的執行緒裡的了。 - 但如果連續切換,最上面的切換最晚執行,此時執行緒變成了最上面的
subscribeOn(xxxx)
指定的執行緒, - 而資料push時,是從上游到下游的,所以會在離源頭最近的那次
subscribeOn(xxxx)
的執行緒裡push資料(onXXX()
)給下游。
可寫如下程式碼驗證:
Observable.create(new ObservableOnSubscribe<String>() {
@Override
public void subscribe(ObservableEmitter<String> e) throws Exception {
Log.d(TAG, "subscribe() called with: e = [" + e + "]" + Thread.currentThread());
e.onNext("1");
e.onComplete();
}
}).subscribeOn(Schedulers.io())
.map(new Function<String, String>() {
@Override
public String apply(String s) throws Exception {
//依然是io執行緒
Log.d(TAG, "apply() called with: s = [" + s + "]" + Thread.currentThread());
return s;
}
})
.subscribeOn(Schedulers.computation())
.subscribe(new Observer<String>() {
@Override
public void onSubscribe(Disposable d) {
Log.d(TAG, "onSubscribe() called with: d = [" + d + "]");
}
@Override
public void onNext(String value) {
Log.d(TAG, "onNext() called with: value = [" + value + "]");
}
@Override
public void onError(Throwable e) {
Log.d(TAG, "onError() called with: e = [" + e + "]");
}
@Override
public void onComplete() {
Log.d(TAG, "onComplete() called");
}
});複製程式碼
執行緒排程observeOn
在上一節的基礎上,增加一個observeOn(AndroidSchedulers.mainThread())
,就完成了觀察者執行緒的切換。
.subscribeOn(Schedulers.computation())
//在上一節的基礎上,增加一個ObserveOn
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Observer<String>() {複製程式碼
繼續看原始碼吧,我已經能猜出來了,hook+new XXXObservable();
public final Observable<T> observeOn(Scheduler scheduler) {
return observeOn(scheduler, false, bufferSize());
}
public final Observable<T> observeOn(Scheduler scheduler, boolean delayError, int bufferSize) {
....
return RxJavaPlugins.onAssembly(new ObservableObserveOn<T>(this, scheduler, delayError, bufferSize));
}複製程式碼
果然,檢視ObservableObserveOn
,:
高能預警,這部分的程式碼 有些略多,建議讀者開啟原始碼邊看邊讀。
public final class ObservableObserveOn<T> extends AbstractObservableWithUpstream<T, T> {
//本例是 AndroidSchedulers.mainThread()
final Scheduler scheduler;
//預設false
final boolean delayError;
//預設128
final int bufferSize;
public ObservableObserveOn(ObservableSource<T> source, Scheduler scheduler, boolean delayError, int bufferSize) {
super(source);
this.scheduler = scheduler;
this.delayError = delayError;
this.bufferSize = bufferSize;
}
@Override
protected void subscribeActual(Observer<? super T> observer) {
// false
if (scheduler instanceof TrampolineScheduler) {
source.subscribe(observer);
} else {
//1 建立出一個 主執行緒的Worker
Scheduler.Worker w = scheduler.createWorker();
//2 訂閱上游資料來源,
source.subscribe(new ObserveOnObserver<T>(observer, w, delayError, bufferSize));
}
}複製程式碼
本例中,就是兩步:
- 建立一個
AndroidSchedulers.mainThread()
對應的Worker
- 用
ObserveOnObserver
訂閱上游資料來源。這樣當資料從上游push下來,會由ObserveOnObserver
對應的onXXX()
處理。
static final class ObserveOnObserver<T> extends BasicIntQueueDisposable<T>
implements Observer<T>, Runnable {
//下游的觀察者
final Observer<? super T> actual;
//對應Scheduler裡的Worker
final Scheduler.Worker worker;
//上游被觀察者 push 過來的資料都存在這裡
SimpleQueue<T> queue;
Disposable s;
//如果onError了,儲存對應的異常
Throwable error;
//是否完成
volatile boolean done;
//是否取消
volatile boolean cancelled;
// 代表同步傳送 非同步傳送
int sourceMode;
....
@Override
public void onSubscribe(Disposable s) {
if (DisposableHelper.validate(this.s, s)) {
this.s = s;
//省略大量無關程式碼
//建立一個queue 用於儲存上游 onNext() push的資料
queue = new SpscLinkedArrayQueue<T>(bufferSize);
//回撥下游觀察者onSubscribe方法
actual.onSubscribe(this);
}
}
@Override
public void onNext(T t) {
//1 執行過error / complete 會是true
if (done) {
return;
}
//2 如果資料來源型別不是非同步的, 預設不是
if (sourceMode != QueueDisposable.ASYNC) {
//3 將上游push過來的資料 加入 queue裡
queue.offer(t);
}
//4 開始進入對應Workder執行緒,線上程裡 將queue裡的t 取出 傳送給下游Observer
schedule();
}
@Override
public void onError(Throwable t) {
//已經done 會 拋異常 和 上一篇文章裡提到的一樣
if (done) {
RxJavaPlugins.onError(t);
return;
}
//給error存個值
error = t;
done = true;
//開始排程
schedule();
}
@Override
public void onComplete() {
//已經done 會 返回 不會crash 和上一篇文章裡提到的一樣
if (done) {
return;
}
done = true;
//開始排程
schedule();
}
void schedule() {
if (getAndIncrement() == 0) {
//該方法需要傳入一個執行緒, 注意看本類實現了Runnable的介面,所以檢視對應的run()方法
worker.schedule(this);
}
}
//從這裡開始,這個方法已經是在Workder對應的執行緒裡執行的了
@Override
public void run() {
//預設是false
if (outputFused) {
drainFused();
} else {
//取出queue裡的資料 傳送
drainNormal();
}
}
void drainNormal() {
int missed = 1;
final SimpleQueue<T> q = queue;
final Observer<? super T> a = actual;
for (;;) {
// 1 如果已經 終止 或者queue空,則跳出函式,
if (checkTerminated(done, q.isEmpty(), a)) {
return;
}
for (;;) {
boolean d = done;
T v;
try {
//2 從queue裡取出一個值
v = q.poll();
} catch (Throwable ex) {
//3 異常處理 並跳出函式
Exceptions.throwIfFatal(ex);
s.dispose();
q.clear();
a.onError(ex);
return;
}
boolean empty = v == null;
//4 再次檢查 是否 終止 如果滿足條件 跳出函式
if (checkTerminated(d, empty, a)) {
return;
}
//5 上游還沒結束資料傳送,但是這邊處理的佇列已經是空的,不會push給下游 Observer
if (empty) {
//僅僅是結束這次迴圈,不傳送這個資料而已,並不會跳出函式
break;
}
//6 傳送給下游了
a.onNext(v);
}
//7 對不起這裡我也不是很明白,大致猜測是用於 同步原子操作 如有人知道 煩請告知
missed = addAndGet(-missed);
if (missed == 0) {
break;
}
}
}
//檢查 是否 已經 結束(error complete), 是否沒資料要傳送了(empty 空),
boolean checkTerminated(boolean d, boolean empty, Observer<? super T> a) {
//如果已經disposed
if (cancelled) {
queue.clear();
return true;
}
// 如果已經結束
if (d) {
Throwable e = error;
//如果是延遲傳送錯誤
if (delayError) {
//如果空
if (empty) {
if (e != null) {
a.onError(e);
} else {
a.onComplete();
}
//停止worker(執行緒)
worker.dispose();
return true;
}
} else {
//傳送錯誤
if (e != null) {
queue.clear();
a.onError(e);
worker.dispose();
return true;
} else
//傳送complete
if (empty) {
a.onComplete();
worker.dispose();
return true;
}
}
}
return false;
}
}複製程式碼
核心處都加了註釋,總結起來就是,
ObserveOnObserver
實現了Observer
和Runnable
介面。- 在
onNext()
裡,先不切換執行緒,將資料加入佇列queue
。然後開始切換執行緒,在另一執行緒中,從queue
裡取出資料,push
給下游Observer
onError()
onComplete()
除了和RxJava2 原始碼解析(一)提到的一樣特性之外,也是將錯誤/完成資訊先儲存,切換執行緒後再傳送。- 所以
observeOn()
影響的是其下游的程式碼,且多次呼叫仍然生效。 - 因為其切換執行緒程式碼是在
Observer
裡onXXX()
做的,這是一個主動的push行為(影響下游)。 - 關於多次呼叫生效問題。對比
subscribeOn()
切換執行緒是在subscribeActual()
裡做的,只是主動切換了上游的訂閱執行緒,從而影響其發射資料時所在的執行緒。而直到真正發射資料之前,任何改變執行緒的行為,都會生效(影響發射資料的執行緒)。所以subscribeOn()
只生效一次。observeOn()
是一個主動的行為,並且切換執行緒後會立刻傳送資料,所以會生效多次.
轉載請標明出處:
juejin.im/post/58ce8c…
本文出自:【張旭童的稀土掘金】(gold.xitu.io/user/56de21…)
總結
本文帶大家走讀分析了三個東西:
map操作符原理:
- 內部對上游
Observable
進行訂閱 - 內部訂閱者接收到資料後,將資料轉換,傳送給下游
Observer
. - 操作符返回的
Observable
和其內部訂閱者、是裝飾者模式的體現。 - 操作符資料變換的操作,也是發生在訂閱後。
執行緒排程subscribeOn()
:
- 內部先切換執行緒,在切換後的執行緒中對上游
Observable
進行訂閱,這樣上游傳送資料時就是處於被切換後的執行緒裡了。 - 也因此多次切換執行緒,最後一次切換(離源資料最近)的生效。
- 內部訂閱者接收到資料後,直接傳送給下游
Observer
. - 引入內部訂閱者是為了控制執行緒(dispose)
- 執行緒切換發生在
Observable
中。
執行緒排程observeOn()
:
- 使用裝飾的
Observer
對上游Observable
進行訂閱 - 在
Observer
中onXXX()
方法裡,將待傳送資料存入佇列,同時請求切換執行緒處理真正push資料給下游。 - 多次切換執行緒,都會對下游生效。
原始碼裡那些實現了Runnable
的類或者匿名內部類,最終並沒有像往常那樣被丟給Thread
類執行。
而是先切換執行緒,再直接執行Runnable
的run()
方法。
這也加深了我對物件導向,對抽象、Runnable
的理解,它就是一個簡簡單單的介面,裡面就一個簡簡單單的run()
,
我認為,之所以有Runnable
,只是抽象出 一個可執行的任務的概念。
也許這句話很平淡,書上也會提到,各位大佬早就知道,但是如今我順著RxJava2的原始碼這麼走讀了一遍,確真真切切的感受到了這些設計思想的美妙。