OkGo網絡框架的封裝和基本使用

OkGo是封裝了okhttp的網絡框架,可以與RxJava完美結合,比Retrofit更簡單易用。支持大文件上傳下載,上傳進度回調,下載進度回調,表單上傳(多文件和多參數一起上傳),鏈式調用,可以自定義返回對象,支持Https和自簽名證書,支持cookie自動管理,支持四種緩存模式緩存網絡數據,支持301、302重定向,擴展了統一的上傳管理和下載管理功能。

OkGo網絡請求

今天自己新建了一個Demo,試了一下使用okGo做簡單的get、post和文件下載,那么這篇博客就詳細講訴一下具體的使用過程。

一.OkGo配置

在app下的build.gradel里面配置

//必須使用
implementation 'com.lzy.net:okgo:3.0.4'

選擇性配置:

//以下三個選擇添加,okrx和okrx2不能同時使用
implementation 'com.lzy.net:okrx:1.0.2'
implementation 'com.lzy.net:okrx2:2.0.2'  
implementation 'com.lzy.net:okserver:2.0.5'

二.在Applicaiton中初始化

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        //okGo網絡框架初始化和全局配置
        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        //builder.cookieJar(new CookieJarImpl(new SPCookieStore(this)));      //使用sp保持cookie,如果cookie不過期,則一直有效
        builder.cookieJar(new CookieJarImpl(new DBCookieStore(this)));//使用數據庫保持cookie,如果cookie不過期,則一直有效
        //builder.cookieJar(new CookieJarImpl(new MemoryCookieStore()));      //使用內存保持cookie,app退出后,cookie消失
        //設置請求頭
        HttpHeaders headers = new HttpHeaders();
        headers.put("commonHeaderKey1", "commonHeaderValue1");    //header不支持中文,不允許有特殊字符
        headers.put("commonHeaderKey2", "commonHeaderValue2");
        //設置請求參數
        HttpParams params = new HttpParams();
        params.put("commonParamsKey1", "commonParamsValue1");     //param支持中文,直接傳,不要自己編碼
        params.put("commonParamsKey2", "這里支持中文參數");
        OkGo.getInstance().init(this)                           //必須調用初始化
                .setOkHttpClient(builder.build())               //建議設置OkHttpClient,不設置會使用默認的
                .setCacheMode(CacheMode.NO_CACHE)               //全局統一緩存模式,默認不使用緩存,可以不傳
                .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)   //全局統一緩存時間,默認永不過期,可以不傳
                .setRetryCount(3)                               //全局統一超時重連次數,默認為三次,那么最差的情況會請求4次(一次原始請求,三次重連請求),不需要可以設置為0
                .addCommonHeaders(headers)                      //全局公共頭
                .addCommonParams(params);
    }
}

三.OkGo使用示例

1.基本的get請求

OkGo.get(Urls.URL_METHOD)     // 請求方式和請求url
    .tag(this)                       // 請求的 tag, 主要用于取消對應的請求
    .cacheKey("cacheKey")            // 設置當前請求的緩存key,建議每個不同功能的請求設置一個
    .cacheMode(CacheMode.DEFAULT)    // 緩存模式,詳細請看緩存介紹
    .execute(new StringCallback() {
        @Override
        public void onSuccess(String s, Call call, Response response) {
            // s 即為所需要的結果
        }
    });

2.請求 Bitmap 對象

OkGo.get(Urls.URL_IMAGE)//
    .tag(this)//
    .execute(new BitmapCallback() {
        @Override
        public void onSuccess(Bitmap bitmap, Call call, Response response) {
            // bitmap 即為返回的圖片數據
        }
    });

3.普通Post請求,直接上傳String類型的文本

一般此種用法用于與服務器約定的數據格式,當使用該方法時,params中的參數設置是無效的,所有參數均需要通過需要上傳的文本中指定,此外,額外指定的header參數仍然保持有效。

OkGo.post(Urls.URL_TEXT_UPLOAD)//
    .tag(this)//
    .upString("這是要上傳的長文本數據!")//
    .execute(new StringCallback() {
        @Override
        public void onSuccess(String s, Call call, Response response) {
            //上傳成功
        }

        @Override
        public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
            //這里回調上傳進度(該回調在主線程,可以直接更新ui)
        }
    });

4.普通Post,直接上傳Json類型的文本(注意傳遞的類型)

該方法與postString沒有本質區別,只是數據格式是json,一般來說,需要自己創建一個實體bean或者一個map,把需要的參數設置進去,然后通過三方的Gson或者fastjson轉換成json字符串,最后直接使用該方法提交到服務器。

