Android OkHttp完全解析 是时候来了解OkHttp了
Android OkHttp完全解析 是時(shí)候來了解OkHttp了
標(biāo)簽:?AndroidOkHttp 2015-08-24 15:36?316254人閱讀?評(píng)論(306)?收藏?舉報(bào) ?分類: 【android 進(jìn)階之路】(67)?版權(quán)聲明:本文為博主原創(chuàng)文章,未經(jīng)博主允許不得轉(zhuǎn)載。
目錄(?)[+]
轉(zhuǎn)載請(qǐng)標(biāo)明出處:?
http://blog.csdn.net/lmj623565791/article/details/47911083;?
本文出自:【張鴻洋的博客】
一、概述
最近在群里聽到各種討論okhttp的話題,可見okhttp的口碑相當(dāng)好了。再加上Google貌似在6.0版本里面刪除了HttpClient相關(guān)API,對(duì)于這個(gè)行為不做評(píng)價(jià)。為了更好的在應(yīng)對(duì)網(wǎng)絡(luò)訪問,學(xué)習(xí)下okhttp還是蠻必要的,本篇博客首先介紹okhttp的簡單使用,主要包含:
- 一般的get請(qǐng)求
- 一般的post請(qǐng)求
- 基于Http的文件上傳
- 文件下載
- 加載圖片
- 支持請(qǐng)求回調(diào),直接返回對(duì)象、對(duì)象集合
- 支持session的保持
最后會(huì)對(duì)上述幾個(gè)功能進(jìn)行封裝,完整的封裝類的地址見:https://github.com/hongyangAndroid/okhttp-utils
使用前,對(duì)于Android?Studio的用戶,可以選擇添加:
compile 'com.squareup.okhttp:okhttp:2.4.0'- 1
- 1
或者Eclipse的用戶,可以下載最新的jar?okhttp he latest JAR?,添加依賴就可以用了。
注意:okhttp內(nèi)部依賴okio,別忘了同時(shí)導(dǎo)入okio:
gradle:?compile 'com.squareup.okio:okio:1.5.0'
最新的jar地址:okio the latest JAR
二、使用教程
(一)Http Get
對(duì)了網(wǎng)絡(luò)加載庫,那么最常見的肯定就是http get請(qǐng)求了,比如獲取一個(gè)網(wǎng)頁的內(nèi)容。
//創(chuàng)建okHttpClient對(duì)象 OkHttpClient mOkHttpClient = new OkHttpClient(); //創(chuàng)建一個(gè)Request final Request request = new Request.Builder() .url("https://github.com/hongyangAndroid") .build(); //new call Call call = mOkHttpClient.newCall(request); //請(qǐng)求加入調(diào)度 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
以上就是發(fā)送一個(gè)get請(qǐng)求的步驟,首先構(gòu)造一個(gè)Request對(duì)象,參數(shù)最起碼有個(gè)url,當(dāng)然你可以通過Request.Builder設(shè)置更多的參數(shù)比如:header、method等。
然后通過request的對(duì)象去構(gòu)造得到一個(gè)Call對(duì)象,類似于將你的請(qǐng)求封裝成了任務(wù),既然是任務(wù),就會(huì)有execute()和cancel()等方法。
最后,我們希望以異步的方式去執(zhí)行請(qǐng)求,所以我們調(diào)用的是call.enqueue,將call加入調(diào)度隊(duì)列,然后等待任務(wù)執(zhí)行完成,我們?cè)贑allback中即可得到結(jié)果。
看到這,你會(huì)發(fā)現(xiàn),整體的寫法還是比較長的,所以封裝肯定是要做的,不然每個(gè)請(qǐng)求這么寫,得累死。
ok,需要注意幾點(diǎn):
-
onResponse回調(diào)的參數(shù)是response,一般情況下,比如我們希望獲得返回的字符串,可以通過response.body().string()獲取;如果希望獲得返回的二進(jìn)制字節(jié)數(shù)組,則調(diào)用response.body().bytes();如果你想拿到返回的inputStream,則調(diào)用response.body().byteStream()
看到這,你可能會(huì)奇怪,竟然還能拿到返回的inputStream,看到這個(gè)最起碼能意識(shí)到一點(diǎn),這里支持大文件下載,有inputStream我們就可以通過IO的方式寫文件。不過也說明一個(gè)問題,這個(gè)onResponse執(zhí)行的線程并不是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
- 我們這里是異步的方式去執(zhí)行,當(dāng)然也支持阻塞的方式,上面我們也說了Call有一個(gè)execute()方法,你也可以直接調(diào)用call.execute()通過返回一個(gè)Response。
(二) Http Post 攜帶參數(shù)
看來上面的簡單的get請(qǐng)求,基本上整個(gè)的用法也就掌握了,比如post攜帶參數(shù),也僅僅是Request的構(gòu)造的不同。
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的時(shí)候,參數(shù)是包含在請(qǐng)求體中的;所以我們通過FormEncodingBuilder。添加多個(gè)String鍵值對(duì),然后去構(gòu)造RequestBody,最后完成我們Request的構(gòu)造。
后面的就和上面一樣了。
(三)基于Http的文件上傳
接下來我們?cè)诮榻B一個(gè)可以構(gòu)造RequestBody的Builder,叫做MultipartBuilder。當(dāng)我們需要做類似于表單上傳的時(shí)候,就可以使用它來構(gòu)造我們的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
上述代碼向服務(wù)器傳遞了一個(gè)鍵值對(duì)username:張鴻洋和一個(gè)文件。我們通過MultipartBuilder的addPart方法可以添加鍵值對(duì)或者文件。
其實(shí)類似于我們拼接模擬瀏覽器行為的方式,如果你對(duì)這塊不了解,可以參考:從原理角度解析Android (Java) http 文件上傳
ok,對(duì)于我們最開始的目錄還剩下圖片下載,文件下載;這兩個(gè)一個(gè)是通過回調(diào)的Response拿到byte[]然后decode成圖片;文件下載,就是拿到inputStream做寫文件操作,我們這里就不贅述了。
關(guān)于用法,也可以參考泡網(wǎng)OkHttp使用教程
接下來我們主要看如何封裝上述的代碼。
三、封裝
由于按照上述的代碼,寫多個(gè)請(qǐng)求肯定包含大量的重復(fù)代碼,所以我希望封裝后的代碼調(diào)用是這樣的:
(一)使用
一般的get請(qǐng)求
OkHttpClientManager.getAsyn("https://www.baidu.com", new OkHttpClientManager.ResultCallback<String>(){@Overridepublic 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
對(duì)于一般的請(qǐng)求,我們希望給個(gè)url,然后CallBack里面直接操作控件。
文件上傳且攜帶參數(shù)
我們希望提供一個(gè)方法,傳入url,params,file,callback即可。
OkHttpClientManager.postAsyn("http://192.168.1.103:8080/okHttpServer/fileUpload",//new OkHttpClientManager.ResultCallback<String>(){@Overridepublic 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
鍵值對(duì)沒什么說的,參數(shù)3為file,參數(shù)4為file對(duì)應(yīng)的name,這個(gè)name不是文件的名字;?
對(duì)應(yīng)于http中的
<input type="file" name="mFile" >
對(duì)應(yīng)的是name后面的值,即mFile.
文件下載
對(duì)于文件下載,提供url,目標(biāo)dir,callback即可。
OkHttpClientManager.downloadAsyn("http://192.168.1.103:8080/okHttpServer/files/messenger_01.png", Environment.getExternalStorageDirectory().getAbsolutePath(), new OkHttpClientManager.ResultCallback<String>(){@Overridepublic void onError(Request request, IOException e) { } @Override public void onResponse(String response) { //文件下載成功,這里回調(diào)的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
展示圖片
展示圖片,我們希望提供一個(gè)url和一個(gè)imageview,如果下載成功,直接幫我們?cè)O(shè)置上即可。
OkHttpClientManager.displayImage(mImageView, "http://images.csdn.net/20150817/1.jpg");- 1
- 2
- 1
- 2
內(nèi)部會(huì)自動(dòng)根據(jù)imageview的大小自動(dòng)對(duì)圖片進(jìn)行合適的壓縮。雖然,這里可能不適合一次性加載大量圖片的場(chǎng)景,但是對(duì)于app中偶爾有幾個(gè)圖片的加載,還是可用的。
四、整合Gson
很多人提出項(xiàng)目中使用時(shí),服務(wù)端返回的是Json字符串,希望客戶端回調(diào)可以直接拿到對(duì)象,于是整合進(jìn)入了Gson,完善該功能。
(一)直接回調(diào)對(duì)象
例如現(xiàn)在有個(gè)User實(shí)體類:
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
服務(wù)端返回:
{"username":"zhy","password":"123"}- 1
- 1
客戶端可以如下方式調(diào)用:
OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUser", new OkHttpClientManager.ResultCallback<User>() {@Overridepublic 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里面直接回調(diào)User對(duì)象。?
這里特別要注意的事,如果在json字符串->實(shí)體對(duì)象過程中發(fā)生錯(cuò)誤,程序不會(huì)崩潰,onError方法會(huì)被回調(diào)。
注意:這里做了少許的更新,接口命名從StringCallback修改為ResultCallback。接口中的onFailure方法修改為onError。
(二) 回調(diào)對(duì)象集合
依然是上述的User類,服務(wù)端返回
[{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]- 1
- 1
則客戶端可以如下調(diào)用:
OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUsers", new OkHttpClientManager.ResultCallback<List<User>>() {@Overridepublic 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
唯一的區(qū)別,就是泛型變?yōu)長ist<User>?,ok , 如果發(fā)現(xiàn)bug或者有任何意見歡迎留言。
源碼
ok,基本介紹完了,對(duì)于封裝的代碼其實(shí)也很簡單,我就直接貼出來了,因?yàn)橐矝]什么好介紹的,如果你看完上面的用法,肯定可以看懂:
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請(qǐng)求 * * @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請(qǐng)求 * * @param url * @return 字符串 */ private String _getAsString(String url) throws IOException { Response execute = _getAsyn(url); return execute.body().string(); } /** * 異步的get請(qǐng)求 * * @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請(qǐng)求 * * @param url * @param params post的參數(shù) * @return */ private Response _post(String url, Param... params) throws IOException { Request request = buildPostRequest(url, params); Response response = mOkHttpClient.newCall(request).execute(); return response; } /** * 同步的Post請(qǐng)求 * * @param url * @param params post的參數(shù) * @return 字符串 */ private String _postAsString(String url, Param... params) throws IOException { Response response = _post(url, params); return response.body().string(); } /** * 異步的post請(qǐng)求 * * @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請(qǐng)求 * * @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的文件上傳,單文件不帶參數(shù)上傳 * * @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參數(shù)上傳 * * @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 本地文件存儲(chǔ)的文件夾 * @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(); //如果下載文件成功,第一個(gè)參數(shù)為文件的絕對(duì)路徑 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轉(zhuǎn)載于:https://www.cnblogs.com/xgjblog/p/6007052.html
總結(jié)
以上是生活随笔為你收集整理的Android OkHttp完全解析 是时候来了解OkHttp了的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: ubuntu 简单配置samba
- 下一篇: 简化C语言文法