RxAndroid使用方法介紹

熟悉RxAndroid的使用方法.

要點包含:
(1) 鏈式表達式的使用方式.
(2) Lambda的應用.
(3) Rx處理網絡請求.
(4) 線程自動管理, 防止內存洩露.

GitHub下載地址.

1. 基礎

當然, 從一個嶄新的HelloWorld項目開始.

添加Gradle配置.

    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表達式, 是寫出優雅代碼的關鍵, 參考.

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.

/**
 * 主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中, 創建一個觀察者, 收到字符串的返回.

    // 觀察事件發生
    Observable.OnSubscribe mObservableAction = new Observable.OnSubscribe() {
        @Override public void call(Subscriber  subscriber) {
            subscriber.onNext(sayMyName()); // 發送事件
            subscriber.onCompleted(); // 完成事件
        }
    };

...

    // 創建字符串
    private String sayMyName() {
        return "Hello, I am your friend, Spike!";
    }

創建兩個訂閱者, 使用字符串輸出信息.

    // 訂閱者, 接收字符串, 修改控件
    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(), 再傳遞給訂閱者, 由訂閱者最終處理消息. 接收信息可以是同步, 也可以是異步.

    @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使用.

2. 更多

我們已經熟悉了初步的使用方式, 在接著學習一些其他方法, 如

just: 獲取輸入數據, 直接分發, 更加簡潔, 省略其他回調.
from: 獲取輸入數組, 轉變單個元素分發.
map: 映射, 對輸入數據進行轉換, 如大寫.
flatMap: 增大, 本意就是增肥, 把輸入數組映射多個值, 依次分發.
reduce: 簡化, 正好相反, 把多個數組的值, 組合成一個數據.

來看看這個示例, 設置兩個不同類型數組, 作為輸入源, 根據不同情況分發數據.

/**
 * 更多的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, Observable> mOneLetterFunc = new Func1, Observable>() { @Override public Observable call(List strings) { return Observable.from(strings); // 映射字符串 } }; // 設置大寫字母 private Func1 mUpperLetterFunc = new Func1() { @Override public String call(String s) { return s.toUpperCase(); // 大小字母 } }; // 連接字符串 private Func2 mMergeStringFunc = new Func2() { @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異常即可, 因此流僅僅關注真正需要的部分.

輸入字符串, 變換大寫, 輸出至控件中顯示.

        // 添加字符串, 省略Action的其他方法, 只使用一個onNext.
        Observable obShow = Observable.just(sayMyName());

        // 先映射, 再設置TextView
        obShow.observeOn(AndroidSchedulers.mainThread())
                .map(mUpperLetterFunc).subscribe(mTextViewAction);

just可以非常簡單的獲取任何數據, 分發時, 選擇使用的線程.
map是對輸入數據加工, 轉換類型, 輸入Func1, 准換大寫字母.
Func1代表使用一個參數的函數, 前面是參數, 後面是返回值.
Action1代表最終動作, 因而不需要返回值, 並且一個參數.

輸入數組, 單獨分發數組中每一個元素, 轉換大寫, 輸入Toast連續顯示.

        // 單獨顯示數組中的每個元素
        Observable obMap = Observable.from(mManyWords);

        // 映射之後分發
        obMap.observeOn(AndroidSchedulers.mainThread())
                .map(mUpperLetterFunc).subscribe(mToastAction);

from是讀取數組中的值, 每次單獨分發, 並分發多次, 其余類似.

輸入數組, 映射為單獨分發, 並組合到一起, 集中顯示.

        // 優化過的代碼, 直接獲取數組, 再分發, 再合並, 再顯示toast, Toast順次執行.
        Observable.just(mManyWordList)
                .observeOn(AndroidSchedulers.mainThread())
                .flatMap(mOneLetterFunc)
                .reduce(mMergeStringFunc)
                .subscribe(mToastAction);

這次是使用just分發數組, 則分發數據就是數組, 並不是數組中的元素.
flatMap把數組轉換為單獨分發, Func1內部使用from拆分數組.
reduce把單獨分發數據集中到一起, 再統一分發, 使用Func2.
最終使用Action1顯示獲得數據. 本次代碼也更加簡潔.

由此我們可以觀察到, Rx的寫法可以是多種多樣, 合理的寫法會更加優雅.

效果

3. Lambda

Lambda表達式和Rx非常契合, 可以省略大量的內部類, 如Func和Action.
我們把上個示例, 用Lambda再寫一次, 功能相同.

/**
 * 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表達式相同時, 使用方法名代替.

4. 網絡請求

Retrofit是網絡請求庫, 剛推出2.0版本. Rx的一個核心應用就是處理異步網絡請求, 結合Retrofit, 會更加方便和簡潔. 參考.

引入庫

    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的用戶信息.

/**
 * 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類和數據類.

/**
 * 顯示列表
 * 

* Created by wangchenlong on 15/12/31. */ public class UserListAdapter extends RecyclerView.Adapter { 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“服務, 通過服務獲取數據, 再依次分發給適配器.

/**
 * 用戶獲取類
 * 

* Created by wangchenlong on 15/12/31. */ public class NetworkWrapper { private static final String[] mFamousUsers = {"SpikeKing", "JakeWharton", "rock3r", "Takhion", "dextorer", "Mariuxtheone"}; // 獲取用戶信息 public static void getUsersInto(final UserListAdapter adapter) { GitHubService gitHubService = ServiceFactory.createServiceFrom(GitHubService.class, GitHubService.ENDPOINT); Observable.from(mFamousUsers) .flatMap(gitHubService::getUserData) .subscribeOn(Schedulers.newThread()) .observeOn(AndroidSchedulers.mainThread()) .subscribe(adapter::addUser); } // 獲取庫信息 public static void getReposInfo(final String username, final RepoListAdapter adapter) { GitHubService gitHubService = ServiceFactory.createServiceFrom(GitHubService.class, GitHubService.ENDPOINT); gitHubService.getRepoData(username) .flatMap(Observable::from) .subscribeOn(Schedulers.newThread()) .observeOn(AndroidSchedulers.mainThread()) .subscribe(adapter::addRepo); } }

網絡請求無法在主線程上執行, 需要啟動異步線程, 如Schedulers.newThread().
使用工廠模式ServiceFactory創建服務, 也可以單獨創建服務.

創建Retrofit服務的工廠類.

/**
 * 工廠模式
 * 

* Created by wangchenlong on 15/12/31. */ public class ServiceFactory { public static T createServiceFrom(final Class serviceClass, String endpoint) { Retrofit adapter = new Retrofit.Builder() .baseUrl(endpoint) .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 添加Rx適配器 .addConverterFactory(GsonConverterFactory.create()) // 添加Gson轉換器 .build(); return adapter.create(serviceClass); } }

這是Retrofit 2.0的寫法, 注意需要添加Rx和Gson的解析.

設置網絡請求的Url.

/**
 * GitHub的服務
 * 

* Created by wangchenlong on 15/12/31. */ public interface GitHubService { String ENDPOINT = "https://api.github.com"; // 獲取個人信息 @GET("/users/{user}") Observable getUserData(@Path("user") String user); // 獲取庫, 獲取的是數組 @GET("/users/{user}/repos") Observable getRepoData(@Path("user") String user); }

顯示用戶

詳情頁面與主頁類似, 參考代碼, 不做細說.

5. 線程安全

Rx的好處之一就是可以防止內存洩露, 即根據頁面生命周期, 處理異步線程的結束. 可以使用RxLifecycle庫處理生命周期.

Activity類繼承RxAppCompatActivity, 替換AppCompatActivity.

啟動一個循環線程.

/**
 * Rx的線程安全
 * 

* Created by wangchenlong on 15/12/31. */ public class SafeActivity extends RxAppCompatActivity { private static final String TAG = "DEBUG-WCL: " + SafeActivity.class.getSimpleName(); @Bind(R.id.simple_tv_text) TextView mTvText; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_simple); ButterKnife.bind(this); Observable.interval(1, TimeUnit.SECONDS) .observeOn(AndroidSchedulers.mainThread()) .compose(bindToLifecycle()) // 管理生命周期, 防止內存洩露 .subscribe(this::showTime); } private void showTime(Long time) { mTvText.setText(String.valueOf("時間計數: " + time)); Log.d(TAG, "時間計數器: " + time); } @Override protected void onPause() { super.onPause(); Log.w(TAG, "頁面關閉!"); } }

繼承RxAppCompatActivity, 添加bindToLifecycle方法管理生命周期. 當頁面onPause時, 會自動結束循環線程. 如果注釋這句代碼, 則會導致內存洩露.

OK, That’s all! Enjoy It!