Android框架之路——OkGo的使用

一、簡介

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

github地址：https://github.com/jeasonlzy/okhttp-OkGo

什么是304？

二、添加依賴

//默認添加okhttp3.4.1、okio1.9.0
compile 'com.lzy.net:okgo:2.1.4'

三、解鎖技能

進行全局配置，一般在 Aplication，或者基類的onCreate方法中，只需要調用一次即可，可以配置調試開關，全局的超時時間，公共的請求頭和請求參數等信息。如果在Aplication中初始化，需要在清單文件中注冊 Aplication

//---------這里給出的是示例代碼,告訴你可以這么傳,實際使用的時候,根據需要傳,不需要就不傳-------------//
   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.init(this);

   //以下設置的所有參數是全局參數,同樣的參數可以在請求的時候再設置一遍,那么對於該請求來講,請求中的參數會覆蓋全局參數
   //好處是全局參數統一,特定請求可以特別定制參數
   try {
       //以下都不是必須的，根據需要自行選擇,一般來說只需要 debug,緩存相關,cookie相關的 就可以了
       OkGo.getInstance()

           // 打開該調試開關,打印級別INFO,並不是異常,是為了顯眼,不需要就不要加入該行
           // 最后的true表示是否打印okgo的內部異常，一般打開方便調試錯誤
           .debug("OkGo", Level.INFO, true)

           //如果使用默認的 60秒,以下三行也不需要傳
           .setConnectTimeout(OkGo.DEFAULT_MILLISECONDS)  //全局的連接超時時間
           .setReadTimeOut(OkGo.DEFAULT_MILLISECONDS)     //全局的讀取超時時間
           .setWriteTimeOut(OkGo.DEFAULT_MILLISECONDS)    //全局的寫入超時時間

           //可以全局統一設置緩存模式,默認是不使用緩存,可以不傳,具體其他模式看 github 介紹 https://github.com/jeasonlzy/
           .setCacheMode(CacheMode.NO_CACHE)

           //可以全局統一設置緩存時間,默認永不過期,具體使用方法看 github 介紹
           .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)

           //可以全局統一設置超時重連次數,默認為三次,那么最差的情況會請求4次(一次原始請求,三次重連請求),不需要可以設置為0
           .setRetryCount(3)

           //如果不想讓框架管理cookie（或者叫session的保持）,以下不需要
   //      .setCookieStore(new MemoryCookieStore())            //cookie使用內存緩存（app退出后，cookie消失）
           .setCookieStore(new PersistentCookieStore())        //cookie持久化存儲，如果cookie不過期，則一直有效

           //可以設置https的證書,以下幾種方案根據需要自己設置
           .setCertificates()                                  //方法一：信任所有證書,不安全有風險
   //      .setCertificates(new SafeTrustManager())            //方法二：自定義信任規則，校驗服務端證書
   //      .setCertificates(getAssets().open("srca.cer"))      //方法三：使用預埋證書，校驗服務端證書（自簽名證書）
   //              //方法四：使用bks證書和密碼管理客戶端證書（雙向認證），使用預埋證書，校驗服務端證書（自簽名證書）
   //      .setCertificates(getAssets().open("xxx.bks"), "123456", getAssets().open("yyy.cer"))//

           //配置https的域名匹配規則，詳細看demo的初始化介紹，不需要就不要加入，使用不當會導致https握手失敗
   //      .setHostnameVerifier(new SafeHostnameVerifier())

           //可以添加全局攔截器，不需要就不要加入，錯誤寫法直接導致任何回調不執行
   //      .addInterceptor(new Interceptor() {
   //            @Override
   //            public Response intercept(Chain chain) throws IOException {
   //                 return chain.proceed(chain.request());
   //            }
   //       })

           //這兩行同上，不需要就不要加入
           .addCommonHeaders(headers)  //設置全局公共頭
           .addCommonParams(params);   //設置全局公共參數

   } catch (Exception e) {
       e.printStackTrace();
   }    

使用get請求獲取數據；

 /**
   * get請求獲取數據
   * @param url
   */
  private void getByOkGo(String url){
      OkGo.get(url)                            // 請求方式和請求url
              .tag(this)                       // 請求的 tag, 主要用於取消對應的請求
              .cacheKey("cacheKey")            // 設置當前請求的緩存key,建議每個不同功能的請求設置一個
              .cacheMode(CacheMode.DEFAULT)    // 緩存模式，詳細請看緩存介紹
              .execute(new StringCallback() {
                  @Override
                  public void onSuccess(String s, Call call, Response response) {
                      mTextView2.setText(s);
                  }
              });
  }

