Android OkHttp完全解析
http://blog.csdn.net/lmj623565791/article/details/47911083; 本文出自:【張鴻洋的博客】
1. 概述
最近在群里聽(tīng)到各種討論okhttp的話題,可見(jiàn)okhttp的口碑相當(dāng)好了。再加上Google貌似在6.0版本里面刪除了HttpClient相關(guān)API,對(duì)于這個(gè)行為不做評(píng)價(jià)。為了更好的在應(yīng)對(duì)網(wǎng)絡(luò)訪問(wèn),學(xué)習(xí)下okhttp還是蠻必要的,本篇博客首先介紹okhttp的簡(jiǎn)單使用,主要包含:
- 一般的get請(qǐng)求
- 一般的post請(qǐng)求
- 基于Http的文件上傳
- 文件下載
- 加載圖片
- 支持請(qǐng)求回調(diào),直接返回對(duì)象、對(duì)象集合
- 支持session的保持
最后會(huì)對(duì)上述幾個(gè)功能進(jìn)行封裝,完整的封裝類的地址見(jiàn):https://github.com/hongyangAndroid/okhttp-utils
使用前,對(duì)于Android Studio的用戶,可以選擇添加:
compile 'com.squareup.okhttp:okhttp:2.4.0'11或者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
2. 使用教程
2.1 Http Get
對(duì)了網(wǎng)絡(luò)加載庫(kù),那么最常見(jiàn)的肯定就是http get請(qǐng)求了,比如獲取一個(gè)網(wǎng)頁(yè)的內(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(){@Overridepublic void onFailure(Request request, IOException e){}@Overridepublic void onResponse(final Response response) throws IOException{//String htmlStr = response.body().string();}});看到這,你會(huì)發(fā)現(xiàn),整體的寫法還是比較長(zhǎng)的,所以封裝肯定是要做的,不然每個(gè)請(qǐng)求這么寫,得累死。
ok,需要注意幾點(diǎn):
- onResponse回調(diào)的參數(shù)是response,一般情況下,比如我們希望獲得返回的字符串,可以通過(guò)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我們就可以通過(guò)IO的方式寫文件。不過(guò)也說(shuō)明一個(gè)問(wèn)題,這個(gè)onResponse執(zhí)行的線程并不是UI線程。的確是的,如果你希望操作控件,還是需要使用handler等,例如:
@Override public void onResponse(final Response response) throws IOException {final String res = response.body().string();runOnUiThread(new Runnable(){@Overridepublic void run(){mTv.setText(res);}}); }- 我們這里是異步的方式去執(zhí)行,當(dāng)然也支持阻塞的方式,上面我們也說(shuō)了Call有一個(gè)execute()方法,你也可以直接調(diào)用call.execute()通過(guò)返回一個(gè)Response。
2.2 Http Post 攜帶參數(shù)
看來(lái)上面的簡(jiǎn)單的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(){});1234567891012345678910大家都清楚,post的時(shí)候,參數(shù)是包含在請(qǐng)求體中的;所以我們通過(guò)FormEncodingBuilder。添加多個(gè)String鍵值對(duì),然后去構(gòu)造RequestBody,最后完成我們Request的構(gòu)造。
后面的就和上面一樣了。
2.3 基于Http的文件上傳
接下來(lái)我們?cè)诮榻B一個(gè)可以構(gòu)造RequestBody的Builder,叫做MultipartBuilder。當(dāng)我們需要做類似于表單上傳的時(shí)候,就可以使用它來(lái)構(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() {//... });上述代碼向服務(wù)器傳遞了一個(gè)鍵值對(duì)username:張鴻洋和一個(gè)文件。我們通過(guò)MultipartBuilder的addPart方法可以添加鍵值對(duì)或者文件。
其實(shí)類似于我們拼接模擬瀏覽器行為的方式,如果你對(duì)這塊不了解,可以參考:從原理角度解析Android (Java) http 文件上傳
ok,對(duì)于我們最開(kāi)始的目錄還剩下圖片下載,文件下載;這兩個(gè)一個(gè)是通過(guò)回調(diào)的Response拿到byte[]然后decode成圖片;文件下載,就是拿到inputStream做寫文件操作,我們這里就不贅述了。
關(guān)于用法,也可以參考泡網(wǎng)OkHttp使用教程
接下來(lái)我們主要看如何封裝上述的代碼。
3. 封裝
由于按照上述的代碼,寫多個(gè)請(qǐng)求肯定包含大量的重復(fù)代碼,所以我希望封裝后的代碼調(diào)用是這樣的:
3.1 使用
對(duì)于一般的請(qǐng)求,我們希望給個(gè)url,然后CallBack里面直接操作控件。
我們希望提供一個(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();}@Overridepublic void onResponse(String result){}},//file,//"mFile",//new OkHttpClientManager.Param[]{new OkHttpClientManager.Param("username", "zhy"),new OkHttpClientManager.Param("password", "123")});鍵值對(duì)沒(méi)什么說(shuō)的,參數(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即可。
展示圖片,我們希望提供一個(gè)url和一個(gè)imageview,如果下載成功,直接幫我們?cè)O(shè)置上即可。
內(nèi)部會(huì)自動(dòng)根據(jù)imageview的大小自動(dòng)對(duì)圖片進(jìn)行合適的壓縮。雖然,這里可能不適合一次性加載大量圖片的場(chǎng)景,但是對(duì)于app中偶爾有幾個(gè)圖片的加載,還是可用的。
4. 整合Gson
很多人提出項(xiàng)目中使用時(shí),服務(wù)端返回的是Json字符串,希望客戶端回調(diào)可以直接拿到對(duì)象,于是整合進(jìn)入了Gson,完善該功能。
4.1 直接回調(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;}@Overridepublic String toString(){return "User{" +"username='" + username + '\'' +", password='" + password + '\'' +'}';} }服務(wù)端返回:
{"username":"zhy","password":"123"}11客戶端可以如下方式調(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();}@Overridepublic void onResponse(User user){mTv.setText(u.toString());//UI線程} });我們傳入泛型User,在onResponse里面直接回調(diào)User對(duì)象。
這里特別要注意的事,如果在json字符串->實(shí)體對(duì)象過(guò)程中發(fā)生錯(cuò)誤,程序不會(huì)崩潰,onError方法會(huì)被回調(diào)。
注意:這里做了少許的更新,接口命名從StringCallback修改為ResultCallback。接口中的onFailure方法修改為onError。
4.2 回調(diào)對(duì)象集合
依然是上述的User類,服務(wù)端返回
[{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]則客戶端可以如下調(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();}@Overridepublic void onResponse(List<User> us){Log.e("TAG", us.size() + "");mTv.setText(us.get(1).toString());} });唯一的區(qū)別,就是泛型變?yōu)長(zhǎng)ist<User> ,ok , 如果發(fā)現(xiàn)bug或者有任何意見(jiàn)歡迎留言。
5. 源碼
ok,基本介紹完了,對(duì)于封裝的代碼其實(shí)也很簡(jiǎn)單,我就直接貼出來(lái)了,因?yàn)橐矝](méi)什么好介紹的,如果你看完上面的用法,肯定可以看懂:
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 enabledmOkHttpClient.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(){@Overridepublic void onFailure(final Request request, final IOException e){sendFailedStringCallback(request, e, callback);}@Overridepublic 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 int errorResId){final Request request = new Request.Builder().url(url).build();Call call = mOkHttpClient.newCall(request);call.enqueue(new Callback(){@Overridepublic void onFailure(Request request, IOException e){setErrorResId(view, errorResId);}@Overridepublic void onResponse(Response response){InputStream is = null;try{is = response.body().byteStream();ImageUtils.ImageSize actualImageSize = ImageUtils.getImageSize(is);ImageUtils.ImageSize imageViewSize = ImageUtils.getImageViewSize(view);int inSampleSize = ImageUtils.calculateInSampleSize(actualImageSize, imageViewSize);try{is.reset();} catch (IOException e){response = _getAsyn(url);is = response.body().byteStream();}BitmapFactory.Options ops = new BitmapFactory.Options();ops.inJustDecodeBounds = false;ops.inSampleSize = inSampleSize;final Bitmap bm = BitmapFactory.decodeStream(is, null, ops);mDelivery.post(new Runnable(){@Overridepublic void run(){view.setImageBitmap(bm);}});} catch (Exception e){setErrorResId(view, errorResId);} finally{if (is != null) try{is.close();} catch (IOException e){e.printStackTrace();}}}});}private void setErrorResId(final ImageView view, final int errorResId){mDelivery.post(new Runnable(){@Overridepublic void run(){view.setImageResource(errorResId);}});}//*************對(duì)外公布的方法************public static Response getAsyn(String url) throws IOException{return getInstance()._getAsyn(url);}public static String getAsString(String url) throws IOException{return getInstance()._getAsString(url);}public static void getAsyn(String url, ResultCallback callback){getInstance()._getAsyn(url, callback);}public static Response post(String url, Param... params) throws IOException{return getInstance()._post(url, params);}public static String postAsString(String url, Param... params) throws IOException{return getInstance()._postAsString(url, params);}public static void postAsyn(String url, final ResultCallback callback, Param... params){getInstance()._postAsyn(url, callback, params);}public static void postAsyn(String url, final ResultCallback callback, Map<String, String> params){getInstance()._postAsyn(url, callback, params);}public static Response post(String url, File[] files, String[] fileKeys, Param... params) throws IOException{return getInstance()._post(url, files, fileKeys, params);}public static Response post(String url, File file, String fileKey) throws IOException{return getInstance()._post(url, file, fileKey);}public static Response post(String url, File file, String fileKey, Param... params) throws IOException{return getInstance()._post(url, file, fileKey, params);}public static void postAsyn(String url, ResultCallback callback, File[] files, String[] fileKeys, Param... params) throws IOException{getInstance()._postAsyn(url, callback, files, fileKeys, params);}public static void postAsyn(String url, ResultCallback callback, File file, String fileKey) throws IOException{getInstance()._postAsyn(url, callback, file, fileKey);}public static void postAsyn(String url, ResultCallback callback, File file, String fileKey, Param... params) throws IOException{getInstance()._postAsyn(url, callback, file, fileKey, params);}public static void displayImage(final ImageView view, String url, int errorResId) throws IOException{getInstance()._displayImage(view, url, errorResId);}public static void displayImage(final ImageView view, String url){getInstance()._displayImage(view, url, -1);}public static void downloadAsyn(String url, String destDir, ResultCallback callback){getInstance()._downloadAsyn(url, destDir, callback);}//****************************private Request buildMultipartFormRequest(String url, File[] files,String[] fileKeys, Param[] params){params = validateParam(params);MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);for (Param param : params){builder.addPart(Headers.of("Content-Disposition", "form-data; name=\"" + param.key + "\""),RequestBody.create(null, param.value));}if (files != null){RequestBody fileBody = null;for (int i = 0; i < files.length; i++){File file = files[i];String fileName = file.getName();fileBody = RequestBody.create(MediaType.parse(guessMimeType(fileName)), file);//TODO 根據(jù)文件名設(shè)置contentTypebuilder.addPart(Headers.of("Content-Disposition","form-data; name=\"" + fileKeys[i] + "\"; filename=\"" + fileName + "\""),fileBody);}}RequestBody requestBody = builder.build();return new Request.Builder().url(url).post(requestBody).build();}private String guessMimeType(String path){FileNameMap fileNameMap = URLConnection.getFileNameMap();String contentTypeFor = fileNameMap.getContentTypeFor(path);if (contentTypeFor == null){contentTypeFor = "application/octet-stream";}return contentTypeFor;}private Param[] validateParam(Param[] params){if (params == null)return new Param[0];else return params;}private Param[] map2Params(Map<String, String> params){if (params == null) return new Param[0];int size = params.size();Param[] res = new Param[size];Set<Map.Entry<String, String>> entries = params.entrySet();int i = 0;for (Map.Entry<String, String> entry : entries){res[i++] = new Param(entry.getKey(), entry.getValue());}return res;}private static final String SESSION_KEY = "Set-Cookie";private static final String mSessionKey = "JSESSIONID";private Map<String, String> mSessions = new HashMap<String, String>();private void deliveryResult(final ResultCallback callback, Request request){mOkHttpClient.newCall(request).enqueue(new Callback(){@Overridepublic void onFailure(final Request request, final IOException e){sendFailedStringCallback(request, e, callback);}@Overridepublic void onResponse(final Response response){try{final String string = response.body().string();if (callback.mType == String.class){sendSuccessResultCallback(string, callback);} else{Object o = mGson.fromJson(string, callback.mType);sendSuccessResultCallback(o, callback);}} catch (IOException e){sendFailedStringCallback(response.request(), e, callback);} catch (com.google.gson.JsonParseException e)//Json解析的錯(cuò)誤{sendFailedStringCallback(response.request(), e, callback);}}});}private void sendFailedStringCallback(final Request request, final Exception e, final ResultCallback callback){mDelivery.post(new Runnable(){@Overridepublic void run(){if (callback != null)callback.onError(request, e);}});}private void sendSuccessResultCallback(final Object object, final ResultCallback callback){mDelivery.post(new Runnable(){@Overridepublic void run(){if (callback != null){callback.onResponse(object);}}});}private Request buildPostRequest(String url, Param[] params){if (params == null){params = new Param[0];}FormEncodingBuilder builder = new FormEncodingBuilder();for (Param param : params){builder.add(param.key, param.value);}RequestBody requestBody = builder.build();return new Request.Builder().url(url).post(requestBody).build();}public static abstract class ResultCallback<T>{Type mType;public ResultCallback(){mType = getSuperclassTypeParameter(getClass());}static Type getSuperclassTypeParameter(Class<?> subclass){Type superclass = subclass.getGenericSuperclass();if (superclass instanceof Class){throw new RuntimeException("Missing type parameter.");}ParameterizedType parameterized = (ParameterizedType) superclass;return $Gson$Types.canonicalize(parameterized.getActualTypeArguments()[0]);}public abstract void onError(Request request, Exception e);public abstract void onResponse(T response);}public static class Param{public Param(){}public Param(String key, String value){this.key = key;this.value = value;}String key;String value;}}源碼地址okhttp-utils,大家可以自己下載查看。
總結(jié)
以上是生活随笔為你收集整理的Android OkHttp完全解析的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: Android Volley完全解析4:
- 下一篇: Android Https相关完全解析