RxJava、RxAndroid

介绍

a library for composing asynchronous and event-based programs using observable sequences for the Java VM -------一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库

使用

1、关联

compile 'io.reactivex:rxjava:1.0.14'
compile 'io.reactivex:rxandroid:1.0.1'

2、简单示例

public void test01(){

        Log.e(tag,"------------test01-----------" +
                "\n----------简单实例01---------");

        //创建被观察者
        Observable<String> observable = Observable.create(new Observable.OnSubscribe<String>() {
            @Override
            public void call(Subscriber<? super String> subscriber) {
                //调用观察者的回调
                subscriber.onNext("我是");
                subscriber.onNext("RxJava");
                subscriber.onNext("简单示例");
                subscriber.onError(new Throwable("出错了"));
                subscriber.onCompleted();
            }
        });

        //创建观察者
        Observer<String> observer = new Observer<String>() {
            @Override
            public void onCompleted() {
                Log.e(tag,"onCompleted");
            }

            @Override
            public void onError(Throwable e) {
                Log.e(tag,e.getMessage());
            }

            @Override
            public void onNext(String s) {
                Log.e(tag,s);
            }
        };

        //注册,是的观察者和被观察者关联,将会触发OnSubscribe.call方法
        observable.subscribe(observer);
    }

运行结果:

    =====>: ------------test01-----------
            ----------简单实例01---------
    =====>: 我是
    =====>: RxJava
    =====>: 简单示例
    =====>: 出错了

Observable是被观察者,通过create创建(还有其他方式,后面将会讲到),传入一个OnSubscribe对象,当Observable调用subscribe进行注册观察者时,OnSubscribe的call方法会触发。Observer是观察者,他有三个回调方法:

onNext      :接受到一个事件
onCompleted :接受完事件后调用,只会调用一次
onError     :发生错误时调用,并停止接受事件,调用一次

onCompletedonError不会同时调用,只会调用其中之一


观察者除了使用Observer,还可以使用Subscriber,它跟 Observer作用一样,如下:

public void test02(){
        Log.e(tag,"------------test02-----------" +
                "\n----------简单实例02---------");

        //创建被观察者
        Observable<String> observable = Observable.create(new Observable.OnSubscribe<String>() {
            @Override
            public void call(Subscriber<? super String> subscriber) {
                //调用观察者的回调
                subscriber.onNext("我是");
                subscriber.onNext("RxJava");
                subscriber.onNext("简单示例");
                subscriber.onCompleted();
                subscriber.onError(new Throwable("出错了"));
            }
        });

        //创建观察者
        Subscriber<String> subscriber = new Subscriber<String>() {
            @Override
            public void onStart() {
                Log.e(tag,"onStart");
            }

            @Override
            public void onCompleted() {
                Log.e(tag,"onCompleted");
            }

            @Override
            public void onError(Throwable e) {
                Log.e(tag,e.getMessage());
            }

            @Override
            public void onNext(String s) {
                Log.e(tag,s);
            }
        };
        //注册,使得观察者和被观察者关联,将会触发OnSubscribe.call方法
        observable.subscribe(subscriber);
    }

运行结果

=====>: ------------test02-----------
        ----------简单实例02---------
=====>: onStart
=====>: 我是
=====>: RxJava
=====>: 简单示例
=====>: onCompleted

这里只是多了一个onStart方法 ,这个方法会在Observable调用方法subscribe注册观察者时调用一次,表明事件要开始了。

因为Subscriber只是对Observer的扩展,用法都一样,所以后面例子都用 Subscriber做观察者。


3、Observable的创建

前面简单的例子中,创建Observable是通过create方法,当然还有其他方法,体验一下吧:

public void test03(){
        Log.e(tag,"------------test03-----------" +
                "\n----------创建观察者01---------");

        Integer[] ints={1,2,3,4};

        Observable.from(ints).subscribe(new Subscriber<Integer>() {
            @Override
            public void onCompleted() {
                Log.e(tag,"onCompleted");
            }

            @Override
            public void onError(Throwable e) {
                Log.e(tag,e.getMessage());
            }

            @Override
            public void onNext(Integer integer) {
                Log.e(tag,integer+"");
            }
        });
    }

