详细解析 RxAndroid 的使用方式

原文出处：  C.L. Wang（@SpikeKing ）   

RxAndroid是RxJava的扩展, 优雅地处理异步请求. RxAndroid配合Lambda表达式, 精简处理回调, 使程序更具有可读性. Rx作为Android最优秀的开源库之一, 极大地提高生产力, 我们需要掌握. 本文由浅入深, 介绍一些常见的使用方法, 并附有源码.

更多: http://www.wangchenlong.org/

本文代码的GitHub下载地址.

要点包含:
(1) 链式表达式的使用方式.
(2) Lambda的应用.
(3) Rx处理网络请求.
(4) 线程自动管理, 防止内存泄露.
(5) RxBinding绑定控件的异步事件.

基础

当然, 从一个崭新的HelloWorld项目开始.

添加Gradle配置.

Java

1 2 3

compile 'com.jakewharton:butterknife:7.0.1' compile 'io.reactivex:rxandroid:1.1.0' // RxAndroid compile 'io.reactivex:rxjava:1.1.0' // 推荐同时加载RxJava

RxAndroid是本文的核心依赖, 同时添加RxJava. 还有ButterKnife注解库.

Lambda表达式, 是写出优雅代码的关键, 参考.

Java

1 2 3 4 5 6 7 8 9 10 11 12

plugins {      id "me.tatarka.retrolambda" version "3.2.4" }   android { . . .        compileOptions {          sourceCompatibility JavaVersion . VERSION_1_8          targetCompatibility JavaVersion . VERSION_1 _8      } }

Gradle 2.1+以上, 配置非常简单, 添加一个plugin和一个Java1.8兼容即可.

从主MainActivity跳转至SimpleActivity.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

