Android OkHttp徹底解析 是時候來了解OkHttp了
分類：
版權聲明：本文爲博主原創文章，未經博主容許不得轉載。html
轉載請標明出處：
http://blog.csdn.net/lmj623565791/article/details/47911083；
本文出自:【張鴻洋的博客】android
1、概述
最近在羣裏聽到各類討論okhttp的話題，可見okhttp的口碑至關好了。再加上Google貌似在6.0版本里面刪除了HttpClient相關API，對於這個行爲不作評價。爲了更好的在應對網絡訪問，學習下okhttp仍是蠻必要的，本篇博客首先介紹okhttp的簡單使用，主要包含：git
- 通常的get請求
- 通常的post請求
- 基於Http的文件上傳
- 文件下載
- 加載圖片
- 支持請求回調，直接返回對象、對象集合
- 支持session的保持
最後會對上述幾個功能進行封裝，完整的封裝類的地址見：https://github.com/hongyangAndroid/okhttp-utilsgithub
使用前，對於Android Studio的用戶，能夠選擇添加:json
compile 'com.squareup.okhttp:okhttp:2.4.0'
- 1
- 1
或者Eclipse的用戶，能夠下載最新的jar okhttp he latest JAR ，添加依賴就能夠用了。數組
注意:okhttp內部依賴okio，別忘了同時導入okio：瀏覽器
gradle: compile 'com.squareup.okio:okio:1.5.0'服務器
最新的jar地址：okio the latest JARmarkdown
2、使用教程
（一）Http Get
對了網絡加載庫，那麼最多見的確定就是http get請求了，好比獲取一個網頁的內容。
//建立okHttpClient對象 OkHttpClient mOkHttpClient = new OkHttpClient(); //建立一個Request final Request request = new Request.Builder() .url("https://github.com/hongyangAndroid") .build(); //new call Call call = mOkHttpClient.newCall(request); //請求加入調度 call.enqueue(new Callback() { @Override public void onFailure(Request request, IOException e) { } @Override public void onResponse(final Response response) throws IOException { //String htmlStr = response.body().string(); } });
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
-
以上就是發送一個get請求的步驟，首先構造一個Request對象，參數最起碼有個url，固然你能夠經過Request.Builder設置更多的參數好比：
header、method等。 -
而後經過request的對象去構造獲得一個Call對象，相似於將你的請求封裝成了任務，既然是任務，就會有
execute()和cancel()等方法。 -
最後，咱們但願以異步的方式去執行請求，因此咱們調用的是call.enqueue，將call加入調度隊列，而後等待任務執行完成，咱們在Callback中便可獲得結果。
看到這，你會發現，總體的寫法仍是比較長的，因此封裝確定是要作的，否則每一個請求這麼寫，得累死。
ok，須要注意幾點：
-
onResponse回調的參數是response，通常狀況下，好比咱們但願得到返回的字符串，能夠經過
response.body().string()獲取；若是但願得到返回的二進制字節數組，則調用response.body().bytes()；若是你想拿到返回的inputStream，則調用response.body().byteStream()看到這，你可能會奇怪，居然還能拿到返回的inputStream，看到這個最起碼能意識到一點，這裏支持大文件下載，有inputStream咱們就能夠經過IO的方式寫文件。不過也說明一個問題，這個
onResponse執行的線程並非UI線程。的確是的，若是你但願操做控件，仍是須要使用handler等，例如：@Override public void onResponse(final Response response) throws IOException { final String res = response.body().string(); runOnUiThread(new Runnable() { @Override public void run() { mTv.setText(res); } }); }- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 咱們這裏是異步的方式去執行，固然也支持阻塞的方式，上面咱們也說了Call有一個
execute()方法，你也能夠直接調用call.execute()經過返回一個Response。
(二) Http Post 攜帶參數
看來上面的簡單的get請求，基本上整個的用法也就掌握了，好比post攜帶參數，也僅僅是Request的構造的不一樣。
Request request = buildMultipartFormRequest(
url, new File[]{file}, new String[]{fileKey}, null); FormEncodingBuilder builder = new FormEncodingBuilder(); builder.add("username","張鴻洋"); Request request = new Request.Builder() .url(url) .post(builder.build()) .build(); mOkHttpClient.newCall(request).enqueue(new Callback(){});
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
你們都清楚，post的時候，參數是包含在請求體中的；因此咱們經過FormEncodingBuilder。添加多個String鍵值對，而後去構造RequestBody，最後完成咱們Request的構造。
後面的就和上面同樣了。
（三）基於Http的文件上傳
接下來咱們在介紹一個能夠構造RequestBody的Builder，叫作MultipartBuilder。當咱們須要作相似於表單上傳的時候，就可使用它來構造咱們的requestBody。
File file = new File(Environment.getExternalStorageDirectory(), "balabala.mp4"); RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file); RequestBody requestBody = new MultipartBuilder() .type(MultipartBuilder.FORM) .addPart(Headers.of( "Content-Disposition", "form-data; name=\"username\""), RequestBody.create(null, "張鴻洋")) .addPart(Headers.of( "Content-Disposition", "form-data; name=\"mFile\"; filename=\"wjd.mp4\""), fileBody) .build(); Request request = new Request.Builder() .url("http://192.168.1.103:8080/okHttpServer/fileUpload") .post(requestBody) .build(); Call call = mOkHttpClient.newCall(request); call.enqueue(new Callback() { //... });
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
上述代碼向服務器傳遞了一個鍵值對username:張鴻洋和一個文件。咱們經過MultipartBuilder的addPart方法能夠添加鍵值對或者文件。
其實相似於咱們拼接模擬瀏覽器行爲的方式，若是你對這塊不瞭解，能夠參考：從原理角度解析Android （Java） http 文件上傳
ok，對於咱們最開始的目錄還剩下圖片下載，文件下載；這兩個一個是經過回調的Response拿到byte[]而後decode成圖片；文件下載，就是拿到inputStream作寫文件操做，咱們這裏就不贅述了。
關於用法，也能夠參考泡網OkHttp使用教程
接下來咱們主要看如何封裝上述的代碼。
3、封裝
因爲按照上述的代碼，寫多個請求確定包含大量的重複代碼，因此我但願封裝後的代碼調用是這樣的：
（一）使用
-
通常的get請求
OkHttpClientManager.getAsyn("https://www.baidu.com", new OkHttpClientManager.ResultCallback<String>() { @Override public void onError(Request request, Exception e) { e.printStackTrace(); } @Override public void onResponse(String u) { mTv.setText(u);//注意這裏是UI線程 } });- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
對於通常的請求，咱們但願給個url，而後CallBack裏面直接操做控件。
-
文件上傳且攜帶參數
咱們但願提供一個方法，傳入url,params,file,callback便可。
OkHttpClientManager.postAsyn("http://192.168.1.103:8080/okHttpServer/fileUpload",// new OkHttpClientManager.ResultCallback<String>() { @Override public void onError(Request request, IOException e) { e.printStackTrace(); } @Override public void onResponse(String result) { } },// file,// "mFile",// new OkHttpClientManager.Param[]{ new OkHttpClientManager.Param("username", "zhy"), new OkHttpClientManager.Param("password", "123")} );- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
鍵值對沒什麼說的，參數3爲file，參數4爲file對應的name，這個name不是文件的名字；
對應於http中的<input type="file" name="mFile" >對應的是name後面的值，即mFile.
-
文件下載
對於文件下載，提供url，目標dir，callback便可。
OkHttpClientManager.downloadAsyn( "http://192.168.1.103:8080/okHttpServer/files/messenger_01.png", Environment.getExternalStorageDirectory().getAbsolutePath(), new OkHttpClientManager.ResultCallback<String>() { @Override public void onError(Request request, IOException e) { } @Override public void onResponse(String response) { //文件下載成功，這裏回調的reponse爲文件的absolutePath } });- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
-
展現圖片
展現圖片，咱們但願提供一個url和一個imageview，若是下載成功，直接幫咱們設置上便可。
OkHttpClientManager.displayImage(mImageView, "http://images.csdn.net/20150817/1.jpg");- 1
- 2
- 1
- 2
內部會自動根據imageview的大小自動對圖片進行合適的壓縮。雖然，這裏可能不適合一次性加載大量圖片的場景，可是對於app中偶爾有幾個圖片的加載，仍是可用的。
4、整合Gson
不少人提出項目中使用時，服務端返回的是Json字符串，但願客戶端回調能夠直接拿到對象，因而整合進入了Gson，完善該功能。
（一）直接回調對象
例如如今有個User實體類：
package com.zhy.utils.http.okhttp; public class User { public String username ; public String password ; public User() { // TODO Auto-generated constructor stub } public User(String username, String password) { this.username = username; this.password = password; } @Override public String toString() { return "User{" + "username='" + username + '\'' + ", password='" + password + '\'' + '}'; } }
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
服務端返回：
{"username":"zhy","password":"123"}
- 1
- 1
客戶端能夠以下方式調用：
OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUser", new OkHttpClientManager.ResultCallback<User>() { @Override public void onError(Request request, Exception e) { e.printStackTrace(); } @Override public void onResponse(User user) { mTv.setText(u.toString());//UI線程 } });
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
咱們傳入泛型User，在onResponse裏面直接回調User對象。
這裏特別要注意的事，若是在json字符串->實體對象過程當中發生錯誤，程序不會崩潰，onError方法會被回調。
注意：這裏作了少量的更新，接口命名從StringCallback修改成ResultCallback。接口中的onFailure方法修改成onError。
(二) 回調對象集合
依然是上述的User類，服務端返回
[{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]
- 1
- 1
則客戶端能夠以下調用：
OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUsers", new OkHttpClientManager.ResultCallback<List<User>>() { @Override public void onError(Request request, Exception e) { e.printStackTrace(); } @Override public void onResponse(List<User> us) { Log.e("TAG", us.size() + ""); mTv.setText(us.get(1).toString()); } });
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
惟一的區別，就是泛型變爲List<User> ，ok ， 若是發現bug或者有任何意見歡迎留言。
源碼
ok，基本介紹完了，對於封裝的代碼其實也很簡單，我就直接貼出來了，由於也沒什麼好介紹的，若是你看完上面的用法，確定能夠看懂：
package com.zhy.utils.http.okhttp; import android.graphics.Bitmap; import android.graphics.BitmapFactory; import android.os.Handler; import android.os.Looper; import android.widget.ImageView; import com.google.gson.Gson; import com.google.gson.internal.$Gson$Types; import com.squareup.okhttp.Call; import com.squareup.okhttp.Callback; import com.squareup.okhttp.FormEncodingBuilder; import com.squareup.okhttp.Headers; import com.squareup.okhttp.MediaType; import com.squareup.okhttp.MultipartBuilder; import com.squareup.okhttp.OkHttpClient; import com.squareup.okhttp.Request; import com.squareup.okhttp.RequestBody; import com.squareup.okhttp.Response; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; import java.net.CookieManager; import java.net.CookiePolicy; import java.net.FileNameMap; import java.net.URLConnection; import java.util.HashMap; import java.util.Map; import java.util.Set; /** * Created by zhy on 15/8/17. */ public class OkHttpClientManager { private static OkHttpClientManager mInstance; private OkHttpClient mOkHttpClient; private Handler mDelivery; private Gson mGson; private static final String TAG = "OkHttpClientManager"; private OkHttpClientManager() { mOkHttpClient = new OkHttpClient(); //cookie enabled mOkHttpClient.setCookieHandler(new CookieManager(null, CookiePolicy.ACCEPT_ORIGINAL_SERVER)); mDelivery = new Handler(Looper.getMainLooper()); mGson = new Gson(); } public static OkHttpClientManager getInstance() { if (mInstance == null) { synchronized (OkHttpClientManager.class) { if (mInstance == null) { mInstance = new OkHttpClientManager(); } } } return mInstance; } /** * 同步的Get請求 * * @param url * @return Response */ private Response _getAsyn(String url) throws IOException { final Request request = new Request.Builder() .url(url) .build(); Call call = mOkHttpClient.newCall(request); Response execute = call.execute(); return execute; } /** * 同步的Get請求 * * @param url * @return 字符串 */ private String _getAsString(String url) throws IOException { Response execute = _getAsyn(url); return execute.body().string(); } /** * 異步的get請求 * * @param url * @param callback */ private void _getAsyn(String url, final ResultCallback callback) { final Request request = new Request.Builder() .url(url) .build(); deliveryResult(callback, request); } /** * 同步的Post請求 * * @param url * @param params post的參數 * @return */ private Response _post(String url, Param... params) throws IOException { Request request = buildPostRequest(url, params); Response response = mOkHttpClient.newCall(request).execute(); return response; } /** * 同步的Post請求 * * @param url * @param params post的參數 * @return 字符串 */ private String _postAsString(String url, Param... params) throws IOException { Response response = _post(url, params); return response.body().string(); } /** * 異步的post請求 * * @param url * @param callback * @param params */ private void _postAsyn(String url, final ResultCallback callback, Param... params) { Request request = buildPostRequest(url, params); deliveryResult(callback, request); } /** * 異步的post請求 * * @param url * @param callback * @param params */ private void _postAsyn(String url, final ResultCallback callback, Map<String, String> params) { Param[] paramsArr = map2Params(params); Request request = buildPostRequest(url, paramsArr); deliveryResult(callback, request); } /** * 同步基於post的文件上傳 * * @param params * @return */ private Response _post(String url, File[] files, String[] fileKeys, Param... params) throws IOException { Request request = buildMultipartFormRequest(url, files, fileKeys, params); return mOkHttpClient.newCall(request).execute(); } private Response _post(String url, File file, String fileKey) throws IOException { Request request = buildMultipartFormRequest(url, new File[]{file}, new String[]{fileKey}, null); return mOkHttpClient.newCall(request).execute(); } private Response _post(String url, File file, String fileKey, Param... params) throws IOException { Request request = buildMultipartFormRequest(url, new File[]{file}, new String[]{fileKey}, params); return mOkHttpClient.newCall(request).execute(); } /** * 異步基於post的文件上傳 * * @param url * @param callback * @param files * @param fileKeys * @throws IOException */ private void _postAsyn(String url, ResultCallback callback, File[] files, String[] fileKeys, Param... params) throws IOException { Request request = buildMultipartFormRequest(url, files, fileKeys, params); deliveryResult(callback, request); } /** * 異步基於post的文件上傳，單文件不帶參數上傳 * * @param url * @param callback * @param file * @param fileKey * @throws IOException */ private void _postAsyn(String url, ResultCallback callback, File file, String fileKey) throws IOException { Request request = buildMultipartFormRequest(url, new File[]{file}, new String[]{fileKey}, null); deliveryResult(callback, request); } /** * 異步基於post的文件上傳，單文件且攜帶其餘form參數上傳 * * @param url * @param callback * @param file * @param fileKey * @param params * @throws IOException */ private void _postAsyn(String url, ResultCallback callback, File file, String fileKey, Param... params) throws IOException { Request request = buildMultipartFormRequest(url, new File[]{file}, new String[]{fileKey}, params); deliveryResult(callback, request); } /** * 異步下載文件 * * @param url * @param destFileDir 本地文件存儲的文件夾 * @param callback */ private void _downloadAsyn(final String url, final String destFileDir, final ResultCallback callback) { final Request request = new Request.Builder() .url(url) .build(); final Call call = mOkHttpClient.newCall(request); call.enqueue(new Callback() { @Override public void onFailure(final Request request, final IOException e) { sendFailedStringCallback(request, e, callback); } @Override public void onResponse(Response response) { InputStream is = null; byte[] buf = new byte[2048]; int len = 0; FileOutputStream fos = null; try { is = response.body().byteStream(); File file = new File(destFileDir, getFileName(url)); fos = new FileOutputStream(file); while ((len = is.read(buf)) != -1) { fos.write(buf, 0, len); } fos.flush(); //若是下載文件成功，第一個參數爲文件的絕對路徑 sendSuccessResultCallback(file.getAbsolutePath(), callback); } catch (IOException e) { sendFailedStringCallback(response.request(), e, callback); } finally { try { if (is != null) is.close(); } catch (IOException e) { } try { if (fos != null) fos.close(); } catch (IOException e) { } } } }); } private String getFileName(String path) { int separatorIndex = path.lastIndexOf("/"); return (separatorIndex < 0) ? path : path.substring(separatorIndex + 1, path.length()); } /** * 加載圖片 * * @param view * @param url * @throws IOException */ private void _displayImage(final ImageView view, final String url, final int errorResId) { final Request request = new Request.Builder() .url(url) .build(); Call call = mOkHttpClient.newCall(request); call.enqueue(new Callback() {