运行结果

=====>: ------------test03-----------
        ----------创建观察者01---------
=====>: 1
=====>: 2
=====>: 3
=====>: 4
=====>: onCompleted

from方法将传入的数组或 Iterable 拆分成具体对象后,依次发送出来。


public void test04(){
        Log.e(tag,"------------test04-----------" +
                "\n----------创建被观察者02---------");
        Observable.just(1,2,3,4).subscribe(new Subscriber<Integer>() {
            @Override
            public void onCompleted() {
                Log.e(tag,"onCompleted");
            }

            @Override
            public void onError(Throwable e) {
                Log.e(tag,e.getMessage());
            }

            @Override
            public void onNext(Integer integer) {
                Log.e(tag,integer+"");
            }
        });
    }

运行结果

=====>: ------------test04-----------
        ----------创建被观察者02---------
=====>: 1
=====>: 2
=====>: 3
=====>: 4
=====>: onCompleted

和from方法一样,just(T...): 将传入的参数依次发送出来。

4、观察者的其他可用形式

观察者Subscriber和Observer都需要写三个回调,有时候我们只关系其中一个回调,或者两个

public void test05(){
        Log.e(tag,"------------test05-----------" +
                "\n----------创建观察者其他形式---------");

        String[] strs={"aa","bb","cc"};
        Action1<String> onNextAction = new Action1<String>() {
            // onNext()
            @Override
            public void call(String s) {
                Log.d(tag, s);
            }
        };
        Action1<Throwable> onErrorAction = new Action1<Throwable>() {
            // onError()
            @Override
            public void call(Throwable throwable) {
               Log.e(tag,throwable.getMessage());
            }
        };
        Action0 onCompletedAction = new Action0() {
            // onCompleted()
            @Override
            public void call() {
                Log.d(tag, "completed");
            }
        };

        Observable<String> observable = Observable.from(strs);
        // 自动创建 Subscriber ,并使用 onNextAction 来定义 onNext()
        observable.subscribe(onNextAction);
        // 自动创建 Subscriber ,并使用 onNextAction 和 onErrorAction 来定义 onNext() 和 onError()
        observable.subscribe(onNextAction, onErrorAction);
       // 自动创建 Subscriber ,并使用 onNextAction、 onErrorAction 和 onCompletedAction 来定义 onNext()、 onError() 和 onCompleted()
        observable.subscribe(onNextAction, onErrorAction, onCompletedAction);

    }

这里使用了Action1和Action0, Action0 是 RxJava 的一个接口,它只有一个方法 call(),这个方法是无参无返回值的;由于 onCompleted() 方法也是无参无返回值的,因此 Action0 可以被当成一个包装对象,将 onCompleted() 的内容打包起来将自己作为一个参数传入 subscribe() 以实现不完整定义的回调。 Action1 也是一个接口,它同样只有一个方法 call(T param),这个方法也无返回值,但有一个参数;与 Action0 同理,由于 onNext(T obj) 和 onError(Throwable error) 也是单参数无返回值的,因此 Action1 可以将 onNext(obj) 和 onError(error) 打包起来传入 subscribe() 以实现不完整定义的回调。事实上,虽然 Action0 和 Action1 在 API 中使用最广泛,但 RxJava 是提供了多个 ActionX 形式的接口 (例如 Action2, Action3) 的,它们可以被用以包装不同的无返回值的方法。


5、线程调度

