RxJava開發精要8 – 與REST無縫結合-RxJava和Retrofit

• 原文出自《RxJava Essentials》
• 原文做者 : Ivan Morgillo
• 譯文出自 : 開發技術前線 www.devtf.cn
• 轉載聲明: 本譯文已受權開發者頭條享有獨家轉載權，未經容許，不得轉載!
• 譯者 : yuxingxin
• 項目地址 : RxJava-Essentials-CN

在上一章中，咱們學習瞭如何使用調度器在不一樣於UI線程的線程上操做。咱們學習瞭如何高效的運行I/O任務而不用阻塞UI以及如何運行耗時的計算任務而不耗損應用性能。在最後一章中，咱們將建立一個最終版的真實世界的例子，用Retrofit映射到遠程的API,異步的查詢數據，從而不費力的創造一個豐富的UI。

項目目標

咱們將在已存在的例子中建立一個新的Activity。這個Activity將會使用StackExchange API從stackoverflow檢索最活躍的10位用戶。使用這個信息，App將會展現一個用戶的頭像，姓名，名望數以及住址列表。對於每一位用戶，app將會使用其居住城市和OpenWeatherMap API 來檢索當地的天氣預報，並展現一個小的天氣圖標。基於從StackOverflow檢索的信息，app對列表的每一位用戶將會提供一個onClick事件，它將會打開他們在我的信息中指定的我的網站或者打開Stack Overflow的我的主頁。

Retrofit

Retrofit是Square公司專爲Android和Java設計的一個類型安全的REST客戶端。它幫助你很容易的和任何REST API交互，它完美的集成R小Java：全部的JSON響應對象都被映射成原始的Java對象，而且全部的網絡調用都基於Rxjava Observable這些對象。

