Retrofit+RxJava

前言

前面写RxJava的时候就提过要来这么一篇RxJava和Retrofit结合使用的博客,那时由于Retrofit那篇博客还没写,直接写两个结合的用法的话理解起来会比较困难。现在Retrofit我们也学完了,是时候把欠的的那篇博客不上了。两个组合起来用法其实还是挺简单的,说白了就是将Retrofit的网络请求接口方法的返回值由Callback修改为Observable,这样一来这两个框架就结合起来了,Retrofit网络请求的结果就可以通过RxJava各种操作符进行各种花式操作了。这篇博客还是老规矩直接上例子,在例子中解释说明。

Retrofit不使用RxJava时和使用时对比

  • 用于描述网络请求的接口设置
public interface GetRequest_Interface {
    // 传统方式:Call<..>接口形式
    @GET("部分url地址")
    Call<Translation> getCall();
}

    //  RxJava 方式:Observable<..>接口形式
    @GET("url地址")
    public interface GetRequest_Interface {
    Observable<Translation> getCall();
  • 网络请求的封装形式 & 发送形式
        <--传统方式 -> >
        // 1. 创建 网络请求接口 的实例
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

        // 2. 采用Call<..>接口 对 发送请求 进行封装
        Call<Translation> call = request.getCall();

        // 3. 发送网络请求(异步)
        call.enqueue(new Callback<Translation>() {
            // 请求成功时回调
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                 ...
            }

            // 请求失败时回调
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                ....
            }
        });

       <--RxJava 版方式 -> >
        // 1. 创建 网络请求接口 的实例
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

        // 2. 采用Observable<...>形式 对 网络请求 进行封装
        Observable<Translation> observable = request.getCall();

        // 3. 发送网络请求(异步)
        observable.subscribeOn(Schedulers.io())               // 在IO线程进行网络请求
                .observeOn(AndroidSchedulers.mainThread())  // 回到主线程 处理请求结果
                .subscribe(new Observer<Translation>() {
                    // 发送请求后调用该复写方法(无论请求成功与否)
                    @Override
                    public void onSubscribe(Disposable d) {
                        ...// 初始化工作
                    }

                    // 发送请求成功后调用该复写方法
                    @Override
                    public void onNext(Translation result) {
                        ...// 对返回结果Translation类对象 进行处理
                    }

                    // 发送请求成功后,先调用onNext()再调用该复写方法
                    @Override
                    public void onComplete() {
                        Log.d(TAG, "请求成功");
                    }

                    // 发送请求失败后调用该复写方法
                    @Override
                    public void onError(Throwable e) {
                        Log.d(TAG, "请求失败");
                    }
                });
  • 这样一对比是不是瞬间就明白了这两个框架结合起来的用法了,没错,就是这么简单,到此为止本篇博客就结束了,哈哈,骗你的,皮这一下很开心,说好的例子还没写呢,下面我们就以一个例子来讲解下具体用法。

两个框架结合使用的网络请求例子

1. build.gradle中添加两个库的依赖、Gson解析的依赖和图片加载库Glide的依赖

dependencies {
    //添加RxJava依赖
    implementation "io.reactivex.rxjava2:rxjava:2.2.3"
    //添加RxAndroid依赖,专门用于Android的Rx库
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.0'
    //添加Retrofit依赖
    implementation 'com.squareup.retrofit2:retrofit:2.5.0'
    //衔接 Retrofit & RxJava,此处一定要注意使用RxJava2的版本
    implementation 'com.squareup.retrofit2:adapter-rxjava2:2.5.0'
    //添加Gson解析
    implementation 'com.squareup.retrofit2:converter-gson:2.5.0'
    //添加图片加载库依赖
    implementation 'com.github.bumptech.glide:glide:4.8.0'
}

2. 添加网络权限

<uses-permission android:name="android.permission.INTERNET"/>

3. 创建接收服务器返回数据的类

URL : https://www.zhuangbi.info/search?q=在下

image.png
  • ZaiXiaImage.java
public class ZaiXiaImage {
    //这里只取有用字段,其它没用字段就懒得写了
    public String created_at;
    public String image_url;
}

4. 创建用于描述网络请求的接口

import java.util.List;

import io.reactivex.Observable;
import retrofit2.http.GET;
import retrofit2.http.Query;

public interface ZaiXiaApi {
    //采用 注解 + Observable<...>接口 描述网络请求参数
    //search()是接收网络请求数据的方法,这里是从所有图片中将“在下”类别的图片查找出来
    @GET("search")
    Observable<List<ZaiXiaImage>> search(@Query("q") String query);
}

5. 布局部分代码

  • 布局由于用到了RecyclerView和CardView,所以别忘了添加依赖
implementation 'com.android.support:recyclerview-v7:27.1.1'
implementation 'com.android.support:cardview-v7:27.1.1'
  • activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout 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"
    tools:context=".MainActivity">

    <android.support.v7.widget.RecyclerView
        android:id="@+id/gridRv"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

</android.support.constraint.ConstraintLayout>
  • 图片布局:grid_item.xml