RxJava遵循线程不变原则,在不做特殊处理的情况下,在哪个线程调用 subscribe(),就在哪个线程生产事件;在哪个线程生产事件,就在哪个线程消费事件。如果需要切换线程,就需要用到 Scheduler (调度器)

    public void test06(){
        Log.e(tag, "------------test06-----------" +
                "\n----------线程调度---------");
        //从网络上根据用户id,请求对应用户,并显示用户积分到界面
        Observable.create(new Observable.OnSubscribe<Integer>() {
            @Override
            public void call(Subscriber<? super Integer> subscriber) {
                int id=111;
                UserInfo userinfo=getUserInfoFromNet(id);
                subscriber.onNext(userinfo.points);
            }
        }).subscribeOn(Schedulers.io())//事件产生在io线程
           .observeOn(AndroidSchedulers.mainThread())//消耗事件在主线程
           .subscribe(new Action1<Integer>() {
               @Override
               public void call(Integer points) {
                   Log.e(tag, "显示用户积分:" + points);
               }
           });
    }
    //模拟从网络请求
    private UserInfo getUserInfoFromNet(int id) {
        UserInfo userInfo = new UserInfo();
        userInfo.points=100;
        return userInfo;
    }
    public class UserInfo{
        public int id;
        public int points;
    }

运行结果

=====>: ------------test06-----------
        ----------线程调度---------
=====>: 显示用户积分:100

在io线程中根据id请求用户信息,在主线程中将用户积分显示到界面

Schedulers.newThread(): 总是启用新线程,并在新线程执行操作,适用于复杂计算。
Schedulers.io(): I/O 操作(读写文件、读写数据库、网络信息交互等)
AndroidSchedulers.mainThread(),它指定的操作将在 Android 主线程运行

subscribeOn(): 指定 subscribe() 所发生的线程,即 Observable.OnSubscribe 被激活时所处的线程。或者叫做事件产生的线程。 
observeOn(): 指定 Subscriber 所运行在的线程。或者叫做事件消费的线程

6、变换

举一个例子:通过用户id,从数据库中请求用户名称,只需要名称就行,id是int类型,用户名称是string类型

 public void test07(){
        Log.e(tag, "------------test07-----------" +
                "\n----------变换01---------");
        //从数据库中根据id获取用户名称
        Observable.just(111)
                .map(new Func1<Integer, String>() {
                    @Override
                    public String call(Integer id) {
                        return getNameFromDb(id);
                    }
                })
                .subscribe(new Action1<String>() {
                    @Override
                    public void call(String s) {
                        Log.e(tag,s);
                    }
                });
    }
    //模拟从数据获取信息
    private String getNameFromDb(int id){
        return "username";
    }
    public class UserInfo{
        public int id;
        public String name;
        public int points;
    }

运行结果

=====>: ------------test07-----------
        ----------变换01---------
=====>: username

这里的map有转换的作用,这里是吧Observable<Integer>转换成了Observable<String>,事件只能是一对一的转换,把发射id的事件,转换成了发射username的事件


flatmap转换,举一个例子:根据id从数据库中获取指定用户的爱好,并打印出来

public void test08(){
        Log.e(tag, "------------test08-----------" +
                "\n----------变换02---------");
        Observable.just(111)
                .flatMap(new Func1<Integer, Observable<String>>() {
                    @Override
                    public Observable<String> call(Integer id) {
                        return Observable.from(getHobbies(id));
                    }
                })
                .subscribe(new Action1<String>() {
                    @Override
                    public void call(String s) {
                        Log.e(tag,s);
                    }
                });

    }
    //模拟从数据获取信息
    private String[] getHobbies(int id){
        return new String[]{"singing","running","shopping"};
    }
    public class UserInfo{
        public int id;
        public String name;
        public int points;
        public String[] hobbies;
    }

运行结果

=====>: ------------test08-----------
        ----------变换02---------
=====>: singing
=====>: running
=====>: shopping

这里将Observable<Integer>转换成了 Observable.from(getHobbies(id)),将发射id的事件,转换成了多个发射爱好的事件(爱好有多个),事件是一对多


7、反注册