使用API文檔，咱們能夠定義咱們從服務器接收的JSON響應數據。爲了很容易的將JSON響應數據映射爲咱們的Java代碼，咱們將使用jsonschema2pojo(http://www.jsonschema2pojo.org)，這個靈活的服務將會生成咱們所須要映射JSON響應數據的全部Java類。

當咱們把全部的Java model準備好後，咱們就能夠開始創建Retrofit。Retrofi使用標準的Java接口來映射API路由。例如例子中，咱們將使用來自API的一個路由，下面是咱們Retrofit的接口：

 

 

1 2 3 4 5

public interface StackExchangeService {     @GET("2.2users?order=desc&sort=reputation&site=stackoverflow")     Observable<User sResponse> getMostPopularSOusers(@Query("pagesize") int howmany); }

 

interface接口只包含一個方法，即getMostPopularSOusers。這個方法用整型howmany做爲一個參數並返回UserResponse的Observable。

當咱們有了interface，咱們能夠建立RestAdapter類，爲了更清楚的組織咱們的代碼，咱們建立一個SeApiManager函數提供一種更適當的方式來和StackExchange API交互。

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

public class SeApiManager {     private final StackExchangeService mStackExchangeService;       public SeApiManager() {         RestAdapter restAdapter = new RestAdapter.Builder()             .setEndpoint("https://api.stackexchange.com")             .setLogLevel(RestAdapter.LogLevel.BASIC)             .build();         mStackExchangeService = restAdapter.create(StackExchangeService.class); }   public Observable<List<User>> getMostPopularSOusers(int howmany) {     return mStackExchangeService     .getMostPopularSOusers(howmany)     .map(UsersResponse::getUsers)     .subscribeOn(Schedulers.io())     .observeOn(AndroidSchedulers.mainThread()); }

 

爲了簡化例子，咱們再也不將這個類設計爲它本應該設計爲的單例。使用依賴注入解決方案，如Dagger2將會使代碼質量更高。

建立RestAdapter類，咱們爲API客戶端創建了幾個重要的點。這個例子中，咱們設置endpoint和log level。因爲這個例子URL只是硬編碼，使用外部資源來像這樣存儲數據很重要。避免在代碼中硬編碼字符串是一個好的實踐。

Retrofit把RestAdapter類和咱們的API接口綁定在一塊兒後就建立結束。它返回給咱們一個對象用來查詢API。咱們能夠選擇直接暴露這個對象，或者以某種方式封裝依次來限制訪問它。在這個例子中，咱們封裝它並只暴露getMostPopularSOusers方法。這個方法執行查詢，讓Retrofit解析JSON響應數據。得到用戶列表，並返回給訂閱者。正如你看到的，使用Retrofit、RxJava和Retrolambda，咱們幾乎沒有模板代碼：它很是緊湊而且可讀性也高。

如今，咱們已經有一個API管理者來暴露一個響應式的方法，它從遠程API獲取到數據並給I/O調度器，解析映射最後提供給咱們的消費者一個簡潔的用戶列表。

App架構

咱們不使用任何MVC，MVP，或者MVVM模式。由於那不是這本書的目的，所以咱們的Activity類將包含咱們須要建立和展現用戶列表的全部邏輯。

建立Activity類

咱們將在onCreate()方法裏建立SwipeRefreshLayout和RecyclerView；咱們有一個refreshList()方法來處理用戶列表的獲取和展現，showRefreshing()方法來管理進度條和RecyclerView的顯示。

咱們的refreshList()函數看起來以下：

 

 

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

private void refreshList() {     showRefresh(true);     mSeApiManager.getMostPopularSOusers(10)         .subscribe(users -> {             showRefresh(false);             mAdapter.updateUsers(users);         }, error -> {             App.L.error(error.toString());             showRefresh(false);         }); }

 

咱們顯示了進度條，從StackExchange API 管理器觀測用戶列表。一旦獲取到列表數據，咱們開始展現它並更新Adapter的內容並讓RecyclerView顯示爲可見。

建立RecyclerView Adapter

咱們從REST API獲取到數據後，咱們須要把它綁定View上，並用一個適配器填充列表。咱們的RecyclerView適配器是標準的。它繼承於RecyclerView.Adapter並指定它本身的ViewHolder：

 

 

1 2 3 4 5 6 7 8 9 10 11

public static class ViewHolder extends RecyclerView.ViewHolder {     @InjectView(R.id.name) TextView name;     @InjectView(R.id.city) TextView city;     @InjectView(R.id.reputation) TextView reputation;     @InjectView(R.id.user_image) ImageView user_image;     public ViewHolder(View view) {         super(view);         ButterKnife.inject(this, view);     } }

 

咱們一旦收到來自API管理器的數據，咱們能夠設置界面上全部的標籤：name,city和reputation。

爲了展現用戶的頭像，咱們將使用Sergey Tarasevich (https://github.com/nostra13/Android-Universal- ImageLoader)寫的Universal Image Loader。UIL是很是有名的而且被測試出很好用的圖片管理庫。咱們也可使用Square公司的Picasso，Glide或者Facebook公司的Fresco。這只是根據你本身的愛好。重要的是無須重複造輪子：庫可以方便開發者的生活並讓他們更快速實現目標。

在咱們的適配器中，咱們能夠這樣：

 

 

1 2 3 4 5 6

@Override public void onBindViewHolder(SoAdapter.ViewHolder holder, int position) {     User user = mUsers.get(position);     holder.setUser(user); }

 

在ViewHolder，咱們能夠這樣：

 

 

1 2 3 4 5 6 7 8

public void setUser(User user) {     name.setText(user.getDisplayName());     city.setText(user.getLocation());     reputation.setText(String.valueOf(user.getReputation()));       ImageLoader.getInstance().displayImage(user.getProfileImage(), user_image); }

 

此時，咱們能夠容許代碼得到一個用戶列表，正以下圖所示：

檢索天氣預報

咱們加大難度，將當地城市的天氣加入列表中。OpenWeatherMap是一個靈活的web service公共API，咱們能夠查詢檢索許多有用的預報信息。

和往常同樣，咱們將使用Retrofit映射到API而後經過RxJava來訪問它。至於StackExchange API，咱們將建立interface，RestAdapter和一個靈活的管理器：

 

 

1 2 3 4 5

public interface OpenWeatherMapService {     @GET("data2.5/weather")     Observable<WeatherResponse> getForecastByCity(@Query("q") String city); }

 

這個方法用城市名字做爲參數提供當地的預報信息。咱們像下面這樣將接口和RestAdapter類綁定在一塊兒：

 

 

1 2 3 4 5 6

RestAdapter restAdapter = new RestAdapter.Builder()         .setEndpoint("http://api.openweathermap.org")         .setLogLevel(RestAdapter.LogLevel.BASIC)         .build(); mOpenWeatherMapService = restAdapter.create(OpenWeatherMapService.class);

 

像之前同樣，咱們只需設置API端口和log級別：咱們只須要立馬作的兩件事情。

OpenWeatherMapApiManager類將提供下面的方法：

 

 

1 2 3 4 5 6

public Observable<WeatherResponse> getForecastByCity(String city) {     return mOpenWeatherMapService.getForecastByCity(city)     .subscribeOn(Schedulers.io())     .observeOn(AndroidSchedulers.mainThread()); }

 

如今，咱們有了用戶列表，咱們能夠根據城市名來查詢OpenWeatherMap來接收天氣預報信息。下一步是修改咱們的ViewHolder類來爲每位用戶檢索和使用天氣預報信息從而根據狀態來展現天氣圖標。

咱們使用這些工具方法先驗證用戶主頁信息並得到一個合法的城市名字：

 

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

private boolean isCityValid(String location) {     int separatorPosition = getSeparatorPosition(location);     return !"".equals(location) && separatorPosition > -1; }   private int getSeparatorPosition(String location) {     int separatorPosition = -1;     if (location != null) {         separatorPosition = location.indexOf(",");     }     return separatorPosition; }   private String getCity(String location, int position) {     if (location != null) {         return location.substring(0, position);     } else {         return "";     } }

 

藉助一個有效的城市名，咱們能夠用下面命令來得到咱們所須要天氣的全部數據：

 

 

1 2	OpenWeatherMapApiManager.getInstance().getForecastByCity(city)

 

用天氣響應的結果，咱們能夠得到天氣圖標的URL：

 

 

1 2	getWeatherIconUrl(weatherResponse);

 

用圖標URL，咱們能夠檢索到圖標自己：

 

 

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

private Observable<Bitmap> loadBitmap(String url) {     return Observable.create(subscriber -> {         ImageLoader.getInstance().displayImage(url,city_image, new ImageLoadingListener() {             @Override             public void onLoadingStarted(String imageUri, View view) {             }               @Override             public void onLoadingFailed(String imageUri, View view, FailReason failReason) {                 subscriber.onError(failReason.getCause());             }               @Override             public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {                 subscriber.onNext(loadedImage);                 subscriber.onCompleted();             }               @Override             public void onLoadingCancelled(String imageUri, View view) {                 subscriber.onError(new Throwable("Image loading cancelled"));             }          });     }); }

 

這個loadBitmap()返回的Observable能夠連接前面一個，而且最後咱們能夠爲這個任務返回一個單獨的Observable：

 

 

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

if (isCityValid(location)) {     String city = getCity(location, separatorPosition);     OpenWeatherMapApiManager.getInstance().getForecastByCity(city)         .filter(response -> response != null)         .filter(response -> response.getWeather().size() > 0)         .flatMap(response -> {             String url = getWeatherIconUrl(response);             return loadBitmap(url);         })     .subscribeOn(Schedulers.io())     .observeOn(AndroidSchedulers.mainThread())     .subscribe(new Observer<Bitmap>() {           @Override         public void onCompleted() {         }           @Override         public void onError(Throwable e) {             App.L.error(e.toString());         }           @Override         public void onNext(Bitmap icon) {             city_image.setImageBitmap(icon);         }     }); }

 

運行代碼，咱們能夠在下面列表中爲每一個用戶得到新的天氣圖標：

打開網站

使用用戶主頁包含的信息，咱們將會建立一個onClick監聽器來導航到用戶web頁面，若是有，或者是Stack Overflow我的主頁。

爲了實現它，咱們簡單實現Activity類的接口，用來在適配器觸發Android的onClick事件。

咱們的Adapter ViewHolder指定這個接口：

 

 

1 2 3 4

public interface OpenProfileListener {     public void open(String url); }

 

Activity實現它：

 

 

1 2 3 4 5 6 7 8 9 10 11

[https://github.com/yuxingxin/RxJava-Essentials-CN/raw/master.] implements SoAdapter.ViewHolder.OpenProfileListener { [https://github.com/yuxingxin/RxJava-Essentials-CN/raw/master.]     mAdapter.setOpenProfileListener(this); [https://github.com/yuxingxin/RxJava-Essentials-CN/raw/master.]   @Override public void open(String url) {     Intent i = new Intent(Intent.ACTION_VIEW);     i.setData(Uri.parse(url));     startActivity(i); }

 

Activity收到URL並用外部Android瀏覽器打開它。咱們的ViewHolder負責在用戶列表的每一個卡片上建立OnClickListener並檢查咱們是打開Stack Overflow用戶主頁仍是外部我的站：

 

 

1 2 3 4 5 6 7 8 9 10 11

mView.setOnClickListener(view -> {     if (mProfileListener != null) {         String url = user.getWebsiteUrl();         if (url != null && !url.equals("") && !url.contains("search")) {             mProfileListener.open(url);         } else {             mProfileListener.open(user.getLink());         }     } )}；

 

一旦咱們點擊了，咱們將直接重定向到預期的網站。在Android上，咱們能夠用RxAndroid的一種特殊形式（ViewObservable）以更加響應式的方式實現一樣的結果。

 

 

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

ViewObservable.clicks(mView)     .subscribe(onClickEvent -> {     if (mProfileListener != null) {         String url = user.getWebsiteUrl();         if (url != null && !url.equals("") && !url.contains("search")) {             mProfileListener.open(url);         } else {             mProfileListener.open(user.getLink());         }     } });

 

上面兩塊代碼片斷是等價的，你能夠選擇你最喜歡的那一種方式。

總結

咱們的旅程結束了。你已經準備好將你的Java應用帶到一個新的代碼質量水平。你能夠享受一個新的編碼模式並用更流暢的思惟方式接觸你的平常編碼生活。RxJava提供這樣一種機會來以面向時間的方式考慮數據：全部事情都是持續可變的，數據在更新，事件在觸發，而後你能夠建立基於這些事件響應的，靈活的，運行流暢的App。

剛開始切換到RxJava看起來難而且耗時，可是咱們經歷瞭如何用響應式的方式有效地處理平常問題。如今你能夠把你的舊代碼遷移到RxJava上:給這些同步getters一種新的響應式生活。

RxJava是一個正在不斷髮展和擴大的世界。還有許多方法咱們尚未去探索。有些方法甚至尚未，由於RxJava，你能夠建立你本身的操做符並把他們推得更遠。

Android是一個好玩的地方，可是它也有侷限性。做爲一個Android開發者，你能夠用RxJava和RxAndroid克服它們中許多部分。咱們用AndroidScheduler只簡單提了下RxAndroid,除了在最後一章，你瞭解了ViewObservable。RxAndroid給了你許多：例如，WidgetObservable，LifecycleObservable。如今要更多的推進它取決於你了。

記得可觀測序列就像一條河：它們是流動的。你能夠「過濾」一條河，你能夠「轉換」一條河，你能夠將兩條河合併成一個，而後它仍舊時流動的。最後，它將成爲你想要的那條河。