引言
该篇文章主要是关于RxJava的功能性操作符使用的代码讲解。功能性操作符总共以下几类:
- 连接被观察&观察者:subscribe()
- 线程调度:subscribeOn(),observeOn()
- 延迟操作:delay()
- 在事件的生命周期中操作:do
- 错误处理:onErrorReturn,onErrorResumeNext,onExceptionResumeNext,retry,retryUntil,retryWhen
- 重复发送操作:repeat,repeatWhen()
1. subscribe()
/**
* 1.分步骤的完整调用
*/
//步骤1:创建被观察者 Observable 对象
Observable observable = Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(2);
e.onNext(3);
e.onComplete();
}
});
//步骤2:创建观察者Observer 并定义响应事件行为
Observer observer = new Observer() {
@Override
public void onSubscribe(Disposable d) {
Log.d(Constant.TAG,"开始采用subscribe连接");
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG,"对Next事件"+value +"做出响应");
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG,"对Error事件做出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG,"对complete事件做出响应");
}
};
//步骤3:通过订阅连接观察者和被观察者
observable.subscribe(observer);
/**
* 2.基于事件流的链式调用
*/
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(2);
e.onNext(3);
e.onComplete();
}
}).subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
Log.d(Constant.TAG,"开始采用subscribe连接");
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG,"对Next事件"+value +"做出响应");
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG,"对Error事件做出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG,"对complete事件做出响应");
}
});
log信息:
06-26 18:04:26.267 9000-9000/com.gjj.frame D/RxJava: 开始采用subscribe连接
06-26 18:04:26.267 9000-9000/com.gjj.frame D/RxJava: 对Next事件1做出响应
06-26 18:04:26.267 9000-9000/com.gjj.frame D/RxJava: 对Next事件2做出响应
06-26 18:04:26.267 9000-9000/com.gjj.frame D/RxJava: 对Next事件3做出响应
06-26 18:04:26.268 9000-9000/com.gjj.frame D/RxJava: 对complete事件做出响应
2.线程调度
指定被观察者和观察者的工作线程,详见文章RxJava操作符--->线程调度
3.delay()
使得被观察者延迟一段时间再发送事件。
delay()有多个重载方法:
// 1. 指定延迟时间
// 参数1 = 时间;参数2 = 时间单位
delay(long delay,TimeUnit unit)
// 2. 指定延迟时间 & 调度器
// 参数1 = 时间;参数2 = 时间单位;参数3 = 线程调度器
delay(long delay,TimeUnit unit,mScheduler scheduler)
// 3. 指定延迟时间 & 错误延迟
// 错误延迟,即:若存在Error事件,则如常执行,执行后再抛出错误异常
// 参数1 = 时间;参数2 = 时间单位;参数3 = 错误延迟参数
delay(long delay,TimeUnit unit,boolean delayError)
// 4. 指定延迟时间 & 调度器 & 错误延迟
// 参数1 = 时间;参数2 = 时间单位;参数3 = 线程调度器;参数4 = 错误延迟参数
delay(long delay,TimeUnit unit,mScheduler scheduler,boolean delayError): 指定延迟多长时间并添加调度器,错误通知可以设置是否延迟
使用:
Observable.just(1,2,3)
.delay(3, TimeUnit.SECONDS)
.subscribe(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"接收到了事件"+integer);
}
});
log信息:
06-27 13:37:29.114 907-971/com.gjj.frame D/RxJava: 接收到了事件1
06-27 13:37:29.116 907-971/com.gjj.frame D/RxJava: 接收到了事件2
06-27 13:37:29.117 907-971/com.gjj.frame D/RxJava: 接收到了事件3
06-27 13:37:29.118 907-971/com.gjj.frame D/RxJava: 对Complete事件作出响应
4. do()
在某个事件的生命周期中调用,具体有如下分类:
- 当Observable每发送1次数据事件就会调用1次,doOnEach()
- 执行Next事件前调用,doOnNext()
- 执行Next事件后调用,doAfterNext()
- 发送错误事件时调用,doOnError()
- 正常发送事件完毕后调用,doOnCompelted()
- 无论正常发送完毕/异常终止时调用,doOnTerminate()
- 观察者订阅时调用,doOnSubscribe()
- 观察者取消订阅时调用,doOnUnsubscribe()
使用:
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(2);
e.onError(new Throwable("发生错误了"));
}
}).doOnEach(new Consumer>() {
@Override
public void accept(Notification integerNotification) throws Exception {
Log.d(Constant.TAG,"doOnEach:"+integerNotification.getValue());
}
}).doOnNext(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"doOnNext:"+integer);
}
}).doAfterNext(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"doAfterNext:"+integer);
}
}).doOnComplete(new Action() {
@Override
public void run() throws Exception {
Log.e(Constant.TAG,"doOnComplete()");
}
}).doOnError(new Consumer() {
@Override
public void accept(Throwable throwable) throws Exception {
Log.d(Constant.TAG,"doOnError:"+throwable.getMessage());
}
}).doOnSubscribe(new Consumer() {
@Override
public void accept(Disposable disposable) throws Exception {
Log.e(Constant.TAG,"doOnSubscribe");
}
}).doFinally(new Action() {
@Override
public void run() throws Exception {
Log.e(Constant.TAG,"doFinally");
}
}).subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG,"接收到了事件"+value);
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG,"对Error事件作出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG,"对Complete事件作出响应");
}
});
log信息:
06-27 13:59:43.141 2617-2617/com.gjj.frame E/RxJava: doOnSubscribe
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doOnEach:1
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doOnNext:1
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: 接收到了事件1
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doAfterNext:1
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doOnEach:2
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doOnNext:2
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: 接收到了事件2
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doAfterNext:2
06-27 13:59:43.142 2617-2617/com.gjj.frame D/RxJava: doOnEach:null
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: doOnError:发生错误了
06-27 13:59:43.141 2617-2617/com.gjj.frame D/RxJava: 对Error事件作出响应
06-27 13:59:43.142 2617-2617/com.gjj.frame E/RxJava: doFinally
5. onErrorReturn()
在发送事件的过程中,遇到错误时,发送一个特殊事件&正常终止,可捕获在它之前发生的异常。
使用:
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(2);
e.onError(new Throwable("发生错误了"));
}
}).onErrorReturn(new Function() {
@Override
public Integer apply(Throwable throwable) throws Exception {
//捕捉错误异常
Log.e(Constant.TAG,"在OnErrorReturn处理了错误:"+throwable.toString());
return 666;
//发生错误事件后,发送一个“666”事件,最终正常结束
}
}).subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG,"接收到了事件"+value);
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG,"对Error事件作出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG,"对Complete事件作出响应");
}
});
log信息:
06-27 15:13:53.001 6782-6782/com.gjj.frame D/RxJava: 接收到了事件1
06-27 15:13:53.002 6782-6782/com.gjj.frame D/RxJava: 接收到了事件2
06-27 15:13:53.002 6782-6782/com.gjj.frame E/RxJava: 在OnErrorReturn处理了错误:java.lang.Throwable: 发生错误了
06-27 15:13:53.002 6782-6782/com.gjj.frame D/RxJava: 接收到了事件666
06-27 15:13:53.002 6782-6782/com.gjj.frame D/RxJava: 对Complete事件作出响应
6. onErrorResumeNext()
遇到错误时,发送1个新的Observable
注:
- onErrorResumeNext()拦截的错误 = Throwable;若需拦截Exception请用OnExceptionResumeNext()
2.若onErrorResumeNext()拦截的错误 = Exception,则会将错误传递给观察者的onError方法
使用:
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(1);
e.onError(new Throwable("发生错误了"));
}
}).onErrorResumeNext(new Function>() {
@Override
public ObservableSource extends Integer> apply(Throwable throwable) throws Exception {
Log.e(Constant.TAG,"在onErrorReturn处理了错误:"+throwable.toString());
return Observable.just(11,22);
}
}).subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG,"接受到了事件"+value);
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG,"对Error事件作出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG,"对Complete事件作出响应");
}
});
log信息:
06-27 15:24:05.667 7285-7285/com.gjj.frame D/RxJava: 接受到了事件1
06-27 15:24:05.667 7285-7285/com.gjj.frame D/RxJava: 接受到了事件1
06-27 15:24:05.667 7285-7285/com.gjj.frame E/RxJava: 在onErrorReturn处理了错误:java.lang.Throwable: 发生错误了
06-27 15:24:05.668 7285-7285/com.gjj.frame D/RxJava: 接受到了事件11
06-27 15:24:05.668 7285-7285/com.gjj.frame D/RxJava: 接受到了事件22
06-27 15:24:05.668 7285-7285/com.gjj.frame D/RxJava: 对Complete事件作出响应
7. onExceptionResumeNext()
遇到错误时,发送1个新的Observable
注:
- onExceptionResumeNext()拦截的错误 = Exception;若需拦截Throwable请用OnExceptionResumeNext()
2.若onExceptionResumeNext()拦截的错误 = Throwable,则会将错误传递给观察者的onError方法
使用:
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(1);
e.onError(new Exception("发生错误了"));
}
}).onExceptionResumeNext(new Observable() {
@Override
protected void subscribeActual(Observer super Integer> observer) {
observer.onNext(11);
observer.onNext(22);
observer.onComplete();
}
}).subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG,"接受到了事件"+value);
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG,"对Error事件作出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG,"对Complete事件作出响应");
}
});
log信息:
06-27 15:30:30.618 7744-7744/com.gjj.frame D/RxJava: 接受到了事件1
06-27 15:30:30.618 7744-7744/com.gjj.frame D/RxJava: 接受到了事件1
06-27 15:30:30.618 7744-7744/com.gjj.frame D/RxJava: 接受到了事件11
06-27 15:30:30.619 7744-7744/com.gjj.frame D/RxJava: 接受到了事件22
06-27 15:30:30.618 7744-7744/com.gjj.frame D/RxJava: 对Complete事件作出响应
8. retry()
在发送事件的过程中,出现错误时,让被观察者Observable重新发射数据
1.接收到onError时,重新订阅&发送事件
2.Throwable和Exception都可拦截
retry()对应的有五种重载方法:
<-- 1. retry() -->
// 作用:出现错误时,让被观察者重新发送数据
// 注:若一直错误,则一直重新发送
<-- 2. retry(long time) -->
// 作用:出现错误时,让被观察者重新发送数据(具备重试次数限制
// 参数 = 重试次数
<-- 3. retry(Predicate predicate) -->
// 作用:出现错误后,判断是否需要重新发送数据(若需要重新发送& 持续遇到错误,则持续重试)
// 参数 = 判断逻辑
<-- 4. retry(new BiPredicate) -->
// 作用:出现错误后,判断是否需要重新发送数据(若需要重新发送 & 持续遇到错误,则持续重试
// 参数 = 判断逻辑(传入当前重试次数 & 异常错误信息)
<-- 5. retry(long time,Predicate predicate) -->
// 作用:出现错误后,判断是否需要重新发送数据(具备重试次数限制
// 参数 = 设置重试次数 & 判断逻辑
- retry()
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onError(new Exception("发生错误了"));
e.onNext(2);
}
}).retry()
.subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG, "接收到了事件"+ value );
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG, "对Error事件作出响应");
}
@Override
public void onComplete() {
Log.d(Constant.TAG, "对Complete事件作出响应");
}
});
- retry(long time)
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onError(new Exception("发生错误了"));
e.onNext(2);
}
}).retry(3)//重试次数
.subscribe(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"接受到了事件"+integer);
}
});
- retry(Predicate predicate)
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onError(new Exception("发生错误了"));
e.onNext(2);
}
}).retry(new Predicate() {
@Override
public boolean test(Throwable throwable) throws Exception {
//捕获异常
Log.d(Constant.TAG,"retry错误:"+throwable.toString());
//返回false = 不重新发送数据 & 调用观察者的onError结束
//返回true = 重新发送请求(若持续遇到错误,就持续重新发送)
return true;
}
})//重试次数
.subscribe(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"接受到了事件"+integer);
}
});
- retry(new BiPredicate
)
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onError(new Exception("发生错误了"));
e.onNext(2);
}
}).retry(new BiPredicate() {
@Override
public boolean test(Integer integer, Throwable throwable) throws Exception {
//捕获异常
Log.d(Constant.TAG,"异常错误="+throwable.toString());
//获取当前重试次数
Log.e(Constant.TAG,"当前重试次数 = " +integer);
return false;
}
})//重试次数
.subscribe(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"接受到了事件"+integer);
}
});
- retry(long time,Predicate predicate)
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onError(new Exception("发生错误了"));
e.onNext(2);
}
}).retry(3, new Predicate() {
@Override
public boolean test(Throwable throwable) throws Exception {
Log.e(Constant.TAG,"retry错误:"+throwable.toString());
return true;
}
})
.subscribe(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"接受到了事件"+integer);
}
});
9. retryUntil()
出现错误后,判断是否需要重新发送数据,作用类似于retry(Predicate predicate)。
10. retryWhen()
在发送事件的过程中遇到错误时,将发生的错误传递给一个新的被观察者,并决定是否需要重新订阅原始被观察者&发送数据
使用:
Observable.create(new ObservableOnSubscribe() {
@Override
public void subscribe(ObservableEmitter e) throws Exception {
e.onNext(1);
e.onNext(2);
e.onError(new Exception("发生错误了"));
e.onNext(2);
}
})
//遇到Error事件才会回调
.retryWhen(new Function, ObservableSource>>() {
@Override
public ObservableSource> apply(Observable throwableObservable) throws Exception {
// 参数Observable中的泛型 = 上游操作符抛出的异常,可通过该条件来判断异常的类型
// 返回Observable> = 新的被观察者 Observable(任意类型)
// 此处有两种情况:
// 1. 若 新的被观察者 Observable发送的事件 = Error事件,那么 原始Observable则不重新发送事件:
// 2. 若 新的被观察者 Observable发送的事件 = Next事件 ,那么原始的Observable则重新发送事件:
return throwableObservable.flatMap(new Function>() {
@Override
public ObservableSource> apply(Throwable throwable) throws Exception {
// 1. 若返回的Observable发送的事件 = Error事件,则原始的Observable不重新发送事件
// 该异常错误信息可在观察者中的onError()中获得
// return Observable.error(new Throwable("retryWhen终止了"));
// 2. 若返回的Observable发送的事件 = Next事件,则原始的Observable重新发送事件(若持续遇到错误,则持续重试)
return Observable.just(5);
}
});
}
}).subscribe(new Observer() {
@Override
public void onSubscribe(Disposable d) {
}
@Override
public void onNext(Integer value) {
Log.d(Constant.TAG, "接收到了事件"+ value );
}
@Override
public void onError(Throwable e) {
Log.d(Constant.TAG, "对Error事件作出响应" + e.toString());
// 获取异常错误信息
}
@Override
public void onComplete() {
Log.d(Constant.TAG, "对Complete事件作出响应");
}
});
- 新的Observable发送错误事件时,原始Observable终止发送
06-27 17:40:53.110 21606-21606/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:40:53.113 21606-21606/com.gjj.frame D/RxJava: 对Error事件作出响应java.lang.Throwable: retryWhen终止了
- 新的Observable发送数据事件时,原始Observable持续重试
06-27 17:44:03.969 22791-22791/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:44:03.970 22791-22791/com.gjj.frame D/RxJava: 接收到了事件2
接收到了事件1
06-27 17:44:03.971 22791-22791/com.gjj.frame D/RxJava: 接收到了事件2
06-27 17:44:03.970 22791-22791/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:44:03.971 22791-22791/com.gjj.frame D/RxJava: 接收到了事件2
06-27 17:44:03.970 22791-22791/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:44:03.970 22791-22791/com.gjj.frame D/RxJava: 接收到了事件2
06-27 17:44:03.972 22791-22791/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:44:03.970 22791-22791/com.gjj.frame D/RxJava: 接收到了事件2
11.repeat()
无条件地、重复发送被观察者事件
使用:
//repeat();无限次发送
//repeat(3);重复发送次数有限
Observable.just(1,2)
.repeat(3)
.subscribe(new Consumer() {
@Override
public void accept(Integer integer) throws Exception {
Log.d(Constant.TAG,"接收到了事件"+integer);
}
});
log信息:
06-27 17:51:15.766 23209-23209/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:51:15.766 23209-23209/com.gjj.frame D/RxJava: 接收到了事件2
06-27 17:51:15.766 23209-23209/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:51:15.766 23209-23209/com.gjj.frame D/RxJava: 接收到了事件2
06-27 17:51:15.766 23209-23209/com.gjj.frame D/RxJava: 接收到了事件1
06-27 17:51:15.766 23209-23209/com.gjj.frame D/RxJava: 接收到了事件2
12.repeatWhen()
有条件地、重复发送被观察者事件,如果新观察者返回Complete/Error事件,则不重新发送原来的Observable,如果新观察者返回其余事件时,则重新发送原来的Observable。
使用:
Observable.just(1,2)
// 在Function函数中,必须对输入的 Observable
- 新的Observable发送Complete事件 = 原始Observable停止发送&不重新发送
06-27 18:03:30.669 23471-23471/com.gjj.frame D/RxJava: 开始采用subscribe连接
06-27 18:03:30.674 23471-23471/com.gjj.frame D/RxJava: 接收到了事件1
06-27 18:03:30.674 23471-23471/com.gjj.frame D/RxJava: 接收到了事件2
- 新的Observable发送error事件 = 原始Observable停止发送&不重新发送
06-27 18:06:37.814 23672-23672/com.gjj.frame D/RxJava: 开始采用subscribe连接
06-27 18:06:37.816 23672-23672/com.gjj.frame D/RxJava: 接收到了事件1
06-27 18:06:37.817 23672-23672/com.gjj.frame D/RxJava: 接收到了事件2
06-27 18:06:37.818 23672-23672/com.gjj.frame D/RxJava: 对Error事件作出响应:java.lang.Throwable: 不再重新订阅事件
- 新的Observable发送其他事件= 原始Observable重新发送
06-27 18:08:13.130 23896-23896/com.gjj.frame D/RxJava: 开始采用subscribe连接
06-27 18:08:13.133 23896-23896/com.gjj.frame D/RxJava: 接收到了事件1
06-27 18:08:13.130 23896-23896/com.gjj.frame D/RxJava: 接收到了事件2
06-27 18:08:13.133 23896-23896/com.gjj.frame D/RxJava: 接收到了事件1
06-27 18:08:13.130 23896-23896/com.gjj.frame D/RxJava: 接收到了事件2
06-27 18:08:13.134 23896-23896/com.gjj.frame D/RxJava: 接收到了事件1
06-27 18:08:13.130 23896-23896/com.gjj.frame D/RxJava: 接收到了事件2
参考文章:
Android RxJava:功能性操作符 全面讲解