2. 程式人生 > >OKHttp使用詳解，步驟挺詳細的，適合初學者使用！

OKHttp使用詳解，步驟挺詳細的，適合初學者使用！

阿新 • • 發佈：2019-01-03

一，OKHttp介紹

okhttp是一個第三方類庫，用於android中請求網路。

這是一個開源專案,是安卓端最火熱的輕量級框架,由移動支付Square公司貢獻(該公司還貢獻了Picasso和LeakCanary) 。用於替代HttpUrlConnection和Apache HttpClient(android API23 裡已移除HttpClient)。

okhttp有自己的官網，官網網址：OKHttp官網

在AndroidStudio中使用不需要下載jar包，直接新增依賴即可： 
compile ‘com.squareup.okhttp3:okhttp:3.4.1’

下面對以OKHttp3來詳細介紹OKHttp的使用方法。

二，get請求的使用方法

使用OKHttp進行網路請求支援兩種方式，一種是同步請求，一種是非同步請求。下面分情況進行介紹。

1，get的同步請求

對於同步請求在請求時需要開啟子執行緒，請求成功後需要跳轉到UI執行緒修改UI。 
使用示例如下：

public void getDatasync(){
    new Thread(new Runnable() {
        @Override
        public void run() {
            try {
                OkHttpClient client = new OkHttpClient();//建立OkHttpClient物件
 

                Request request = new Request.Builder()
                        .url("http://www.baidu.com")//請求介面。如果需要傳參拼接到介面後面。
                        .build();//建立Request 物件
                Response response = null;
                response = client.newCall(request).execute();//得到Response 物件
                if
 
 (response.isSuccessful()) {
                Log.d("kwwl","response.code()=="+response.code());
                Log.d("kwwl","response.message()=="+response.message());
                Log.d("kwwl","res=="+response.body().string());
                //此時的程式碼執行在子執行緒，修改UI的操作請使用handler跳轉到UI執行緒。
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }).start();
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24

此時列印結果如下： 
response.code()==200； 
response.message()==OK； 
res=={“code”:200,”message”:success};

注意事項： 
1，Response.code是http響應行中的code，如果訪問成功則返回200.這個不是伺服器設定的，而是http協議中自帶的。res中的code才是伺服器設定的。注意二者的區別。 
2，response.body().string()本質是輸入流的讀操作，所以它還是網路請求的一部分，所以這行程式碼必須放在子執行緒。 
3，response.body().string()只能呼叫一次，在第一次時有返回值，第二次再呼叫時將會返回null。原因是：response.body().string()的本質是輸入流的讀操作，必須有伺服器的輸出流的寫操作時客戶端的讀操作才能得到資料。而伺服器的寫操作只執行一次，所以客戶端的讀操作也只能執行一次，第二次將返回null。

2，get的非同步請求

這種方式不用再次開啟子執行緒，但回撥方法是執行在子執行緒中，所以在更新UI時還要跳轉到UI執行緒中。 
使用示例如下：

private void getDataAsync() {
    OkHttpClient client = new OkHttpClient();
    Request request = new Request.Builder()
            .url("http://www.baidu.com")
            .build();
    client.newCall(request).enqueue(new Callback() {
        @Override
        public void onFailure(Call call, IOException e) {
        }
        @Override
        public void onResponse(Call call, Response response) throws IOException {
            if(response.isSuccessful()){//回撥的方法執行在子執行緒。
                Log.d("kwwl","獲取資料成功了");
                Log.d("kwwl","response.code()=="+response.code());
                Log.d("kwwl","response.body().string()=="+response.body().string());
            }
        }
    });
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20

非同步請求的列印結果與注意事項與同步請求時相同。最大的不同點就是非同步請求不需要開啟子執行緒，enqueue方法會自動將網路請求部分放入子執行緒中執行。

注意事項： 
1，回撥介面的onFailure方法和onResponse執行在子執行緒。 
2，response.body().string()方法也必須放在子執行緒中。當執行這行程式碼得到結果後，再跳轉到UI執行緒修改UI。

三，post請求的使用方法

Post請求也分同步和非同步兩種方式，同步與非同步的區別和get方法類似，所以此時只講解post非同步請求的使用方法。 
使用示例如下：

private void postDataWithParame() {
    OkHttpClient client = new OkHttpClient();//建立OkHttpClient物件。
    FormBody.Builder formBody = new FormBody.Builder();//建立表單請求體
    formBody.add("username","zhangsan");//傳遞鍵值對引數
    Request request = new Request.Builder()//建立Request 物件。
            .url("http://www.baidu.com")
            .post(formBody.build())//傳遞請求體
            .build();
    client.newCall(request).enqueue(new Callback() {。。。});//回撥方法的使用與get非同步請求相同，此時略。
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

看完程式碼我們會發現：post請求中並沒有設定請求方式為POST，回憶在get請求中也沒有設定請求方式為GET，那麼是怎麼區分請求方式的呢？重點是Request.Builder類的post方法，在Request.Builder物件建立最初預設是get請求，所以在get請求中不需要設定請求方式，當呼叫post方法時把請求方式修改為POST。所以此時為POST請求。

四，POST請求傳遞引數的方法總結

在post請求使用方法中講了一種傳遞引數的方法，就是建立表單請求體物件，然後把表單請求體物件作為post方法的引數。post請求傳遞引數的方法還有很多種，但都是通過post方法傳遞的。下面我們看一下Request.Builder類的post方法的宣告：

public Builder post(RequestBody body)
  • 1

由方法的宣告可以看出，post方法接收的引數是RequestBody 物件，所以只要是RequestBody 類以及子類物件都可以當作引數進行傳遞。FormBody就是RequestBody 的一個子類物件。

1，使用FormBody傳遞鍵值對引數

這種方式用來上傳String型別的鍵值對 
使用示例如下：

private void postDataWithParame() {
    OkHttpClient client = new OkHttpClient();//建立OkHttpClient物件。
    FormBody.Builder formBody = new FormBody.Builder();//建立表單請求體
    formBody.add("username","zhangsan");//傳遞鍵值對引數
    Request request = new Request.Builder()//建立Request 物件。
            .url("http://www.baidu.com")
            .post(formBody.build())//傳遞請求體
            .build();
    client.newCall(request).enqueue(new Callback() {。。。});//此處省略回撥方法。
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

2，使用RequestBody傳遞Json或File物件

RequestBody是抽象類，故不能直接使用，但是他有靜態方法create，使用這個方法可以得到RequestBody物件。

這種方式可以上傳Json物件或File物件。 
上傳json物件使用示例如下：

OkHttpClient client = new OkHttpClient();//建立OkHttpClient物件。
MediaType JSON = MediaType.parse("application/json; charset=utf-8");//資料型別為json格式，
String jsonStr = "{\"username\":\"lisi\",\"nickname\":\"李四\"}";//json資料.
RequestBody body = RequestBody.create(JSON, josnStr);
Request request = new Request.Builder()
        .url("http://www.baidu.com")
        .post(body)
        .build();
client.newCall(request).enqueue(new Callback() {。。。});//此處省略回撥方法。
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

上傳File物件使用示例如下：

OkHttpClient client = new OkHttpClient();//建立OkHttpClient物件。
MediaType fileType = MediaType.parse("File/*");//資料型別為json格式，
File file = new File("path");//file物件.
RequestBody body = RequestBody.create(fileType , file );
Request request = new Request.Builder()
        .url("http://www.baidu.com")
        .post(body)
        .build();
client.newCall(request).enqueue(new Callback() {。。。});//此處省略回撥方法。
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

3，使用MultipartBody同時傳遞鍵值對引數和File物件

這個字面意思是多重的body。我們知道FromBody傳遞的是字串型的鍵值對，RequestBody傳遞的是多媒體，那麼如果我們想二者都傳遞怎麼辦？此時就需要使用MultipartBody類。 
使用示例如下：

OkHttpClient client = new OkHttpClient();
MultipartBody multipartBody =new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart("groupId",""+groupId)//新增鍵值對引數
        .addFormDataPart("title","title")
        .addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/*"), file))//新增檔案
        .build();
final Request request = new Request.Builder()
        .url(URLContant.CHAT_ROOM_SUBJECT_IMAGE)
        .post(multipartBody)
        .build();
client.newCall(request).enqueue(new Callback() {。。。});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

4，自定義RequestBody實現流的上傳

在上面的分析中我們知道，只要是RequestBody類以及子類都可以作為post方法的引數，下面我們就自定義一個類，繼承RequestBody，實現流的上傳。 
使用示例如下： 
首先建立一個RequestBody類的子類物件：

RequestBody body = new RequestBody() {
    @Override
    public MediaType contentType() {
        return null;
    }

    @Override
    public void writeTo(BufferedSink sink) throws IOException {//重寫writeTo方法
        FileInputStream fio= new FileInputStream(new File("fileName"));
        byte[] buffer = new byte[1024*8];
        if(fio.read(buffer) != -1){
             sink.write(buffer);
        }
    }
};
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

然後使用body物件：

 OkHttpClient client = new OkHttpClient();//建立OkHttpClient物件。
Request request = new Request.Builder()
        .url("http://www.baidu.com")
        .post(body)
        .build();
client.newCall(request).enqueue(new Callback() {。。。});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

以上程式碼的與眾不同就是body物件，這個body物件重寫了write方法，裡面有個sink物件。這個是OKio包中的輸出流，有write方法。使用這個方法我們可以實現上傳流的功能。

使用RequestBody上傳檔案時，並沒有實現斷點續傳的功能。我可以使用這種方法結合RandomAccessFile類實現斷點續傳的功能。

五，設定請求頭

OKHttp中設定請求頭特別簡單，在建立request物件時呼叫一個方法即可。 
使用示例如下：

Request request = new Request.Builder()
                .url("http://www.baidu.com")
                .header("User-Agent", "OkHttp Headers.java")
                .addHeader("token", "myToken")
                .build();
  • 1
  • 2
  • 3
  • 4
  • 5

其他部分程式碼略。

六，下載檔案

在OKHttp中並沒有提供下載檔案的功能，但是在Response中可以獲取流物件，有了流物件我們就可以自己實現檔案的下載。程式碼如下： 
這段程式碼寫在回撥介面CallBack的onResponse方法中：

try{
    InputStream  is = response.body().byteStream();//從伺服器得到輸入流物件
    long sum = 0;
    File dir = new File(mDestFileDir);
    if (!dir.exists()){
        dir.mkdirs();
    }
    File file = new File(dir, mdestFileName);//根據目錄和檔名得到file物件
    FileOutputStream  fos = new FileOutputStream(file);
    byte[] buf = new byte[1024*8];
    int len = 0;
    while ((len = is.read(buf)) != -1){
        fos.write(buf, 0, len);
    }
    fos.flush();
    return file;

}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19

七，對於OKHttp的使用封裝

由於okhttp是偏底層的網路請求類庫，返回結果的回撥方法仍然執行在子執行緒中，需要自己跳轉到UI執行緒，使用麻煩。為了使用方便需要對OKHttp進行再次封裝。對於OKHttp的封裝首推的就是hongyang大神的OKHttpUtils。我個人在看過OKHttp的原碼和借鑑各大神的封裝原始碼後封裝了一套自己的OKHttpUtils。這套OKHttpUtils最大的優點是簡單和便於使用，這是我專案中實際用的網路請求工具類，完全可以說拿來即用。而且程式碼簡單，可供學習使用。

封裝的功能有： 
* 一般的get請求 
* 一般的post請求 
* 上傳單個檔案(包含進度) 
* 上傳list集合檔案 
* 上傳map集合檔案 
* 檔案下載(包含進度) 
* 圖片下載(實現了圖片的壓縮)

相關推薦

OKHttp使用詳解，步驟挺詳細的，適合初學者使用！

一，OKHttp介紹 okhttp是一個第三方類庫，用於android中請求網路。 這是一個開源專案,是安卓端最火熱的輕量級框架,由移動支付Square公司貢獻(該公司還貢獻了Picasso和LeakCanary) 。用於替代HttpUrlConnection和Apa

學習python最難的就是入門，而這文章剛好適合初學者！ python python入門

![在這裡插入圖片描述](https://img-blog.csdn.net/20181010113907330?watermar2018年4月的TIOBE排行榜，Python已經佔據第四的位置， Python崇尚優美、清晰、簡單，是一個優秀並廣泛使用的語言。k

Android整合微信登入的步驟詳解、遇到的問題，友盟分享遇到的問題

轉載的問題：http://www.jb51.net/article/93706.htm 這篇文章給大家整理Android整合微信登入的詳細步驟，通過文章整理的內容，大家只需要幾行程式碼就可以實現微信登入的功能了，剛興趣的朋友們下面來一起看看吧。歡迎提問~~~ 微信的： 1

BeautifulSoup 使用select方法詳解（通過標簽名，類名， id，組合，屬性查找）

chrome red 例如 ttl app user encode and 定位 import requestsfrom bs4 import BeautifulSoupblslib="html5lib"user_agent="Mozilla/5.0 (Macintosh;

一文詳解python的類方法，普通方法和靜態方法

http 接下來 方法調用 pytho 類和實例 訪問類 靜態 都是 com 　　首先形式上的區別，實例方法隱含的參數為類實例self，而類方法隱含的參數為類本身cls。 靜態方法無隱含參數，主要為了類實例也可以直接調用靜態方法。 　　所以邏輯上，類方法被類調用，實例方法

我盆友的學習筆記，記得挺詳細的 部分摘自博友

tor rec ges san 渲染 去掉 sass firefox 空間擴展 HTML5 CSS3 部分css屬性或標簽 1、 <!DOCTYPE html> 文檔類型聲明，告訴瀏覽器如何渲染html <html lang="

詳解 MySQL 高可用群集，MMM搭建高可用

cti 主從復制 防火墻 操作系統 oracl pat -- utf8 set 目錄： 1·MMM 簡介2·MMM 各個角色說明3·案例環境介紹4·案例實施5·總結 一：MMM 簡介： 1）MMM 是什麽：說得簡單點，就是 MySQL 主主復制的管理器。之前的一篇文

ThreadLocal詳解（不看後悔，一看必懂）

ThreadLocal概要 我們可以使用synchorinized 關鍵字來為變數加鎖以解決執行緒安全問題，從而限制只能有一個執行緒來使用此變數，但是加鎖會大大影響程式執行效率 ThreadLocal是執行緒區域性變數（從執行緒的角度看，目標變數就像是執行緒的本地變數）， 通常

ThreadPoolExecutor詳解（不看後悔，一看必懂）

構造器引數分析 第四個構造器原始碼 corePoolSize:核心池的大小 預設情況下,在建立了執行緒池後,執行緒池中的執行緒數為0,當有任務來之後,就會建立一個執行緒去執行任務,當執行緒池中的執行緒數數目少於corePoolSize時,有新任務進來就新建一個執行緒,即使

圖文詳解Java中的servlet，以及servlet中使用到的關鍵技術

Servlet是Java中實現動態網頁的技術： 如果有想學習java的程式設計師，可來我們的java學習扣qun：79979，2590免費送java的視訊教程噢！小編是一名5年java開發經驗的全棧工程師，整理了一份適合18年學習的java乾貨，送給每一位想學的小夥伴，歡迎大家一起學習哦。

TCP-IP詳解筆記7： DNS，域名系統

概念 DNS 是一種用於TCP/IP應用程式的__分散式資料庫__,提供了主機名字和IP地址之間的轉換和有關電子郵件的選路資訊。 DNS基礎 層次結構， 每個節點有一個至多63個字元長的標識， 不區分大

Kotlin詳解：第三章，實戰

一，搭建開發環境 1，安裝Android Studio 3.0及以上版本 2，升級Gradle外掛版本至少為4.1 3，升級Kotlin外掛版本 4，工程配置 ①，配置工程build.gradle buildscript { ext.kotlin_version = '

折半查詢和遞迴折半查詢詳解（二分法查詢，遞迴二分法查詢）

演算法：當資料量很大適宜採用該方法。採用二分法查詢時，資料需是排好序的。（前提） 主要思想是：（設查詢的陣列區間為array[low, high]） （1）確定該區間的中間位置K （2）將查詢的值T與

SSM框架開發專案--用到的註解記錄，及詳解。（先記錄，後研究，再總結---未完）

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL) //保證序列化json的時候，如果是null的物件，key也會消失 public c

Spring 之AOP AspectJ切入點語法詳解（最全了，不需要再去其他地找了）

6.5  AspectJ切入點語法詳解 6.5.1  Spring AOP支援的AspectJ切入點指示符        切入點指示符用來指示切入點表示式目的，，在Spring AOP中目前只有執行方法這一個連線點，Spring AOP支援的AspectJ切入點指示符

VS2015+QT5.8 程式打包釋出詳解（包含圖片打包，附工具和原始碼）

之前按照百度的釋出教程，在自己的電腦打得開，在別人電腦打不開，弄了一會，總結的經驗如下： 1.打包程式 第一步：在vs2015中，以release方式除錯程式，然後會在專案資料夾的x64\relea

Java web程式設計之基礎理論詳解（計算機網路基礎，HTTP請求的完成過程）

1.計算機網路基礎知識 首先我們需明確通訊系統互聯參考模型： OSI/RM模型與TCP/IP模型：                  OSI/RM模型是一種事實上被TCP/IP模型淘汰的模型，在當今世界上沒有大規模使用。當發生HTTP請求時，傳送方傳送的資料是由最頂

單例模式詳解（餓漢式，懶漢式，登記式，列舉式，序列化和反序列）

一、單例模式應用場景：保證一個類僅有一個例項，並提供一個訪問它的全域性訪問點。 應用場景：保證一個類僅有一個例項，並提供一個訪問它的全域性訪問點。 Spring 中的單例模式完成了後半句話，即提供了全域性的訪問點 BeanFactory。但沒有從構造器級別去 控制單例，這是

C++模板的特化詳解（函式模版特殊，類模版特化）

模版與特化的概念 函式模版與類模版 C++中模板分為函式模板和類模板 函式模板：是一種抽象函式定義，它代表一類同構函式。 類模板：是一種更高層次的抽象的類定義。 特化的概念 所謂特化，就是將泛型的東東搞得具體化一些，從字面上

Git詳解 一 （Git介紹，單人本地倉庫操作）

1.Git簡介 Git Git 是目前世界上最先進的分散式版本控制系統（沒有之一） 作用 原始碼管理 為什麼要進行原始碼管理? 方便多人協同開發 方便版本控制 Git管理原始碼特點 1.Git是分散式管理.伺服器和客戶端都有版本控制能力,都能進行程式碼的提交、合併、… 2.Git會在根