post請求獲取數據，其中params方法用來添加請求參數，params添加參數的時候,最后一個isReplace為可選參數,默認為true,即代表相同key的時候,后添加的會覆蓋先前添加的；

 /**
   * post請求
   * @param url
   */
  private void postByOkGo(String url){
      OkGo.post(url)
              .tag(this)
              .cacheKey("cachePostKey")
              .cacheMode(CacheMode.DEFAULT)
              .params("method", "album.item.get")
              .params("appKey", "myKey")
              .params("format", "json")
              .params("albumId", "Lqfme5hSolM")
              .params("pageNo", "1")
              .params("pageSize", "2")
              .execute(new StringCallback() {
                  @Override
                  public void onSuccess(String s, Call call, Response response) {
                      mTextView2.setText(s);
                  }

                  @Override
                  public void onError(Call call, Response response, Exception e) {
                      super.onError(call, response, e);
                      mTextView2.setText(e.getMessage());
                  }
              });
  }

文件下載，FileCallback具有三個重載的構造方法，文件目錄如果不指定,默認下載的目錄為 sdcard/download/，文件名如果不指定,則按照以下規則命名:

• 首先檢查用戶是否傳入了文件名,如果傳入,將以用戶傳入的文件名命名
• 如果沒有傳入,那么將會檢查服務端返回的響應頭是否含有Content-Disposition=attachment;filename=FileName.txt該種形式的響應頭,如果有,則按照該響應頭中指定的文件名命名文件,如FileName.txt
• 如果上述響應頭不存在,則檢查下載的文件url,例如:http://image.baidu.com/abc.jpg,那么將會自動以abc.jpg命名文件
• 如果url也把文件名解析不出來,那么最終將以nofilename命名文件； 

/**
 * 下載文件
 * @param url 下載地址
 * @param destFileDir 保存文件路徑
 * @param destFileName 保存文件名
 */
private void downLoad(String url, String destFileDir, String destFileName){
    OkGo.get(url)//
            .tag(this)//
            .execute(new FileCallback(destFileDir, destFileName) {  //文件下載時，可以指定下載的文件目錄和文件名
                @Override
                public void onSuccess(File file, Call call, Response response) {
                    // file 即為文件數據，文件保存在指定目錄
                }

                @Override
                public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
                    //這里回調下載進度(該回調在主線程,可以直接更新ui)
                    //currentSize totalSize以字節byte為單位
                }
            });
}

大文件上傳；

/**
* 多文件上傳
* @param url
* @param keyName
* @param files 文件集合
*/
private void uploadFiles(String url, String keyName, List<File> files){
  OkGo.post(url)//
          .tag(this)//
          //.isMultipart(true)       // 強制使用 multipart/form-data 表單上傳（只是演示，不需要的話不要設置。默認就是false）
          //.params("param1", "paramValue1")        // 這里可以上傳參數
          //.params("file1", new File("filepath1"))   // 可以添加文件上傳
          //.params("file2", new File("filepath2"))     // 支持多文件同時添加上傳
          .addFileParams(keyName, files)    // 這里支持一個key傳多個文件
          .execute(new StringCallback() {
              @Override
              public void onSuccess(String s, Call call, Response response) {
                  //上傳成功
                  Toast.makeText(getApplicationContext(), "上傳成功", Toast.LENGTH_SHORT).show();
              }

              @Override
              public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
                  //這里回調上傳進度(該回調在主線程,可以直接更新ui)
                  mProgressBar.setProgress((int) (100 * progress));
                  mTextView2.setText("已上傳" + currentSize/1024/1024 + "MB, 共" + totalSize/1024/1024 + "MB;");
              }
          });
}

請求加載圖片；

/**
 * 請求網絡圖片
 * @param url
 */
private void getBitmap(String url) {
    OkGo.get(url)//
            .tag(this)//
            .execute(new BitmapCallback() {
                @Override
                public void onSuccess(Bitmap bitmap, Call call, Response response) {
                    // bitmap 即為返回的圖片數據
                    mImageView.setImageBitmap(bitmap);
                }
            });
}

取消請求。每個請求前都設置了一個參數tag，取消則通過OkGo.cancel(tag)執行。 例如：在Activity中，當Activity銷毀取消請求，可以在onDestory里面統一取消；

@Override
protected void onDestroy() {
    super.onDestroy();

    //根據 Tag 取消請求
    OkGo.getInstance().cancelTag(this);

    //取消所有請求
    OkGo.getInstance().cancelAll();
}

其他細節還是多看官方文檔，寫的還是非常詳細的。

四、栗子演示及源碼下載

   效果演示

   下載鏈接

 

一、簡介

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

github地址：https://github.com/jeasonlzy/okhttp-OkGo