HashMap<String, String> params = new HashMap<>();
params.put("key1", "value1");
params.put("key2", "這里是需要提交的json格式數據");
params.put("key3", "也可以使用三方工具將對象轉成json字符串");
params.put("key4", "其實你怎么高興怎么寫都行");
JSONObject jsonObject = new JSONObject(params);

OkGo.post(Urls.URL_TEXT_UPLOAD)//
    .tag(this)//
    .upJson(jsonObject.toString())//
    .execute(new StringCallback() {
        @Override
        public void onSuccess(String s, Call call, Response response) {
            //上傳成功
        }

        @Override
        public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
            //這里回調上傳進度(該回調在主線程,可以直接更新ui)
        }
    });

5.文件下載

OkGo.<File>get(url)
        .tag(this)//
        .headers("header1", "headerValue1")//
        .params("param1", "paramValue1")//
        .execute(new FileCallback("OkGo.apk") {

            @Override
            public void onStart(Request<File, ? extends Request> request) {
                btnFileDownload.setText("正在下載中");
            }

            @Override
            public void onSuccess(Response<File> response) {
                btnFileDownload.setText("下載完成"+response.body());
            }

            @Override
            public void onError(Response<File> response) {
                btnFileDownload.setText("下載出錯");
            }

            @Override
            public void downloadProgress(Progress progress) {
                System.out.println(progress);
            }
        });

6.在onDestroy主動銷毀請求

protected void onDestroy() {
        super.onDestroy();
        //取消指定tag的請求
        OkGo.getInstance().cancelTag(this);
        //取消全部請求
        OkGo.getInstance().cancelAll();
        //取消OkHttpClient的全部請求
        OkGo.cancelAll(new OkHttpClient());
        OkGo.cancelTag(new OkHttpClient(), "且指定tag");
    }

7.請求功能的所有配置講解

以下代碼包含了以下內容:

  • 一次普通請求所有能配置的參數,真實使用時不需要配置這么多,按自己的需要選擇性的使用即可
  • params添加參數的時候,最后一個isReplace為可選參數,默認為true,即代表相同key的時候,后添加的會覆蓋先前添加的
  • 多文件和多參數的表單上傳,同時支持進度監聽
  • 自簽名網站https的訪問,調用setCertificates方法即可
  • 為單個請求設置超時,比如涉及到文件的需要設置讀寫等待時間多一點。
  • Cookie一般情況下只需要在初始化的時候調用setCookieStore即可實現cookie的自動管理,如果特殊業務需要,需要手動額外向服務器傳遞自定義的cookie,可以在每次請求的時候調用addCookie方法,該方法提供了3個重載形式,可以根據自己的需要選擇使用。