rxJava是基于观察者模式的,我们知道观察者模式中有注册和反注册,反注册就是为了释放资源,防止内存泄露,rxjava中也是,我们也需要及时反注册并释放资源,

    private Subscription subscription;
    public void test09(){
        Log.e(tag, "------------test09-----------" +
                "\n----------反注册---------");
        subscription = Observable.create(new Observable.OnSubscribe<String>() {
                @Override
                public void call(Subscriber<? super String> subscriber) {
                    SystemClock.sleep(5000);\\暂停5秒钟
                    subscriber.onNext("hahaha");
                    subscriber.onCompleted();\\标志事件发送完毕,just和from会自动调用onCompleted
                }
            })
            .subscribeOn(Schedulers.newThread())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(new Action1<String>() {
            @Override
            public void call(String s) {
                Log.e(tag, s);
            }
        });
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        Log.e(tag,"是否已经反注册:"+subscription.isUnsubscribed()+"");
        //先判断是否已经反注册
        if(!subscription.isUnsubscribed()){
            Log.e(tag,"进行反注册");
            subscription.unsubscribe();
            Log.e(tag,"是否已经反注册:"+subscription.isUnsubscribed()+"");
        }
    }

Subscription是注册关系,Observable调用subscribe方法时,会形成一个注册关系,SubscriptionisUnsubscribed()方法来判断是否已经反注册,unsubscribe()方法来进行反注册。一般情况下,当事件发送完成后,观察者会自动反注册,不用我们调用Subscriptionunsubscribe()方法进行反注册,但是当有耗时操作时,我们就有必要进行反注册,上面代码的运行结果如下:

运行结果

在事件还没有发送完毕时(5秒之内),我们关闭了activity:

=====>: ------------test09-----------
        ----------反注册---------
=====>: 是否已经反注册:false
=====>: 进行反注册
=====>: 是否已经反注册:true

事件已经发送完(5秒之后),我们关闭activity:

=====>: ------------test09-----------
        ----------反注册---------
=====>: hahaha
=====>: 是否已经反注册:true

8、操作符使用

rxJava有着丰富的操作符,来对数据进行流式的操作处理,上面讲到的mapflatmap就是rxJava的操作符,由于操作符太多,只示范常用的几个:

 public void test10(){
    Log.e(tag, "------------test10-----------" +
            "\n----------操作符---------");
   String[] strs={"aa","bb","bb","cc","dd","ee"};
    Observable<String> observable = Observable.from(strs);
    //filter(Func1)方法来过滤我们观测序列中不想要的值
    //take(count)方法来限制获取多少个数据
    Log.e(tag,"---------filter & take----------");
    observable
            .filter(new Func1<String, Boolean>() {
                @Override
                public Boolean call(String s) {
                    //把已b结尾的数据去掉
                    return !s.endsWith("b");
                }
            })
            .take(3)//取3个数据
            .subscribe(new Action1<String>() {
                @Override
                public void call(String s) {
                    Log.e(tag,s);
                }
        });
    Log.e(tag,"---------skip & first----------");
    observable
            .skip(3)
            .first()
            .subscribe(new Action1<String>() {
                @Override
                public void call(String s) {
                    Log.e(tag,s);
                }
            });
}

运行结果

=====>: ------------test10-----------
        ----------操作符---------
=====>: ---------filter & take----------
=====>: aa
=====>: cc
=====>: dd
=====>: ---------skip & first----------
=====>: cc

类似的这种简单的操作符还有:

last() 取最后一个
distinct() 去除重复的
skipLast() 去除最后一个
takeLast(count) 取最后count个
limit(count) 限制个数
doOnNext(Action1) 允许我们在每次输出一个元素之前做一些额外的事情,比如保存起来。

还有好多,这只是简单的介绍一下,在RxJava操作符专题中有详解

9、RxLifecycle

我们上面提到了反注册来防止内存泄露,但是反注册需要我们自己动手写,而使用Rxlifecycle就可以帮助我们将反注册绑定到activity或者fragment的生命周期中,在他们的生命周期中自动去解绑。