什么是304？

二、添加依賴

//默認添加okhttp3.4.1、okio1.9.0
compile 'com.lzy.net:okgo:2.1.4'

三、解鎖技能

1. 進行全局配置，一般在 Aplication，或者基類的onCreate方法中，只需要調用一次即可，可以配置調試開關，全局的超時時間，公共的請求頭和請求參數等信息。如果在Aplication中初始化，需要在清單文件中注冊 Aplication。

   //---------這里給出的是示例代碼,告訴你可以這么傳,實際使用的時候,根據需要傳,不需要就不傳-------------//
      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.init(this);
   
      //以下設置的所有參數是全局參數,同樣的參數可以在請求的時候再設置一遍,那么對於該請求來講,請求中的參數會覆蓋全局參數
      //好處是全局參數統一,特定請求可以特別定制參數
      try {
          //以下都不是必須的，根據需要自行選擇,一般來說只需要 debug,緩存相關,cookie相關的 就可以了
          OkGo.getInstance()
   
              // 打開該調試開關,打印級別INFO,並不是異常,是為了顯眼,不需要就不要加入該行
              // 最后的true表示是否打印okgo的內部異常，一般打開方便調試錯誤
              .debug("OkGo", Level.INFO, true)
   
              //如果使用默認的 60秒,以下三行也不需要傳
              .setConnectTimeout(OkGo.DEFAULT_MILLISECONDS)  //全局的連接超時時間
              .setReadTimeOut(OkGo.DEFAULT_MILLISECONDS)     //全局的讀取超時時間
              .setWriteTimeOut(OkGo.DEFAULT_MILLISECONDS)    //全局的寫入超時時間
   
              //可以全局統一設置緩存模式,默認是不使用緩存,可以不傳,具體其他模式看 github 介紹 https://github.com/jeasonlzy/
              .setCacheMode(CacheMode.NO_CACHE)
   
              //可以全局統一設置緩存時間,默認永不過期,具體使用方法看 github 介紹
              .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)
   
              //可以全局統一設置超時重連次數,默認為三次,那么最差的情況會請求4次(一次原始請求,三次重連請求),不需要可以設置為0
              .setRetryCount(3)
   
              //如果不想讓框架管理cookie（或者叫session的保持）,以下不需要
      // .setCookieStore(new MemoryCookieStore()) //cookie使用內存緩存（app退出后，cookie消失）
              .setCookieStore(new PersistentCookieStore())        //cookie持久化存儲，如果cookie不過期，則一直有效
   
              //可以設置https的證書,以下幾種方案根據需要自己設置
              .setCertificates()                                  //方法一：信任所有證書,不安全有風險
      // .setCertificates(new SafeTrustManager()) //方法二：自定義信任規則，校驗服務端證書
      // .setCertificates(getAssets().open("srca.cer")) //方法三：使用預埋證書，校驗服務端證書（自簽名證書）
      // //方法四：使用bks證書和密碼管理客戶端證書（雙向認證），使用預埋證書，校驗服務端證書（自簽名證書）
      // .setCertificates(getAssets().open("xxx.bks"), "123456", getAssets().open("yyy.cer"))//
   
              //配置https的域名匹配規則，詳細看demo的初始化介紹，不需要就不要加入，使用不當會導致https握手失敗
      // .setHostnameVerifier(new SafeHostnameVerifier())
   
              //可以添加全局攔截器，不需要就不要加入，錯誤寫法直接導致任何回調不執行
      // .addInterceptor(new Interceptor() {
      // @Override
      // public Response intercept(Chain chain) throws IOException {
      // return chain.proceed(chain.request());
      // }
      // })
   
              //這兩行同上，不需要就不要加入
              .addCommonHeaders(headers)  //設置全局公共頭
              .addCommonParams(params);   //設置全局公共參數
   
      } catch (Exception e) {
          e.printStackTrace();
      }    

2. 使用get請求獲取數據；

    /** * get請求獲取數據 * @param url */
     private void getByOkGo(String url){
         OkGo.get(url)                            // 請求方式和請求url
                 .tag(this)                       // 請求的 tag, 主要用於取消對應的請求
                 .cacheKey("cacheKey")            // 設置當前請求的緩存key,建議每個不同功能的請求設置一個
                 .cacheMode(CacheMode.DEFAULT)    // 緩存模式，詳細請看緩存介紹
                 .execute(new StringCallback() {
                     @Override
                     public void onSuccess(String s, Call call, Response response) {
                         mTextView2.setText(s);
                     }
                 });
     }

