詳解 Android okhttp 網絡請求get，post傳輸數據的基本用法

官網網址：http://square.github.io/okhttp/
github地址：https://github.com/square/okhttp

 

OKHttp優點

1、支持HTTP2/SPDY（SPDY是Google開發的基於TCP的傳輸層協議，用以最小化網絡延遲，提升網絡速度，優化用戶的網絡使用體驗。）
2、socket自動選擇最好路線，並支持自動重連，擁有自動維護的socket連接池，減少握手次數，減少了請求延遲，共享Socket,減少對服務器的請求次數。
3、基於Headers的緩存策略減少重複的網絡請求。
4、擁有Interceptors輕鬆處理請求與響應（自動處理GZip壓縮）。

OKHttp的功能

1、PUT，DELETE，POST，GET等請求
2、文件的上傳下載
3、加載圖片(內部會圖片大小自動壓縮)
4、支持請求回調，直接返回對象、對象集合
5、支持session的保持

流程圖

核心的類：

OkHttpClient：客戶端對象
Request：訪問請求，Post請求中需要包含RequestBody
RequestBody：請求數據，在Post請求中用到
Response：即網絡請求的響應結果
MediaType：數據類型，用來表明數據是json，image，pdf等一系列格式
client.newCall(request).execute()：同步的請求方法
client.newCall(request).enqueue(Callback callBack)：異步的請求方法，但Callback是執行在子線程中的，因此不能在此進行UI更新操作

實現步驟

一、在app/build.gradle中添加引用

dependencies {
    implementation "com.squareup.okhttp3:okhttp:3.12.1" 
    implementation 'com.squareup.okio:okio:2.1.0' //依賴庫
}

二、在manifest.xml中添加網絡權限 

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

三、使用方法

使用OKHttp進行網絡請求支持兩種方式，一種是同步請求，一種是異步請求。

 

1、get的同步請求

對於同步請求在請求時需要開啓子線程，請求成功後需要跳轉到UI線程修改UI。

public void getData(){
    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();
}

此時打印結果如下：

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 getData() {
        String url = Urls.INFO + "?guestId=" + guestId;
        OkHttpClient client = new OkHttpClient();
        Request request = new Request.Builder().url(url).get().build();
        Call call = client.newCall(request);
        //異步調用並設置回調函數
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        Toast.makeText(MemberInfoActivity.this, "獲取數據失敗", Toast.LENGTH_SHORT).show();
                    }
                });
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                final String responseStr = response.body().string();
                if (response.code() == 200) {//請求和獲取數據成功
                    runOnUiThread(new Runnable() {
                        @Override
                        public void run() {
                            try {
                                JSONObject jb = new JSONObject(responseStr);
                                mUserInfoVO = JsonUtil.getModelFromJSON(jb.optString("data"),UserInfoVO.class);
                                updateView();
                            } catch (JSONException e) {
                                e.printStackTrace();
                            }
                        }
                    });
                } else {
                    runOnUiThread(new Runnable() {
                        @Override
                        public void run() {
                            try {
                                JSONObject jsonObject = new JSONObject(responseStr);
                                Toast.makeText(MemberInfoActivity.this, jsonObject.optString("message"), Toast.LENGTH_SHORT).show();
                            } catch (JSONException e) {
                                e.printStackTrace();
                            }
                        }
                    });

                }
            }
        });
    }

異步請求的打印結果與注意事項與同步請求時相同。最大的不同點就是異步請求不需要開啓子線程，enqueue方法會自動將網絡請求部分放入子線程中執行。

注意事項：

1，回調接口的onFailure方法和onResponse執行在子線程。
2，response.body().string()方法也必須放在子線程中。當執行這行代碼得到結果後，再跳轉到UI線程修改UI。

3、post請求的使用方法

Post請求也分同步和異步兩種方式，同步與異步的區別和get方法類似，所以此時只講解post異步請求的使用方法

private void postData() {
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異步請求相同，此處省略
}

4、Post 字符串

OkHttpClient client = new OkHttpClient();
                StringBuffer sb = new StringBuffer();
                sb.append("{\"clientid\":\"" + PreferencesUtil.getUserPreferences(Constants.CLIENTID) + "\",");
                sb.append("\"password\":\"" + password + "\",");
                sb.append("\"phone\":\"" + phone + "\"}");
                String url = Urls.LOGIN;
                RequestBody updateDataBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), sb.toString());
                Request request = new Request.Builder().url(url).post(updateDataBody).build();

                Call call = client.newCall(request);
                //異步調用並設置回調函數
                call.enqueue(new Callback() {
                    @Override
                    public void onFailure(Call call, IOException e) {
                        TUtil.showToast(LoginActivity.this, "請檢查網絡");
                    }

                    @Override
                    public void onResponse(Call call, Response response) throws IOException {
                        try {
                            String responseStr = response.body().string();
                            final JSONObject jb = new JSONObject(responseStr);
                            if (response.code() == 200) {
                                runOnUiThread(new Runnable() {
                                    @Override
                                    public void run() {
                                        String uniqueId = jb.optString("data");
                                        PreferencesUtil.saveUserPreferences(Constants.UNIQUE_ID, uniqueId);
                                        startActivity(new Intent(LoginActivity.this, MainActivity.class));
                                    }
                                });
                            } else {
                                String messages = jb.optString("messages");
                                TUtil.showToast(LoginActivity.this, messages);

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

 

TUtil.java 

public class TUtil {

    public static void showToast(final Activity activity, final String message) {
        if ("main".equals(Thread.currentThread().getName())) {
            Log.e("TUtil", "在主線程");
            Toast.makeText(activity, message, Toast.LENGTH_SHORT).show();
        } else {
            activity.runOnUiThread(new Runnable() {
                @Override
                public void run() {
                    Log.e("TUtil", "不在主線程");
                    Toast.makeText(activity, message, Toast.LENGTH_SHORT).show();
                }
            });
        }
    }

}

 

5、使用RequestBody傳遞Json或File對象

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

這種方式可以上傳Json對象或File對象。

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() {。。。});//此處省略回調方法。

上傳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() {。。。});//此處省略回調方法。

6、使用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() {。。。});

7、自定義RequestBody實現流的上傳

在上面的分析中我們知道，只要是RequestBody類以及子類都可以作爲post方法的參數，下面我們就自定義一個類，繼承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);
    }
}
};

然後使用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() {。。。});

以上代碼的與衆不同就是body對象，這個body對象重寫了write方法，裏面有個sink對象。這個是OKio包中的輸出流，有write方法。使用這個方法我們可以實現上傳流的功能。
使用RequestBody上傳文件時，並沒有實現斷點續傳的功能。我可以使用這種方法結合RandomAccessFile類實現斷點續傳的功能。

8、設置請求頭

OKHttp中設置請求頭特別簡單，在創建request對象時調用一個方法即可。

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

 

9、下載文件

在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;

 }

10、對於OKHttp的使用封裝

由於okhttp是偏底層的網絡請求類庫，返回結果的回調方法仍然執行在子線程中，需要自己跳轉到UI線程，使用麻煩。爲了使用方便需要對OKHttp進行再次封裝。對於OKHttp的封裝首推的就是hongyang大神的OKHttpUtils

github的地址是：https://github.com/guozhengXia/OkHttpUtils

 

學習文章地址：https://www.jianshu.com/p/e6e0de569d38