使用方法

添加依赖,有最新的依赖,但是下面的比较稳定编译也能通过

compile 'com.trello:rxlifecycle:0.3.1'
compile 'com.trello:rxlifecycle-components:0.3.1'

Activity/Fragment需继承RxAppCompatActivity/RxFragment,目前支持的有RxAppCompatActivity、RxFragment、RxDialogFragment、RxFragmentActivity

绑定生命周期的时候可调用的方法:

bindToLifecycle()
bindUntilEvent()

例子

public class MainActivity extends RxAppCompatActivity {

    private static final String TAG = "=====>";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Log.e(TAG, "onCreate()");
        setContentView(R.layout.activity_main);
        Observable.interval(1, TimeUnit.SECONDS)
                .doOnUnsubscribe(new Action0() {
                    @Override
                    public void call() {
                        Log.e(TAG, "Unsubscribing subscription from onCreate()");
                    }
                })
                .compose(this.<Long>bindUntilEvent(ActivityEvent.PAUSE))
                .subscribe(new Action1<Long>() {
                    @Override
                    public void call(Long num) {
                        Log.e(TAG, "Started in onCreate(), running until onPause(): " + num);
                    }
                });
    }
    @Override
    protected void onStart() {
        super.onStart();
        Log.e(TAG, "onStart()");
        // Using automatic unsubscription, this should determine that the correct time to
        // unsubscribe is onStop (the opposite of onStart).
        Observable.interval(1, TimeUnit.SECONDS)
                .doOnUnsubscribe(new Action0() {
                    @Override
                    public void call() {
                        Log.e(TAG, "Unsubscribing subscription from onStart()");
                    }
                })
                .compose(this.<Long>bindToLifecycle())
                .subscribe(new Action1<Long>() {
                    @Override
                    public void call(Long num) {
                        Log.e(TAG, "Started in onStart(), running until in onStop(): " + num);
                    }
                });
    }
    @Override
    protected void onResume() {
        super.onResume();
        Log.e(TAG, "onResume()");
        // `this.<Long>` is necessary if you're compiling on JDK7 or below.
        //
        // If you're using JDK8+, then you can safely remove it.
        Observable.interval(1, TimeUnit.SECONDS)
                .doOnUnsubscribe(new Action0() {
                    @Override
                    public void call() {
                        Log.e(TAG, "Unsubscribing subscription from onResume()");
                    }
                })
                .compose(this.<Long>bindUntilEvent(ActivityEvent.DESTROY))
                .subscribe(new Action1<Long>() {
                    @Override
                    public void call(Long num) {
                        Log.e(TAG, "Started in onResume(), running until in onDestroy(): " + num);
                    }
                });
    }
    @Override
    protected void onPause() {
        super.onPause();
        Log.e(TAG, "onPause()");
    }
    @Override
    protected void onStop() {
        super.onStop();
        Log.e(TAG, "onStop()");
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        Log.e(TAG, "onDestroy()");
    }
}

打开activity,两秒后关闭,这样每一个Observable发送两个事件

运行结果

=====>: onCreate()
=====>: onStart()
=====>: onResume()
=====>: Started in onCreate(), running until onPause(): 0
=====>: Started in onStart(), running until in onStop(): 0
=====>: Started in onResume(), running until in onDestroy(): 0
=====>: Started in onCreate(), running until onPause(): 1
=====>: Started in onStart(), running until in onStop(): 1
=====>: Started in onResume(), running until in onDestroy(): 1
=====>: Unsubscribing subscription from onCreate()
=====>: onPause()
=====>: Unsubscribing subscription from onStart()
=====>: onStop()
=====>: Unsubscribing subscription from onResume()

关闭activity后,可以看出每一个Observable对应的注册者在相应的生命周期函数中反注册。 bindUntilEvent()方法需要传入要绑定的生命周期。使用ActivityEvent类,其中的CREATE、START、 RESUME、PAUSE、STOP、 DESTROY分别对应生命周期内的方法。使用bindUntilEvent指定在哪个生命周期方法调用时取消订阅