3. post請求獲取數據，其中params方法用來添加請求參數，params添加參數的時候,最后一個isReplace為可選參數,默認為true,即代表相同key的時候,后添加的會覆蓋先前添加的；

    /** * post請求 * @param url */
     private void postByOkGo(String url){
         OkGo.post(url)
                 .tag(this)
                 .cacheKey("cachePostKey")
                 .cacheMode(CacheMode.DEFAULT)
                 .params("method", "album.item.get")
                 .params("appKey", "myKey")
                 .params("format", "json")
                 .params("albumId", "Lqfme5hSolM")
                 .params("pageNo", "1")
                 .params("pageSize", "2")
                 .execute(new StringCallback() {
                     @Override
                     public void onSuccess(String s, Call call, Response response) {
                         mTextView2.setText(s);
                     }
   
                     @Override
                     public void onError(Call call, Response response, Exception e) {
                         super.onError(call, response, e);
                         mTextView2.setText(e.getMessage());
                     }
                 });
     }

4. 文件下載，FileCallback具有三個重載的構造方法，文件目錄如果不指定,默認下載的目錄為 sdcard/download/，文件名如果不指定,則按照以下規則命名:

   • 首先檢查用戶是否傳入了文件名,如果傳入,將以用戶傳入的文件名命名
   • 如果沒有傳入,那么將會檢查服務端返回的響應頭是否含有Content-Disposition=attachment;filename=FileName.txt該種形式的響應頭,如果有,則按照該響應頭中指定的文件名命名文件,如FileName.txt
   • 如果上述響應頭不存在,則檢查下載的文件url,例如:http://image.baidu.com/abc.jpg,那么將會自動以abc.jpg命名文件
   • 如果url也把文件名解析不出來,那么最終將以nofilename命名文件； 
     

     /** * 下載文件 * @param url 下載地址 * @param destFileDir 保存文件路徑 * @param destFileName 保存文件名 */
     private void downLoad(String url, String destFileDir, String destFileName){
         OkGo.get(url)//
                 .tag(this)//
                 .execute(new FileCallback(destFileDir, destFileName) {  //文件下載時，可以指定下載的文件目錄和文件名
                     @Override
                     public void onSuccess(File file, Call call, Response response) {
                         // file 即為文件數據，文件保存在指定目錄
                     }
     
                     @Override
                     public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
                         //這里回調下載進度(該回調在主線程,可以直接更新ui)
                         //currentSize totalSize以字節byte為單位
                     }
                 });
     }

5. 大文件上傳；

   /** * 多文件上傳 * @param url * @param keyName * @param files 文件集合 */
   private void uploadFiles(String url, String keyName, List<File> files){
     OkGo.post(url)//
             .tag(this)//
             //.isMultipart(true) // 強制使用 multipart/form-data 表單上傳（只是演示，不需要的話不要設置。默認就是false）
             //.params("param1", "paramValue1") // 這里可以上傳參數
             //.params("file1", new File("filepath1")) // 可以添加文件上傳
             //.params("file2", new File("filepath2")) // 支持多文件同時添加上傳
             .addFileParams(keyName, files)    // 這里支持一個key傳多個文件
             .execute(new StringCallback() {
                 @Override
                 public void onSuccess(String s, Call call, Response response) {
                     //上傳成功
                     Toast.makeText(getApplicationContext(), "上傳成功", Toast.LENGTH_SHORT).show();
                 }
   
                 @Override
                 public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
                     //這里回調上傳進度(該回調在主線程,可以直接更新ui)
                     mProgressBar.setProgress((int) (100 * progress));
                     mTextView2.setText("已上傳" + currentSize/1024/1024 + "MB, 共" + totalSize/1024/1024 + "MB;");
                 }
             });
   }

6. 請求加載圖片；

   /** * 請求網絡圖片 * @param url */
   private void getBitmap(String url) {
       OkGo.get(url)//
               .tag(this)//
               .execute(new BitmapCallback() {
                   @Override
                   public void onSuccess(Bitmap bitmap, Call call, Response response) {
                       // bitmap 即為返回的圖片數據
                       mImageView.setImageBitmap(bitmap);
                   }
               });
   }

7. 取消請求。每個請求前都設置了一個參數tag，取消則通過OkGo.cancel(tag)執行。 例如：在Activity中，當Activity銷毀取消請求，可以在onDestory里面統一取消；

   @Override
   protected void onDestroy() {
       super.onDestroy();
   
       //根據 Tag 取消請求
       OkGo.getInstance().cancelTag(this);
   
       //取消所有請求
       OkGo.getInstance().cancelAll();
   }

8. 其他細節還是多看官方文檔，寫的還是非常詳細的。

四、栗子演示及源碼下載

   效果演示

   下載鏈接