前一篇文章简单的介绍了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 void requestSuccess(String result) throws Exception {
//在这里我们可以直接去赋值,因为我们在内部已经做了异步处理,不用担心在子线程中获取数据,然后在UI线程中更改UI了。
tvtext.setText(result);
}
1、Okhttp的单例实现以及配置
/**
* 静态实例
*/
private static OkHttpManager sOkHttpManager;
/**
* okhttpclient实例
*/
private OkHttpClient mClient;
/**
* 单例模式 获取OkHttpManager实例
*
* @return
*/
public static OkHttpManager getInstance() {
if (sOkHttpManager == null) {
sOkHttpManager = new OkHttpManager();
}
return sOkHttpManager;
}
/**
* 构造方法
*/
private OkHttpManager() {
mClient = new OkHttpClient();
/**
* 在这里直接设置连接超时.读取超时,写入超时
*/
mClient.newBuilder().connectTimeout(10, TimeUnit.SECONDS);
mClient.newBuilder().readTimeout(10, TimeUnit.SECONDS);
mClient.newBuilder().writeTimeout(10, TimeUnit.SECONDS);
}
对外提供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;
}
}