Android Rxjava+Retrofit網絡請求框架封裝（一）

前言

這是第二次改編、之前第一次寫這篇博客的時候只是當成筆記記錄一下。都沒有怎麼仔細介紹內容，可能導致一些朋友們沒看明白，這次重新組織一下。當然由於內容比較多，不可能太詳細。我儘量做到讓更多人能夠看明白，哈哈當然朋友們也要跟着我的步驟一步一步來實現，這樣會比較好理解。

一、簡介

大家都知道Retrofit是對OKHttp的第二次封裝，使用上也比較簡單。那爲什麼還要對Retrofit進行封裝呢，個人理解主要還是對Retrofit進行更規範的分類，有利於項目的開發與維護，提高網絡請求這一塊的效率。好了，可以開始跟我走了。。一步一步的走向巔峯，然後再回頭來聽我吹牛逼。。

二、Retrofit基本使用

（1）在build文件中加入相關依賴

//github地址：https://github.com/square/retrofit
//文檔地址：https://square.github.io/retrofit/
implementation 'com.squareup.retrofit2:retrofit:2.5.0'

（2）基本使用

public interface ApiUrl {
    //get請求
    @GET(Constans.retrofit)
    Call<Bean> getRetrofit();
}

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Constans.BaseUrl)
                .build();

        ApiUrl api = retrofit.create(ApiUrl.class);
        Call<Bean> demo = api.getRetrofit();
        demo.enqueue(new Callback<Bean>() {
            @Override
            public void onResponse(Call<Bean> call, Response<Bean> response) {
                Log.e(TAG, "請求成功信息: "+response.body().toString());
            }

            @Override
            public void onFailure(Call<Bean> call, Throwable t) {
                Log.e(TAG, "請求失敗信息: " +t.getMessage());
            }
        });

目前大部分後臺一般會返回JSON數據類型所以我們需要Retrofit 添加JSON支持

    //retrofit添加Json解析返回數據
    implementation 'com.squareup.retrofit2:converter-gson:2.5.0'

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Constans.BaseUrl)
                //添加GSON解析：返回數據轉換成GSON類型 
                .addConverterFactory(GsonConverterFactory.create())
                .build();

這樣就可以解析JSON數據

（3）測試

這裏提供測試Url,返回的是JSON數據類型

    public final static  String BaseUrl = "http://120.78.186.81/api/";
    public final static  String retrofit = "values/5";

映射返回數據

/**
 * {
 *     "res_code": 200,
 *     "err_msg": "Web page does not exist",
 *     "demo": {
 *         "id": "1001",
 *         "appid": "1021",
 *         "name": "sss",
 *         "showtype": "text"
 *     }
 * }
 */
public class Bean {

    @Override
    public String toString() {
        return "bean{" +
                "res_code=" + res_code +
                ", err_code=" + err_code +
                ", err_msg='" + err_msg + '\'' +
                ", demo=" + demo +
                '}';
    }
    private int res_code;
    private int err_code;
    private String err_msg;
    private DemoBean demo;

    public int getRes_code() {
        return res_code;
    }

    public void setRes_code(int res_code) {
        this.res_code = res_code;
    }

    public int getErr_code() {
        return err_code;
    }

    public void setErr_code(int err_code) {
        this.err_code = err_code;
    }

    public String getErr_msg() {
        return err_msg;
    }

    public void setErr_msg(String err_msg) {
        this.err_msg = err_msg;
    }

    public DemoBean getDemo() {
        return demo;
    }

    public void setDemo(DemoBean demo) {
        this.demo = demo;
    }

    public static class DemoBean {
        @Override
        public String toString() {
            return "DemoBean{" +
                    "id='" + id + '\'' +
                    ", appid='" + appid + '\'' +
                    ", name='" + name + '\'' +
                    ", showtype='" + showtype + '\'' +
                    '}';
        }
        private String id;
        private String appid;
        private String name;
        private String showtype;

        public String getId() {
            return id;
        }

        public void setId(String id) {
            this.id = id;
        }

        public String getAppid() {
            return appid;
        }

        public void setAppid(String appid) {
            this.appid = appid;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }

        public String getShowtype() {
            return showtype;
        }

        public void setShowtype(String showtype) {
            this.showtype = showtype;
        }
    }
}

發送請求並打印返回數據

 Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Constans.BaseUrl)
                //添加GSON解析
                .addConverterFactory(GsonConverterFactory.create())
                .build();

        ApiUrl api = retrofit.create(ApiUrl.class);
        Call<Bean> demo = api.getRetrofit();
        demo.enqueue(new Callback<Bean>() {
            @Override
            public void onResponse(Call<Bean> call, Response<Bean> response) {
                Log.e(TAG, "請求成功信息: "+response.body().toString());
            }

            @Override
            public void onFailure(Call<Bean> call, Throwable t) {
                Log.e(TAG, "請求失敗信息: " +t.getMessage());
            }
        });

別忘了——添加網絡權限

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