<?xml version="1.0" encoding="utf-8"?>
<android.support.v7.widget.CardView xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_marginBottom="4dp"
    android:layout_marginEnd="8dp"
    android:layout_marginStart="8dp"
    android:layout_marginTop="4dp"
    app:cardCornerRadius="2dp">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical"
        android:padding="4dp">

        <ImageView
            android:id="@+id/imageIv"
            android:layout_width="match_parent"
            android:layout_height="160dp" />

        <TextView
            android:id="@+id/descriptionTv"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:textSize="14sp" />

    </LinearLayout>
</android.support.v7.widget.CardView>

6. 用于展示图片的适配器代码

  • ZaiXiaGridAdapter.java
import android.support.annotation.NonNull;
import android.support.v7.widget.RecyclerView;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.ImageView;
import android.widget.TextView;

import com.bumptech.glide.Glide;

import java.util.List;

public class ZaiXiaGridAdapter extends RecyclerView.Adapter {
    private List<ZaiXiaImage> images;

    @NonNull
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.grid_item, parent, false);
        return new MyViewHolder(view);
    }

    @Override
    public void onBindViewHolder(@NonNull RecyclerView.ViewHolder holder, int position) {
        MyViewHolder myViewHolder = (MyViewHolder) holder;
        ZaiXiaImage image = images.get(position);
        Glide.with(holder.itemView.getContext()).load(image.image_url).into(myViewHolder.imageIv);
        myViewHolder.descriptionTv.setText(image.created_at);
    }

    @Override
    public int getItemCount() {
        return images == null ? 0 : images.size();
    }

    public void setImages(List<ZaiXiaImage> images) {
        this.images = images;
        notifyDataSetChanged();
    }

    private class MyViewHolder extends RecyclerView.ViewHolder {
        ImageView imageIv; //图片
        TextView descriptionTv; //创建时间

        public MyViewHolder(View itemView) {
            super(itemView);
            imageIv = itemView.findViewById(R.id.imageIv);
            descriptionTv = itemView.findViewById(R.id.descriptionTv);
        }
    }

}

7. 主页面代码

  • MainActivity.java
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.support.v7.widget.GridLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.widget.Toast;

import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import io.reactivex.Observable;
import io.reactivex.android.schedulers.AndroidSchedulers;
import io.reactivex.annotations.NonNull;
import io.reactivex.disposables.Disposable;
import io.reactivex.functions.Consumer;
import io.reactivex.functions.Function;
import io.reactivex.schedulers.Schedulers;
import retrofit2.Retrofit;
import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory;
import retrofit2.converter.gson.GsonConverterFactory;

public class MainActivity extends AppCompatActivity {

    private RecyclerView gridRv;
    private ZaiXiaGridAdapter adapter;
    //切断观察者操作对象
    private Disposable disposable;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        gridRv = findViewById(R.id.gridRv);
        gridRv.setLayoutManager(new GridLayoutManager(MainActivity.this, 2));
        adapter = new ZaiXiaGridAdapter();
        gridRv.setAdapter(adapter);
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://www.zhuangbi.info/")
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //支持RxJava
                .build();
        //创建网络请求接口的实例
        ZaiXiaApi zaiXiaApi = retrofit.create(ZaiXiaApi.class);
        //通过接口方法获取请求对象,用Observable<...>进行了封装,将返回用Observable对象
        Observable<List<ZaiXiaImage>> observable = zaiXiaApi.search("在下");
        disposable = observable.subscribeOn(Schedulers.io())
                .map(new Function<List<ZaiXiaImage>, List<ZaiXiaImage>>() { //通过map操作符将时间数据格式进行转换
                    @Override
                    public List<ZaiXiaImage> apply(List<ZaiXiaImage> zaiXiaImages) throws Exception {
                        SimpleDateFormat inputFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                        SimpleDateFormat outputFormat = new SimpleDateFormat("yyyy年MM月dd日 HH:mm:ss");
                        List<ZaiXiaImage> images = new ArrayList<>();
                        for (int i = 0; i < zaiXiaImages.size(); i++) {
                            ZaiXiaImage zaiXiaImage = zaiXiaImages.get(i);
                            Date date = inputFormat.parse(zaiXiaImage.created_at);
                            zaiXiaImage.created_at = outputFormat.format(date);
                            images.add(zaiXiaImage);
                        }
                        return images;
                    }
                })
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Consumer<List<ZaiXiaImage>>() {
                    @Override
                    public void accept(@NonNull List<ZaiXiaImage> images) throws Exception {
                        adapter.setImages(images);
                    }
                }, new Consumer<Throwable>() {
                    @Override
                    public void accept(@NonNull Throwable throwable) throws Exception {
                        Toast.makeText(MainActivity.this, "数据加载失败", Toast.LENGTH_SHORT).show();
                    }
                });
    }

    @Override
    protected void onDestroy() {
        //页面销毁时切断观察者,不再接收上游事件
        if (disposable != null && !disposable.isDisposed()) {
            disposable.dispose();
        }
        super.onDestroy();
    }
}

8. 运行效果

效果图.png

感谢

Android:Retrofit 结合 RxJava的优雅使用(含实例教程)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容