Android RxJava2+Retrofit2搭建網絡請求框架

時間 2019-11-08

標籤 android rxjava2+retrofit2 rxjava retrofit 搭建網絡請求框架欄目 Android 简体版

原文原文鏈接

前言

以前作網絡請求，用的是android-async-http，基於HttpClient 的，雖然早已淘汰，但一直懶得換，前一段時間看了stormzhang的《2016 Android Top 10 Library》文章，提到RxJava+Retrofit 是完美搭配，因此下定決定重構一下如今的項目java

網上查了一些資料，遇到了一些小坎坷，終於搞定了，由於網上查到的一些文章大多都是半年之前的，而我使用的都是最新的庫，遇到了一些新的問題，因此感受有必要寫篇文章幫助後人少走一些彎路react

本文默認讀者對RxJava和Retrofit 已經有了必定的瞭解，若對RxJava和Retrofit 還不瞭解，請先查閱相關資料android

##使用
一、添加依賴庫git

compile "io.reactivex.rxjava2:rxjava:2.1.1"
compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
compile 'com.squareup.retrofit2:retrofit:2.3.0'
compile 'com.squareup.retrofit2:converter-gson:2.3.0'
compile 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'複製代碼

converter-gson是Retrofit到Gson進行轉換的庫，adapter-rxjava2是Retrofit到RxJava進行轉換的庫github

這裏我是採用Google Gson進行數據解析的，若是你使用的是Jackson，替換爲以下依賴便可api

compile 'com.squareup.retrofit2:converter-jackson:2.3.0'複製代碼

若是須要添加HttpLoggingInterceptor進行調試，添加以下依賴bash

compile 'com.squareup.okhttp3:logging-interceptor:3.8.1'複製代碼

二、寫一個Service服務器

public interface RetrofitService {
    @FormUrlEncoded
    @POST("account/login")
    Observable<BaseEntity<UserInfo>> login(
            @Field("userId") String userId,
            @Field("password") String password
    );

    @GET("video/getUrl")
    Observable<BaseEntity<VideoUrl>> getVideoUrl(
            @Query("id") long id
    );

    @FormUrlEncoded
    @POST("user/addVideo")
    Observable<BaseEntity<Boolean>> addVideo(
            @FieldMap Map<String, Object> map
    );
}複製代碼

相對於單獨使用Retrofit，該處返回的是Observable對象網絡

三、一般服務器端會返回統一的數據格式，這裏咱們寫一個BaseEntityapp

public class BaseEntity<E> {

    @SerializedName("code")
    private int code;
    @SerializedName("msg")
    private String msg;
    @SerializedName("data")
    private E data;

    public boolean isSuccess() {
        return code == 0;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public E getData() {
        return data;
    }

    public void setData(E data) {
        this.data = data;
    }
}複製代碼

四、而後咱們能夠封裝一個RetrofitFactory

public class RetrofitFactory {

    private static final String BASE_URL = "http://api.baidu.com/";

    private static final long TIMEOUT = 30;

    // Retrofit是基於OkHttpClient的，能夠建立一個OkHttpClient進行一些配置
    private static OkHttpClient httpClient = new OkHttpClient.Builder()
            // 添加通用的Header
            .addInterceptor(new Interceptor() {
                @Override
                public Response intercept(Chain chain) throws IOException {
                    Request.Builder builder = chain.request().newBuilder();
                    builder.addHeader("token", "123");
                    return chain.proceed(builder.build());
                }
            })
            /*
            這裏能夠添加一個HttpLoggingInterceptor，由於Retrofit封裝好了從Http請求到解析，
            出了bug很難找出來問題，添加HttpLoggingInterceptor攔截器方便調試接口
             */
            .addInterceptor(new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
                @Override
                public void log(String message) {

                }
            }).setLevel(HttpLoggingInterceptor.Level.BASIC))
            .connectTimeout(TIMEOUT, TimeUnit.SECONDS)
            .readTimeout(TIMEOUT, TimeUnit.SECONDS)
            .build();

    private static RetrofitService retrofitService = new Retrofit.Builder()
            .baseUrl(BASE_URL)
            // 添加Gson轉換器
            .addConverterFactory(GsonConverterFactory.create(buildGson()))
            // 添加Retrofit到RxJava的轉換器
            .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
            .client(httpClient)
            .build()
            .create(RetrofitService.class);

    public static RetrofitService getInstance() {
        return retrofitService;
    }

    private static Gson buildGson() {
        return new GsonBuilder()
                .serializeNulls()
                .setFieldNamingPolicy(FieldNamingPolicy.IDENTITY)
                // 此處能夠添加Gson 自定義TypeAdapter
                .registerTypeAdapter(UserInfo.class, new UserInfoTypeAdapter())
                .create();
    }
}複製代碼

五、一般咱們會在IO線程進行請求，在主線程進行回調

public class RxSchedulers {

    public static <T> ObservableTransformer<T, T> compose() {
        return new ObservableTransformer<T, T>() {
            @Override
            public ObservableSource<T> apply(Observable<T> observable) {
                return observable
                        .subscribeOn(Schedulers.io())
                        .doOnSubscribe(new Consumer<Disposable>() {
                            @Override
                            public void accept(Disposable disposable) throws Exception {
                                if (!Utils.isNetworkConnected()) {
                                    Toast.makeText(context, R.string.toast_network_error, Toast.LENGTH_SHORT).show();
                                }
                            }
                        })
                        .observeOn(AndroidSchedulers.mainThread());
            }
        };
    }
}複製代碼

這裏咱們能夠添加一個通用的網絡鏈接判斷

六、RxJava Observable 訂閱須要傳入一個Observer對象，此處封裝一個BaseObserver

public abstract class BaseObserver<T> implements Observer<BaseEntity<T>> {

    private static final String TAG = "BaseObserver";
    private Context mContext;

    protected BaseObserver(Context context) {
        this.mContext = context.getApplicationContext();
    }

    @Override
    public void onSubscribe(Disposable d) {

    }

    @Override
    public void onNext(BaseEntity<T> value) {
        if (value.isSuccess()) {
            T t = value.getData();
            onHandleSuccess(t);
        } else {
            onHandleError(value.getMsg());
        }
    }

    @Override
    public void onError(Throwable e) {
        Log.e(TAG, "error:" + e.toString());
    }

    @Override
    public void onComplete() {
        Log.d(TAG, "onComplete");
    }


    protected abstract void onHandleSuccess(T t);

    protected void onHandleError(String msg) {
        Toast.makeText(mContext, msg, Toast.LENGTH_SHORT).show();
    }
}複製代碼

七、調用

private void login(String userId, String password) {
    Observable<BaseEntity<UserInfo>> observable = RetrofitFactory.getInstance().login(userId, password);
    observable.compose(RxSchedulers.compose()).subscribe(new BaseObserver<UserInfo>(context) {
         @Override
          protected void onHandleSuccess(UserInfo userInfo) {
               // 保存用戶信息等操做
          }
    });
}複製代碼