/** * 主Activity, 用于跳转各个模块. * * @author wangchenlong */ public class MainActivity extends AppCompatActivity {        @Override      protected void onCreate ( Bundle savedInstanceState ) {          super . onCreate ( savedInstanceState ) ;          setContentView ( R . layout . activity_main ) ;      }        // 跳转简单的页面      public void gotoSimpleModule ( View view ) {          startActivity ( new Intent ( this , SimpleActivity . class ) ) ;      }        // 跳转复杂的页面      public void gotoMoreModule ( View view ) {          startActivity ( new Intent ( this , MoreActivity . class ) ) ;      }        // 跳转Lambda的页面      public void gotoLambdaModule ( View view ) {          startActivity ( new Intent ( this , LambdaActivity . class ) ) ;      }        // 跳转网络的页面      public void gotoNetworkModule ( View view ) {          startActivity ( new Intent ( this , NetworkActivity . class ) ) ;      }        // 跳转线程安全的页面      public void gotoSafeModule ( View view ) {          startActivity ( new Intent ( this , SafeActivity . class ) ) ;      } }

在SimpleActivity中, 创建一个观察者, 收到字符串的返回.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14

// 观察事件发生      Observable . OnSubscribe mObservableAction = new Observable . OnSubscribe ( ) {          @Override public void call ( Subscriber < ? super String > subscriber ) {              subscriber . onNext ( sayMyName ( ) ) ; // 发送事件              subscriber . onCompleted ( ) ; // 完成事件          }      } ;   . . .        // 创建字符串      private String sayMyName ( ) {          return "Hello, I am your friend, Spike!" ;      }

创建两个订阅者, 使用字符串输出信息.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

// 订阅者, 接收字符串, 修改控件 Subscriber mTextSubscriber = new Subscriber ( ) {      @Override public void onCompleted ( ) {        }        @Override public void onError ( Throwable e ) {        }        @Override public void onNext ( String s ) {          mTvText . setText ( s ) ; // 设置文字      } } ;   // 订阅者, 接收字符串, 提示信息 Subscriber mToastSubscriber = new Subscriber ( ) {      @Override public void onCompleted ( ) {        }        @Override public void onError ( Throwable e ) {        }        @Override public void onNext ( String s ) {          Toast . makeText ( SimpleActivity . this , s , Toast . LENGTH_SHORT ) . show ( ) ;      } } ;

在页面中, 观察者接收信息, 发送至主线程AndroidSchedulers.mainThread(), 再传递给订阅者, 由订阅者最终处理消息. 接收信息可以是同步, 也可以是异步.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14

@Override protected void onCreate ( Bundle savedInstanceState ) {      super . onCreate ( savedInstanceState ) ;      setContentView ( R . layout . activity_simple ) ;      ButterKnife . bind ( this ) ;        // 注册观察活动      @SuppressWarnings ( "unchecked" )      Observable observable = Observable . create ( mObservableAction ) ;        // 分发订阅信息      observable . observeOn ( AndroidSchedulers . mainThread ( ) ) ;      observable . subscribe ( mTextSubscriber ) ;      observable . subscribe ( mToastSubscriber ) ; }

最基础的RxAndroid使用.

更多

我们已经熟悉了初步的使用方式, 在接着学习一些其他方法, 如

just: 获取输入数据, 直接分发, 更加简洁, 省略其他回调.
from: 获取输入数组, 转变单个元素分发.
map: 映射, 对输入数据进行转换, 如大写.
flatMap: 增大, 本意就是增肥, 把输入数组映射多个值, 依次分发.
reduce: 简化, 正好相反, 把多个数组的值, 组合成一个数据.

来看看这个示例, 设置两个不同类型数组, 作为输入源, 根据不同情况分发数据.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

/** * 更多的RxAndroid的使用方法. * * Created by wangchenlong on 15/12/30. */ public class MoreActivity extends Activity {        @Bind ( R . id . simple_tv_text ) TextView mTvText ;        final String [ ] mManyWords = { "Hello" , "I" , "am" , "your" , "friend" , "Spike" } ;      final List mManyWordList = Arrays . asList ( mManyWords ) ;        // Action类似订阅者, 设置TextView      private Action1 mTextViewAction = new Action1 ( ) {          @Override public void call ( String s ) {              mTvText . setText ( s ) ;          }      } ;        // Action设置Toast      private Action1 mToastAction = new Action1 ( ) {          @Override public void call ( String s ) {              Toast . makeText ( MoreActivity . this , s , Toast . LENGTH_SHORT ) . show ( ) ;          }      } ;        // 设置映射函数      private Func1 < List , Observable > mOneLetterFunc = new Func1 < List , Observable > ( ) {          @Override public Observable call ( List strings ) {              return Observable . from ( strings ) ; // 映射字符串          }      } ;        // 设置大写字母      private Func1 < String , String > mUpperLetterFunc = new Func1 < String , String > ( ) {          @Override public String call ( String s ) {              return s . toUpperCase ( ) ; // 大小字母          }      } ;        // 连接字符串      private Func2 < String , String , String > mMergeStringFunc = new Func2 < String , String , String > ( ) {          @Override public String call ( String s , String s2 ) {              return String . format ( "%s %s" , s , s2 ) ; // 空格连接字符串          }      } ;        @Override      protected void onCreate ( Bundle savedInstanceState ) {          super . onCreate ( savedInstanceState ) ;          setContentView ( R . layout . activity_simple ) ;          ButterKnife . bind ( this ) ;            // 添加字符串, 省略Action的其他方法, 只使用一个onNext.          Observable obShow = Observable . just ( sayMyName ( ) ) ;            // 先映射, 再设置TextView          obShow . observeOn ( AndroidSchedulers . mainThread ( ) )                  . map ( mUpperLetterFunc ) . subscribe ( mTextViewAction ) ;            // 单独显示数组中的每个元素          Observable obMap = Observable . from ( mManyWords ) ;            // 映射之后分发          obMap . observeOn ( AndroidSchedulers . mainThread ( ) )                  . map ( mUpperLetterFunc ) . subscribe ( mToastAction ) ;            // 优化过的代码, 直接获取数组, 再分发, 再合并, 再显示toast, Toast顺次执行.          Observable . just ( mManyWordList )                  . observeOn ( AndroidSchedulers . mainThread ( ) )                  . flatMap ( mOneLetterFunc )                  . reduce ( mMergeStringFunc )                  . subscribe ( mToastAction ) ;      }        // 创建字符串      private String sayMyName ( ) {          return "Hello, I am your friend, Spike!" ;      } }

这次简化调用代码, 因为有时候我们对异常并不是很关心,
只要能catch异常即可, 因此流仅仅关注真正需要的部分.

输入字符串, 变换大写, 输出至控件中显示.

Java

1 2 3 4 5 6

// 添加字符串, 省略Action的其他方法, 只使用一个onNext. Observable obShow = Observable . just ( sayMyName ( ) ) ;   // 先映射, 再设置TextView obShow . observeOn ( AndroidSchedulers . mainThread ( ) )          . map ( mUpperLetterFunc ) . subscribe ( mTextViewAction ) ;

just可以非常简单的获取任何数据, 分发时, 选择使用的线程.
map是对输入数据加工, 转换类型, 输入Func1, 准换大写字母.
Func1代表使用一个参数的函数, 前面是参数, 后面是返回值.
Action1代表最终动作, 因而不需要返回值, 并且一个参数.

输入数组, 单独分发数组中每一个元素, 转换大写, 输入Toast连续显示.

Java

1 2 3 4 5 6

// 单独显示数组中的每个元素 Observable obMap = Observable . from ( mManyWords ) ;   // 映射之后分发 obMap . observeOn ( AndroidSchedulers . mainThread ( ) )          . map ( mUpperLetterFunc ) . subscribe ( mToastAction ) ;

from是读取数组中的值, 每次单独分发, 并分发多次, 其余类似.

输入数组, 映射为单独分发, 并组合到一起, 集中显示.

Java

1 2 3 4 5 6

// 优化过的代码, 直接获取数组, 再分发, 再合并, 再显示toast, Toast顺次执行. Observable . just ( mManyWordList )          . observeOn ( AndroidSchedulers . mainThread ( ) )          . flatMap ( mOneLetterFunc )          . reduce ( mMergeStringFunc )          . subscribe ( mToastAction ) ;

这次是使用just分发数组, 则分发数据就是数组, 并不是数组中的元素.
flatMap把数组转换为单独分发, Func1内部使用from拆分数组.
reduce把单独分发数据集中到一起, 再统一分发, 使用Func2.
最终使用Action1显示获得数据. 本次代码也更加简洁.

由此我们可以观察到, Rx的写法可以是多种多样, 合理的写法会更加优雅.

效果

Lambda

Lambda表达式和Rx非常契合, 可以省略大量的内部类, 如Func和Action.
我们把上个示例, 用Lambda再写一次, 功能相同.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

/** * Lambda表达式写法 * * Created by wangchenlong on 15/12/31. */ public class LambdaActivity extends Activity {        @Bind ( R . id . simple_tv_text ) TextView mTvText ;        final String [ ] mManyWords = { "Hello" , "I" , "am" , "your" , "friend" , "Spike" } ;      final List mManyWordList = Arrays . asList ( mManyWords ) ;        @Override protected void onCreate ( Bundle savedInstanceState ) {          super . onCreate ( savedInstanceState ) ;          setContentView ( R . layout . activity_simple ) ;          ButterKnife . bind ( this ) ;            // 添加字符串, 省略Action的其他方法, 只使用一个onNext.          Observable obShow = Observable . just ( sayMyName ( ) ) ;            // 先映射, 再设置TextView          obShow . observeOn ( AndroidSchedulers . mainThread ( ) )                  . map ( String :: toUpperCase ) . subscribe ( mTvText :: setText ) ;            // 单独显示数组中的每个元素          Observable obMap = Observable . from ( mManyWords ) ;            // 映射之后分发          obMap . observeOn ( AndroidSchedulers . mainThread ( ) )                  . map ( String :: toUpperCase )                  . subscribe ( this :: showToast ) ;            // 优化过的代码, 直接获取数组, 再分发, 再合并, 再显示toast, Toast顺次执行.          Observable . just ( mManyWordList )                  . observeOn ( AndroidSchedulers . mainThread ( ) )                  . flatMap ( Observable :: from )                  . reduce ( this :: mergeString )                  . subscribe ( this :: showToast ) ;      }        // 创建字符串      private String sayMyName ( ) {          return "Hello, I am your friend, Spike!" ;      }        // 显示Toast      private void showToast ( String s ) {          Toast . makeText ( LambdaActivity . this , s , Toast . LENGTH_SHORT ) . show ( ) ;      }        // 合并字符串      private String mergeString ( String s1 , String s2 ) {          return String . format ( "%s %s" , s1 , s2 ) ;      } }

这次没有使用常规的Lambda表达式, 而是更简单的方法引用(Method References).
方法引用: 方法参数和返回值与Lambda表达式相同时, 使用方法名代替.

网络请求

Retrofit是网络请求库, 刚推出2.0版本. Rx的一个核心应用就是处理异步网络请求, 结合Retrofit, 会更加方便和简洁. 参考.

引入库

Java

1 2 3 4 5 6 7

compile 'com.android.support:recyclerview-v7:23.1.1' // RecyclerView   compile 'com.squareup.retrofit:retrofit:2.0.0-beta2' // Retrofit网络处理 compile 'com.squareup.retrofit:adapter-rxjava:2.0.0-beta2' // Retrofit的rx解析库 compile 'com.squareup.retrofit:converter-gson:2.0.0-beta2' // Retrofit的gson库   compile 'com.squareup.picasso:picasso:2.5.2' // Picasso网络图片加载

recyclerview和picasso为了显示. retrofit系列是网络请求.

主页使用一个简单的列表视图, 展示Github的用户信息.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

/** * Rx的网络请求方式 * * Created by wangchenlong on 15/12/31. */ public class NetworkActivity extends Activity {        @Bind ( R . id . network_rv_list ) RecyclerView mRvList ; // 列表        @Override protected void onCreate ( Bundle savedInstanceState ) {          super . onCreate ( savedInstanceState ) ;          setContentView ( R . layout . activity_network ) ;          ButterKnife . bind ( this ) ;            // 设置Layout管理器          LinearLayoutManager layoutManager = new LinearLayoutManager ( this ) ;          layoutManager . setOrientation ( LinearLayoutManager . VERTICAL ) ;          mRvList . setLayoutManager ( layoutManager ) ;            // 设置适配器          UserListAdapter adapter = new UserListAdapter ( this :: gotoDetailPage ) ;          NetworkWrapper . getUsersInto ( adapter ) ;          mRvList . setAdapter ( adapter ) ;      }        // 点击的回调      public interface UserClickCallback {          void onItemClicked ( String name ) ;      }        // 跳转到库详情页面      private void gotoDetailPage ( String name ) {          startActivity ( NetworkDetailActivity . from ( NetworkActivity . this , name ) ) ;      } }

在列表中提供点击用户信息跳转至用户详情.
NetworkWrapper.getUsersInto(adapter) 请求网络, 设置适配器信息.

关键部分, 适配器, 其中包含ViewHolder类和数据类.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

/** * 显示列表 * * Created by wangchenlong on 15/12/31. */ public class UserListAdapter extends RecyclerView . Adapter < UserListAdapter . UserViewHolder > {        private List mUsers ; // 用户名集合        private NetworkActivity . UserClickCallback mCallback ; // 用户点击项的回调        public UserListAdapter ( NetworkActivity . UserClickCallback callback ) {          mUsers = new ArrayList <> ( ) ;          mCallback = callback ;      }        public void addUser ( GitHubUser user ) {          mUsers . add ( user ) ;          notifyItemInserted ( mUsers . size ( ) - 1 ) ; // 最后一位      }        @Override public UserViewHolder onCreateViewHolder ( ViewGroup parent , int viewType ) {          View item = LayoutInflater . from ( parent . getContext ( ) )                  . inflate ( R . layout . item_network_user , parent , false ) ;          return new UserViewHolder ( item , mCallback ) ;      }        @Override public void onBindViewHolder ( UserViewHolder holder , int position ) {          holder . bindTo ( mUsers . get ( position ) ) ;      }        @Override public int getItemCount ( ) {          return mUsers . size ( ) ;      }        // Adapter的ViewHolder      public static class UserViewHolder extends RecyclerView . ViewHolder {            @Bind ( R . id . network_item_iv_user_picture ) ImageView mIvUserPicture ;          @Bind ( R . id . network_item_tv_user_name ) TextView mTvUserName ;          @Bind ( R . id . network_item_tv_user_login ) TextView mTvUserLogin ;          @Bind ( R . id . network_item_tv_user_page ) TextView mTvUserPage ;            public UserViewHolder ( View itemView , NetworkActivity . UserClickCallback callback ) {              super ( itemView ) ;              ButterKnife . bind ( this , itemView ) ;              // 绑定点击事件              itemView . setOnClickListener ( v ->                      callback . onItemClicked ( mTvUserLogin . getText ( ) . toString ( ) ) ) ;          }            // 绑定数据          public void bindTo ( GitHubUser user ) {              mTvUserName . setText ( user . name ) ;              mTvUserLogin . setText ( user . login ) ;              mTvUserPage . setText ( user . repos_url ) ;                Picasso . with ( mIvUserPicture . getContext ( ) )                      . load ( user . avatar_url )                      . placeholder ( R . drawable . ic_person_black_24dp )                      . into ( mIvUserPicture ) ;          }      }        // 用户类, 名称必须与Json解析相同      public static class GitHubUser {          public String login ;          public String avatar_url ;          public String name ;          public String repos_url ;      } }

添加数据addUser, 其中notifyItemInserted通知更新.
可以自动生成Json解析类的网站.

首先创建Retrofit`服务, 通过服务获取数据, 再依次分发给适配器.

Java

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

/** * 用户获取类 * * Created by wangchenlong on 15/12/31. */ public class NetworkWrapper {      private static final String