打印結果：

 E/RetrofitActivity: 請求成功信息: bean{res_code=200, err_code=0, err_msg='Web page does not exist', demo=DemoBean{id='1001', appid='1021', name='sss', showtype='text'}}

三、Retrofit 自定義的`OkHttpClient`

這裏介紹一些常用的設置

（1）設置自定義的`OkHttpClient`

       OkHttpClient client = new OkHttpClient().newBuilder()
                .readTimeout(Constans.DEFAULT_TIME, TimeUnit.SECONDS)//設置讀取超時時間
                .connectTimeout(Constans.DEFAULT_TIME, TimeUnit.SECONDS)//設置請求超時時間
                .writeTimeout(Constans.DEFAULT_TIME,TimeUnit.SECONDS)//設置寫入超時時間
                .addInterceptor(new LogInterceptor())//添加打印攔截器
                .retryOnConnectionFailure(true)//設置出現錯誤進行重新連接。
                .build();

    //設置默認超時時間
    public static final int DEFAULT_TIME=10;


import android.util.Log;
import java.io.IOException;
import java.util.Locale;
import okhttp3.Interceptor;
import okhttp3.Request;

/**
 *  TODO Log攔截器代碼
 */
public class LogInterceptor implements Interceptor {
    private String TAG = "okhttp";

    @Override
    public okhttp3.Response intercept(Chain chain) throws IOException {
        Request request = chain.request()
//                .newBuilder()
//                .addHeader("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
//                .addHeader("Accept-Encoding", "gzip, deflate")
//                .addHeader("Connection", "keep-alive")
//                .addHeader("Accept", "*/*")
//                .addHeader("Cookie", "add cookies here")
//                .build()
                  ;

        Log.e(TAG,"request:" + request.toString());
        long t1 = System.nanoTime();
        okhttp3.Response response = chain.proceed(chain.request());
        long t2 = System.nanoTime();
        Log.e(TAG,String.format(Locale.getDefault(), "Received response for %s in %.1fms%n%s",
                response.request().url(), (t2 - t1) / 1e6d, response.headers()));
        okhttp3.MediaType mediaType = response.body().contentType();
        String content = response.body().string();
        Log.e(TAG, "response body:" + content);
        return response.newBuilder()
                .body(okhttp3.ResponseBody.create(mediaType, content))
//                .header("Authorization", Your.sToken)
                .build();
    }
}

（2）Retrofit 添加client

        Retrofit retrofit = new Retrofit.Builder()
                //設置自定義okHttp
                .client(client)
                .baseUrl(Constans.BaseUrl)
                //添加GSON解析
                .addConverterFactory(GsonConverterFactory.create())
                .build();

（3）打印效果

