okhttp的簡介（二）之簡單封裝
阿新 • • 發佈：2018-01-14
封裝 連接超時 src ins span 目標地址 index finall shee
前一篇文章簡單的介紹了okhttp的簡單使用。okhttp的簡介（一）：http://blog.csdn.net/wuyinlei/article/details/50579564
相信使用還是非常好使用的。可是，怎麽說呢，我們應該不想，每次使用的時候都去又一次寫一遍代碼，或者是復制代碼，這樣不僅或降低效率，並且還會是代碼冗余。
- 這個時候。採用封裝就能夠解決我們的問題了，把同樣的代碼，封裝到一起，對外提供一個調用的接口。每次調用的時候。我們僅僅須要調用接口，傳入數據。就能夠了，我們全然不用去理會他內部邏輯是怎麽處理的
- 那好的，既然已經知道了怎麽去做，那麽我們就開始吧。
我們想要實現的結果：
//在這裏我們直接調用暴露出來的接口。傳入須要的參數，即可了。降低了代碼量
OkHttpManager.getAsync(Contants.ASYNC_URL, new OkHttpManager.DataCallBack() {
@Override
public void requestFailure(Request request, IOException e) {
}
@Override
public 1、Okhttp的單例實現以及配置
/**
* 靜態實例
*/
private static OkHttpManager sOkHttpManager;
/**
* okhttpclient實例
*/ 對外提供GET同步請求和內部邏輯處理
/**
* 對外提供的get方法,同步的方式
*
* @param url 傳入的地址
* @return
*/
public static Response getSync(String url) {
//通過獲取到的實例來調用內部方法
return sOkHttpManager.inner_getSync(url);
}
/**
* GET方式請求的內部邏輯處理方式，同步的方式
*
* @param url
* @return
*/
private Response inner_getSync(String url) {
Request request = new Request.Builder().url(url).build();
Response response = null;
try {
//同步請求返回的是response對象
response = mClient.newCall(request).execute();
} catch (IOException e) {
e.printStackTrace();
}
return response;
}
3、對外提供的同步獲取數據的方法和內部處理
/**
* 對外提供的同步獲取String的方法
*
* @param url
* @return
*/
public static String getSyncString(String url) {
return sOkHttpManager.inner_getSyncString(url);
}
/**
* 同步方法
*/
private String inner_getSyncString(String url) {
String result = null;
try {
/**
* 把取得到的結果轉為字符串，這裏最好用string()
*/
result = inner_getSync(url).body().string();
} catch (IOException e) {
e.printStackTrace();
}
return result;
}
4、異步請求做的處理
- 在這裏我們對回調Callback進行了處理。改成我們自己定義的接口
/**
* 數據回調接口
*/
public interface DataCallBack {
//請求失敗
void requestFailure(Request request, IOException e);
//請求成功
void requestSuccess(String result) throws Exception;
}然後自己定義了兩個方法
- 一個是請求失敗：
/**
* 分發失敗的時候調用
*
* @param request
* @param e
* @param callBack
*/
private void deliverDataFailure(final Request request, final IOException e, final DataCallBack callBack) {
/**
* 在這裏使用異步處理
*/
mHandler.post(new Runnable() {
@Override
public void run() {
if (callBack != null) {
callBack.requestFailure(request, e);
}
}
});
}一個是請求成功：
/**
* 分發成功的時候調用
*
* @param result
* @param callBack
*/
private void deliverDataSuccess(final String result, final DataCallBack callBack) {
/**
* 在這裏使用異步線程處理
*/
mHandler.post(new Runnable() {
@Override
public void run() {
if (callBack != null) {
try {
callBack.requestSuccess(result);
} catch (Exception e) {
e.printStackTrace();
}
}
}
});
}
5、異步請求邏輯處理
//-------------------------異步的方式請求數據--------------------------
public static void getAsync(String url, DataCallBack callBack) {
getInstance().inner_getAsync(url, callBack);
}
/**
* 內部邏輯請求的方法
*
* @param url
* @param callBack
* @return
*/
private void inner_getAsync(String url, final DataCallBack callBack) {
final Request request = new Request.Builder().url(url).build();
mClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
deliverDataFailure(request, e, callBack);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
String result = null;
try {
result = response.body().string();
} catch (IOException e) {
deliverDataFailure(request, e, callBack);
}
deliverDataSuccess(result, callBack);
}
});
}
6、表單提交邏輯處理
//-------------------------提交表單--------------------------
public static void postAsync(String url, Map<String, String> params, DataCallBack callBack) {
getInstance().inner_postAsync(url, params, callBack);
}
private void inner_postAsync(String url, Map<String, String> params, final DataCallBack callBack) {
RequestBody requestBody = null;
if (params == null) {
params = new HashMap<>();
}
/**
* 假設是3.0之前版本號的，構建表單數據是以下的一句
*/
//FormEncodingBuilder builder = new FormEncodingBuilder();
/**
* 3.0之後版本號
*/
FormBody.Builder builder = new FormBody.Builder();
/**
* 在這對加入的參數進行遍歷，map遍歷有四種方式。假設想要了解的能夠網上查找
*/
for (Map.Entry<String, String> map : params.entrySet()) {
String key = map.getKey().toString();
String value = null;
/**
* 推斷值是否是空的
*/
if (map.getValue() == null) {
value = "";
} else {
value = map.getValue();
}
/**
* 把key和value加入到formbody中
*/
builder.add(key, value);
}
requestBody = builder.build();
//結果返回
final Request request = new Request.Builder().url(url).post(requestBody).build();
mClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
deliverDataFailure(request, e, callBack);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
String result = response.body().string();
deliverDataSuccess(result, callBack);
}
});
}
7、文件下載邏輯處理
//-------------------------文件下載--------------------------
public static void downloadAsync(String url, String desDir, DataCallBack callBack) {
getInstance().inner_downloadAsync(url, desDir, callBack);
}
/**
* 下載文件的內部邏輯處理類
*
* @param url 下載地址
* @param desDir 目標地址
* @param callBack
*/
private void inner_downloadAsync(final String url, final String desDir, final DataCallBack callBack) {
final Request request = new Request.Builder().url(url).build();
mClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
deliverDataFailure(request, e, callBack);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
/**
* 在這裏進行文件的下載處理
*/
InputStream inputStream = null;
FileOutputStream fileOutputStream = null;
try {
//文件名稱和目標地址
File file = new File(desDir, getFileName(url));
//把請求回來的response對象裝換為字節流
inputStream = response.body().byteStream();
fileOutputStream = new FileOutputStream(file);
int len = 0;
byte[] bytes = new byte[2048];
//循環讀取數據
while ((len = inputStream.read(bytes)) != -1) {
fileOutputStream.write(bytes, 0, len);
}
//關閉文件輸出流
fileOutputStream.flush();
//調用分發數據成功的方法
deliverDataSuccess(file.getAbsolutePath(), callBack);
} catch (IOException e) {
//假設失敗。調用此方法
deliverDataFailure(request, e, callBack);
e.printStackTrace();
} finally {
if (inputStream != null) {
inputStream.close();
}
if (fileOutputStream != null) {
fileOutputStream.close();
}
}
}
});
}
/**
* 依據文件url獲取文件的路徑名字
*
* @param url
* @return
*/
private String getFileName(String url) {
int separatorIndex = url.lastIndexOf("/");
String path = (separatorIndex < 0) ? url : url.substring(separatorIndex + 1, url.length());
return path;
}實現效果是一樣的，可是代碼結構清晰很多哈：
這樣，就完畢了簡單的一個請求工具類的封裝。
這裏的異步請求處理。我僅僅是返回了字符串。假設想返回的直接是個對象，這個還得須要處理。在這由於知識尚淺，尚不能完畢對象的返回。我們看到上面的，事實上也就是遵循了okhttp的GET。POST請求的邏輯。在次基礎上，我們添加了一些方法，來完畢我們想要的功能。以下上傳代碼。有點多，大家擔待點哈：
package com.example.okhttpdemo;
import android.os.Handler;
import android.os.Looper;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.FormBody;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
/**
* Created by 若蘭 on 2016/1/23.
* 一個懂得了編程樂趣的小白。希望自己
* 能夠在這個道路上走的非常遠，也希望自己學習到的
* 知識能夠幫助很多其它的人,分享就是學習的一種樂趣
* QQ:1069584784
* csdn:http://blog.csdn.net/wuyinlei
*/
public class OkHttpManager {
/**
* 靜態實例
*/
private static OkHttpManager sOkHttpManager;
/**
* okhttpclient實例
*/
private OkHttpClient mClient;
/**
* 由於我們請求數據一般都是子線程中請求，在這裏我們使用了handler
*/
private Handler mHandler;
/**
* 構造方法
*/
private OkHttpManager() {
mClient = new OkHttpClient();
/**
* 在這裏直接設置連接超時.讀取超時。寫入超時
*/
mClient.newBuilder().connectTimeout(10, TimeUnit.SECONDS);
mClient.newBuilder().readTimeout(10, TimeUnit.SECONDS);
mClient.newBuilder().writeTimeout(10, TimeUnit.SECONDS);
/**
* 假設是用的3.0之前的版本號 使用以下直接設置連接超時.讀取超時，寫入超時
*/
//client.setConnectTimeout(10, TimeUnit.SECONDS);
//client.setWriteTimeout(10, TimeUnit.SECONDS);
//client.setReadTimeout(30, TimeUnit.SECONDS);
/**
* 初始化handler
*/
mHandler = new Handler(Looper.getMainLooper());
}
/**
* 單例模式 獲取OkHttpManager實例
*
* @return
*/
public static OkHttpManager getInstance() {
if (sOkHttpManager == null) {
sOkHttpManager = new OkHttpManager();
}
return sOkHttpManager;
}
//-------------------------同步的方式請求數據--------------------------
/**
* 對外提供的get方法,同步的方式
*
* @param url 傳入的地址
* @return
*/
public static Response getSync(String url) {
//通過獲取到的實例來調用內部方法
return sOkHttpManager.inner_getSync(url);
}
/**
* GET方式請求的內部邏輯處理方式，同步的方式
*
* @param url
* @return
*/
private Response inner_getSync(String url) {
Request request = new Request.Builder().url(url).build();
Response response = null;
try {
//同步請求返回的是response對象
response = mClient.newCall(request).execute();
} catch (IOException e) {
e.printStackTrace();
}
return response;
}
/**
* 對外提供的同步獲取String的方法
*
* @param url
* @return
*/
public static String getSyncString(String url) {
return sOkHttpManager.inner_getSyncString(url);
}
/**
* 同步方法
*/
private String inner_getSyncString(String url) {
String result = null;
try {
/**
* 把取得到的結果轉為字符串，這裏最好用string()
*/
result = inner_getSync(url).body().string();
} catch (IOException e) {
e.printStackTrace();
}
return result;
}
//-------------------------異步的方式請求數據--------------------------
public static void getAsync(String url, DataCallBack callBack) {
getInstance().inner_getAsync(url, callBack);
}
/**
* 內部邏輯請求的方法
*
* @param url
* @param callBack
* @return
*/
private void inner_getAsync(String url, final DataCallBack callBack) {
final Request request = new Request.Builder().url(url).build();
mClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
deliverDataFailure(request, e, callBack);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
String result = null;
try {
result = response.body().string();
} catch (IOException e) {
deliverDataFailure(request, e, callBack);
}
deliverDataSuccess(result, callBack);
}
});
}
/**
* 分發失敗的時候調用
*
* @param request
* @param e
* @param callBack
*/
private void deliverDataFailure(final Request request, final IOException e, final DataCallBack callBack) {
/**
* 在這裏使用異步處理
*/
mHandler.post(new Runnable() {
@Override
public void run() {
if (callBack != null) {
callBack.requestFailure(request, e);
}
}
});
}
/**
* 分發成功的時候調用
*
* @param result
* @param callBack
*/
private void deliverDataSuccess(final String result, final DataCallBack callBack) {
/**
* 在這裏使用異步線程處理
*/
mHandler.post(new Runnable() {
@Override
public void run() {
if (callBack != null) {
try {
callBack.requestSuccess(result);
} catch (Exception e) {
e.printStackTrace();
}
}
}
});
}
/**
* 數據回調接口
*/
public interface DataCallBack {
void requestFailure(Request request, IOException e);
void requestSuccess(String result) throws Exception;
}
//-------------------------提交表單--------------------------
public static void postAsync(String url, Map<String, String> params, DataCallBack callBack) {
getInstance().inner_postAsync(url, params, callBack);
}
private void inner_postAsync(String url, Map<String, String> params, final DataCallBack callBack) {
RequestBody requestBody = null;
if (params == null) {
params = new HashMap<>();
}
/**
* 假設是3.0之前版本號的，構建表單數據是以下的一句
*/
//FormEncodingBuilder builder = new FormEncodingBuilder();
/**
* 3.0之後版本號
*/
FormBody.Builder builder = new FormBody.Builder();
/**
* 在這對加入的參數進行遍歷，map遍歷有四種方式，假設想要了解的能夠網上查找
*/
for (Map.Entry<String, String> map : params.entrySet()) {
String key = map.getKey().toString();
String value = null;
/**
* 推斷值是否是空的
*/
if (map.getValue() == null) {
value = "";
} else {
value = map.getValue();
}
/**
* 把key和value加入到formbody中
*/
builder.add(key, value);
}
requestBody = builder.build();
//結果返回
final Request request = new Request.Builder().url(url).post(requestBody).build();
mClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
deliverDataFailure(request, e, callBack);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
String result = response.body().string();
deliverDataSuccess(result, callBack);
}
});
}
//-------------------------文件下載--------------------------
public static void downloadAsync(String url, String desDir, DataCallBack callBack) {
getInstance().inner_downloadAsync(url, desDir, callBack);
}
/**
* 下載文件的內部邏輯處理類
*
* @param url 下載地址
* @param desDir 目標地址
* @param callBack
*/
private void inner_downloadAsync(final String url, final String desDir, final DataCallBack callBack) {
final Request request = new Request.Builder().url(url).build();
mClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
deliverDataFailure(request, e, callBack);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
/**
* 在這裏進行文件的下載處理
*/
InputStream inputStream = null;
FileOutputStream fileOutputStream = null;
try {
//文件名稱和目標地址
File file = new File(desDir, getFileName(url));
//把請求回來的response對象裝換為字節流
inputStream = response.body().byteStream();
fileOutputStream = new FileOutputStream(file);
int len = 0;
byte[] bytes = new byte[2048];
//循環讀取數據
while ((len = inputStream.read(bytes)) != -1) {
fileOutputStream.write(bytes, 0, len);
}
//關閉文件輸出流
fileOutputStream.flush();
//調用分發數據成功的方法
deliverDataSuccess(file.getAbsolutePath(), callBack);
} catch (IOException e) {
//假設失敗。調用此方法
deliverDataFailure(request, e, callBack);
e.printStackTrace();
} finally {
if (inputStream != null) {
inputStream.close();
}
if (fileOutputStream != null) {
fileOutputStream.close();
}
}
}
});
}
/**
* 依據文件url獲取文件的路徑名字
*
* @param url
* @return
*/
private String getFileName(String url) {
int separatorIndex = url.lastIndexOf("/");
String path = (separatorIndex < 0) ? url : url.substring(separatorIndex + 1, url.length());
return path;
}
}
okhttp的簡介（二）之簡單封裝