bindToLifecycle()方法完成Observable发布的事件和当前的组件绑定,实现生命周期同步。从而实现当前组件生命周期结束时,自动取消对Observable订阅。


10、RxBinding

RxBinding是Rx中处理控件异步调用的方式, 也是由Square公司开发, Jake负责编写. 通过绑定组件, 异步获取事件, 并进行处理。

使用

关联

compile 'com.jakewharton.rxbinding:rxbinding:0.4.0'
compile 'com.jakewharton.rxbinding:rxbinding-support-v4:0.4.0'

实例

  <?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:orientation="vertical"
    tools:context="cn.domob.android.rxjava_android.MainActivity">

    <TextView
        android:id="@+id/tv_main"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Hello World!" />
    <Button
        android:id="@+id/bt_main_01"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="改变字体颜色"/>
    <Button
        android:id="@+id/bt_main_02"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="长按弹toast"/>

    <EditText
        android:id="@+id/et_main"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:hint="搜索"/>
    <ListView
        android:id="@+id/lv_main"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>
</LinearLayout>

public class MainActivity extends RxAppCompatActivity {

    private static final String TAG = "=====>";
    @InjectView(R.id.tv_main)
    TextView tv;
    @InjectView(R.id.bt_main_01)
    Button bt01;
    @InjectView(R.id.bt_main_02)
    Button bt02;
    @InjectView(R.id.et_main)
    EditText et;
    @InjectView(R.id.lv_main)
    ListView lv;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.inject(this);
        //单机事件
        RxView.clicks(bt01).subscribe(new Action1<Void>() {
            @Override
            public void call(Void aVoid) {
                tv.setTextColor(Color.parseColor("#ff0000"));
            }
        });
        //长按事件
        RxView.longClicks(bt02).subscribe(new Action1<Void>() {
            @Override
            public void call(Void aVoid) {
                Toast.makeText(MainActivity.this, "hahha", Toast.LENGTH_SHORT).show();     
            }
        });
        //防止连续点击
        RxView.clicks(bt02).throttleFirst(5, TimeUnit.SECONDS).subscribe(new Action1<Void>() {
            @Override
            public void call(Void aVoid) {
                Toast.makeText(MainActivity.this, "防止多次连续点击", Toast.LENGTH_SHORT).show();
            }
        });

        //完成关键词联想功能,debounce()在一定的时间内没有操作就会发送事件,显示关键词
        final ArrayAdapter<String> adapter = new ArrayAdapter<>(this, android.R.layout.simple_expandable_list_item_1);
        lv.setAdapter(adapter);
        RxTextView.textChanges(et)
                .debounce(600,TimeUnit.MILLISECONDS)
                .map(new Func1<CharSequence, String>() {
                    @Override
                    public String call(CharSequence charSequence) {
                        return charSequence.toString();
                    }
                })
                .map(new Func1<String, List<String>>() {
                    @Override
                    public List<String> call(String key) {
                        ArrayList<String> arrayList = new ArrayList<>();
                        if(!TextUtils.isEmpty(key)){
                            for (int i = 0; i < getdata().size(); i++) {
                                if(getdata().get(i).contains(key))
                                    arrayList.add(getdata().get(i));
                            }
                        }
                        return arrayList;
                    }
                })
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Action1<List<String>>() {
                    @Override
                    public void call(List<String> strings) {
                        adapter.clear();
                        adapter.addAll(strings);
                        adapter.notifyDataSetChanged();
                    }
                });

        RxAdapterView.itemClicks(lv).subscribe(new Action1<Integer>() {
            @Override
            public void call(Integer integer) {
                et.setText(adapter.getItem(integer));
            }
        });

    }

    public List<String> getdata(){
        return Arrays.asList("abc","abddfds","123","124567","1278934","adfghjl","!@#45d","响应式编程");
    }
}