OkGo.get(Urls.URL_METHOD) // 請求方式和請求url, get請求不需要拼接參數,支持get,post,put,delete,head,options請求
    .tag(this)               // 請求的 tag, 主要用于取消對應的請求
    .connTimeOut(10000)      // 設置當前請求的連接超時時間
    .readTimeOut(10000)      // 設置當前請求的讀取超時時間
    .writeTimeOut(10000)     // 設置當前請求的寫入超時時間
    .cacheKey("cacheKey")    // 設置當前請求的緩存key,建議每個不同功能的請求設置一個
    .cacheTime(5000)         // 緩存的過期時間,單位毫秒
    .cacheMode(CacheMode.FIRST_CACHE_THEN_REQUEST) // 緩存模式,詳細請看第四部分,緩存介紹
    .setCertificates(getAssets().open("srca.cer")) // 自簽名https的證書,可變參數,可以設置多個
    .addInterceptor(interceptor)            // 添加自定義攔截器
    .headers("header1", "headerValue1")     // 添加請求頭參數
    .headers("header2", "headerValue2")     // 支持多請求頭參數同時添加
    .params("param1", "paramValue1")        // 添加請求參數
    .params("param2", "paramValue2")        // 支持多請求參數同時添加
    .params("file1", new File("filepath1")) // 可以添加文件上傳
    .params("file2", new File("filepath2")) // 支持多文件同時添加上傳
    .addUrlParams("key", List<String> values) //這里支持一個key傳多個參數
    .addFileParams("key", List<File> files) //這里支持一個key傳多個文件
    .addFileWrapperParams("key", List<HttpParams.FileWrapper> fileWrappers)//這里支持一個key傳多個文件
    .addCookie("aaa", "bbb")    // 這里可以傳遞自己想傳的Cookie
    .addCookie(cookie)          // 可以自己構建cookie
    .addCookies(cookies)        // 可以一次傳遞批量的cookie
     //這里給出的泛型為 ServerModel,同時傳遞一個泛型的 class對象,即可自動將數據結果轉成對象返回
    .execute(new DialogCallback<ServerModel>(this) {
        @Override
        public void onBefore(BaseRequest request) {
            // UI線程 請求網絡之前調用
            // 可以顯示對話框,添加/修改/移除 請求參數
        }

        @Override
        public ServerModel convertSuccess(Response response) throws Exception{
            // 子線程,可以做耗時操作
            // 根據傳遞進來的 response 對象,把數據解析成需要的 ServerModel 類型并返回
            // 可以根據自己的需要,拋出異常,在onError中處理
            return null;
        }

        @Override
        public void parseError(Call call, IOException e) {
            // 子線程,可以做耗時操作
            // 用于網絡錯誤時在子線程中執行數據耗時操作,子類可以根據自己的需要重寫此方法
        }

        @Override
        public void onSuccess(ServerModel serverModel, Call call, Response response) {
            // UI 線程,請求成功后回調
            // ServerModel 返回泛型約定的實體類型參數
            // call        本次網絡的請求信息,如果需要查看請求頭或請求參數可以從此對象獲取
            // response    本次網絡訪問的結果對象,包含了響應頭,響應碼等      
        }

        @Override
        public void onCacheSuccess(ServerModel serverModel, Call call) {
            // UI 線程,緩存讀取成功后回調
            // serverModel 返回泛型約定的實體類型參數
            // call        本次網絡的請求信息
        }

        @Override
        public void onError(Call call, Response response, Exception e) {
            // UI 線程,請求失敗后回調
            // call        本次網絡的請求對象,可以根據該對象拿到 request
            // response    本次網絡訪問的結果對象,包含了響應頭,響應碼等          
            // e           本次網絡訪問的異常信息,如果服務器內部發生了錯誤,響應碼為 404,或大于等于500
        }

        @Override
        public void onCacheError(Call call, Exception e) {
            // UI 線程,讀取緩存失敗后回調
            // call        本次網絡的請求對象,可以根據該對象拿到 request
            // e           本次網絡訪問的異常信息,如果服務器內部發生了錯誤,響應碼為 404,或大于等于500
        }

        @Override
        public void onAfter(ServerModel serverModel, Exception e) {
            // UI 線程,請求結束后回調,無論網絡請求成功還是失敗,都會調用,可以用于關閉顯示對話框
            // ServerModel 返回泛型約定的實體類型參數,如果網絡請求失敗,該對象為 null
            // e           本次網絡訪問的異常信息,如果服務器內部發生了錯誤,響應碼為 404,或大于等于500
        }

        @Override
        public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
            // UI 線程,文件上傳過程中回調,只有請求方式包含請求體才回調(GET,HEAD不會回調)
            // currentSize  當前上傳的大小(單位字節)
            // totalSize   需要上傳的總大小(單位字節)
            // progress     當前上傳的進度,范圍 0.0f ~ 1.0f
            // networkSpeed 當前上傳的網速(單位秒)
        }

        @Override
        public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
            // UI 線程,文件下載過程中回調
            //參數含義同 上傳相同
        }
    });

至此OKGO的基本使用和簡單封裝介紹完畢,同時傳參和抓包的話,還是有幾點需要小伙伴注意的,具體可以參考:傳參與抓包注意點(必看)

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • OkGo,一個專注于讓網絡請求更簡單的框架,與RxJava完美結合,比Retrofit更簡單易用。 OkGo - ...
    壓抑的內心閱讀 16,494評論 0 9
  • 第一部分 HTML&CSS整理答案 1. 什么是HTML5? 答:HTML5是最新的HTML標準。 注意:講述HT...
    kismetajun閱讀 27,627評論 1 45
  • Swift1> Swift和OC的區別1.1> Swift沒有地址/指針的概念1.2> 泛型1.3> 類型嚴謹 對...
    cosWriter閱讀 11,135評論 1 32
  • 會話(Session)跟蹤是Web程序中常用的技術,用來跟蹤用戶的整個會話。常用的會話跟蹤技術是Cookie與Se...
    chinariver閱讀 5,651評論 1 49
  • 國家電網公司企業標準(Q/GDW)- 面向對象的用電信息數據交換協議 - 報批稿:20170802 前言: 排版 ...
    庭說閱讀 11,121評論 6 13