E/okhttp: request:Request{method=GET, url=http://pndatsn5v.bkt.clouddn.com/retrofit.txt, tags={class retrofit2.Invocation=retrofit.interfaces.ApiUrl.getRetrofit() []}}

E/okhttp: Received response for http://pndatsn5v.bkt.clouddn.com/retrofit.txt in 55.1ms
    Server: Tengine
    Content-Type: text/plain
    Connection: keep-alive
    Date: Sat, 23 Feb 2019 08:17:35 GMT
    Accept-Ranges: bytes
    Access-Control-Allow-Origin: *
    Access-Control-Expose-Headers: X-Log, X-Reqid
    Access-Control-Max-Age: 2592000
    Cache-Control: public, max-age=31536000
    Content-Disposition: inline; filename="retrofit.txt"; filename*=utf-8' 'retrofit.txt
    Content-Transfer-Encoding: binary
    Etag: "Fh65gSkYd4KepQbHi-rWZDlhKjmO.gz"
    Last-Modified: Sat, 23 Feb 2019 08:14:42 GMT
    Vary: Accept-Encoding
    X-Log: AC;CFGG:4;redis.g/404;redis.g;rs5_shard.sel:2;rwro.get:2;RS.dbs:2;RS:3;redis.s;2s.gh;PFDS;AUTHPROXY_dg_out;IO:85
    X-M-Log: QNM:xs1172;QNM3
    X-M-Reqid: dGUAAMyobctL8IUV
    X-Qiniu-Zone: 2
    X-Qnm-Cache: Hit
    X-Reqid: EkMAAA7s1xso8IUV
    X-Svr: IO
    Ali-Swift-Global-Savetime: 1550909855
    Via: cache4.l2et15[10,200-0,M], cache15.l2et15[11,0], vcache19.cn1177[0,200-0,H], vcache2.cn1177[1,0]
    Age: 80679
    X-Cache: HIT TCP_MEM_HIT dirn:2:55209266
    X-Swift-SaveTime: Sat, 23 Feb 2019 08:17:35 GMT
    X-Swift-CacheTime: 2592000
    Timing-Allow-Origin: *
    EagleId: 1b9f47ca15509905340914033e

E/okhttp: response body:{
        "res_code": 200,
        "err_msg": "Web page does not exist",
        "demo": {
            "id": "1001",
            "appid": "1021",
            "name": "sss",
            "showtype": "text"
        }
    }

E/RetrofitActivity: 請求成功信息: bean{res_code=200, err_code=0, err_msg='Web page does not exist', demo=DemoBean{id='1001', appid='1021', name='sss', showtype='text'}}

四、Retrofit 與 Rxjava 結合使用

（1）添加依賴

implementation 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0'

（2）Retrofit 設置

Retrofit retrofit = new Retrofit.Builder()
                .client(client)
                .baseUrl(Constans.BaseUrl)
                //添加GSON解析：返回數據轉換成GSON類型
                .addConverterFactory(GsonConverterFactory.create())
                //添加Rxjava支持
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build();

（3）其他修改

//@GET(Constans.retrofit)
//Call<Bean> getRetrofit();

@GET(Constans.retrofit)
Observable<Bean> getRetrofit1();

        retrofit.create(ApiUrl.class)
                .getRetrofit1()
                .subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Observer<Bean>() {
                    @Override
                    public void onSubscribe(Disposable d) {
                        Log.e(TAG, "onSubscribe: " );
                    }

                    @Override
                    public void onNext(Bean demo) {
                        Log.e(TAG, "onNext: " +demo.toString());
                    }

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

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

（4）測試結果

E/RetrofitActivity: onSubscribe: 
E/RetrofitActivity: onNext: bean{res_code=200, err_code=0, err_msg='Web page does not exist', demo=DemoBean{id='1001', appid='1021', name='sss', showtype='text'}}
E/RetrofitActivity: onComplete:

五、防止Rxjava引發的內存泄漏

當使用RxJava訂閱並執行耗時任務後，當Activity被finish時，如果耗時任務還未完成，沒有及時取消訂閱，就會導致Activity無法被回收，從而引發內存泄漏。爲了解決這個問題，就產生了RxLifecycle，讓RxJava變得有生命週期感知，使得其能及時取消訂閱，避免出現內存泄漏問題。

（1）添加依賴

    implementation 'com.trello.rxlifecycle2:rxlifecycle-components:2.1.0'

（2）基本使用

Activity 需繼承自 RxAppCompatActivity 或 RxFragmentActivity 或 RxActivity

Fragment 需繼承 RxFragment

retrofit.create(ApiUrl.class)
                .getRetrofit1()
                .subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                //綁定生命週期
                .compose(bindUntilEvent(ActivityEvent.DESTROY))
                .subscribe(new Observer<Bean>() {
                    @Override
                    public void onSubscribe(Disposable d) {
                        Log.e(TAG, "onSubscribe: " );
                    }

                    @Override
                    public void onNext(Bean demo) {
                        Log.e(TAG, "onNext: " +demo.toString());
                    }

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

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

好了目前瞭解這些已經夠用了不過直接使用還是很麻煩，重複代碼比較多。所以需要進行整理和封裝

六、總結與封裝

《Android Rxjava+Retrofit封裝》

七、Demo地址

https://github.com/DayorNight/RxjavaRetrofit2

八、內容推薦

簡書：《Android Rxjava+Retrofit網絡請求框架封裝（一）》

《Android Rxjava+Retrofit網絡請求框架封裝（二）》

《Android JUnit單元測試》

《Android Log日誌封裝》

《Android 仿微信全局字體大小調整》

如果你覺得我寫的不錯或者對您有所幫助的話

不妨頂一個【微笑】，別忘了點贊、收藏、加關注哈

您的每個舉動都是對我莫大的支持

Android Rxjava+Retrofit網絡請求框架封裝（一）

前言

一、簡介

二、Retrofit基本使用

（1）在build文件中加入相關依賴

（2）基本使用

（3）測試

三、Retrofit 自定義的`OkHttpClient`

（1）設置自定義的`OkHttpClient`

（2）Retrofit 添加client

（3）打印效果

四、Retrofit 與 Rxjava 結合使用

（1）添加依賴

（2）Retrofit 設置

（3）其他修改

（4）測試結果

五、防止Rxjava引發的內存泄漏

（1）添加依賴

（2）基本使用

六、總結與封裝

七、Demo地址

八、內容推薦

Android 學習資源收集

Android Jetpack架構組件之Lifecycle入門

Android ButterKnife入門到放棄

Android Espresso入門到自動搞定

Android Rxjava+Retrofit網絡請求框架封裝（一）

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

Android Rxjava+Retrofit網絡請求框架封裝（一）

前言

一、簡介

二、Retrofit基本使用

（1）在build文件中加入相關依賴

（2）基本使用

（3）測試

三、Retrofit 自定義的OkHttpClient

（1）設置自定義的OkHttpClient

（2）Retrofit 添加client

（3）打印效果

四、Retrofit 與 Rxjava 結合使用

（1）添加依賴

（2）Retrofit 設置

（3）其他修改

（4）測試結果

五、防止Rxjava引發的內存泄漏

（1）添加依賴

（2）基本使用

六、總結與封裝

七、Demo地址

八、內容推薦

三、Retrofit 自定義的`OkHttpClient`

（1）設置自定義的`OkHttpClient`