网络请求框架（二）----改善的okHttp封装库okhttputils的使用

项目中网络请求使用避免不了，但选择合适的网络请求框架很重要。上一篇对okHttp网络框架的使用和源码分析进行了简单的讲解，也简单封装了工具类。但由于该工具类中的方法剧增，各种重载方法，导致使用起来不方便。接下来讲解的okhttputils网络框架是对okHttp的封装，提升其使用起来的方便性和易扩展性。

资料来源 张鸿洋的博客： http://blog.csdn.net/lmj623565791/article/details/49734867

一、okhttputils封装库主要包含的内容

1.一般的get请求

2.一般的post请求

3.基于Http的文件上传

4.文件下载

5.上传下载的进度回调

6.加载图片

7.支持请求回调，直接返回对象、对象集合

8.支持session的保持

9.支持自签名网站https的访问，提供方法设置下证书就行

10.支持取消某个请求

源码地址：https://github.com/hongyangAndroid/okhttp-utils

使用前，需要添加依赖

1.Android Studio依赖配置（注意:okhttp内部依赖okio，别忘了同时导入okio：）:

compile project(':okhttputils')
或
compile 'com.zhy:okhttputils:2.0.0'

2.Eclipse

下载最新的jar，添加依赖即可。

二、基本用法

用法格式如下：

OkHttpUtils
.get()
.url(url)
.addParams("username", "siwen")
.addParams("password", "123456")
.build()
.execute(callback);

通过链式去根据自己的需要添加各种参数，最后调用execute(callback)进行执行，传入callback则代表是异步。如果单纯的execute()则代表同步的方法调用。
可以看到，取消了之前一堆的get重载方法，参数也可以进行灵活的选择了。

下面简单看一下，全部的用法：

2.1 get请求

String url = "http://blog.csdn.net/siwenyy/";
OkHttpUtils
.get()
.url(url)
.addParams("username", "siwen")
.addParams("password", "123456")
.build()
.execute(new StringCallback()
{
@Override
public void onError(Request request, Exception e)
{
}
@Override
public void onResponse(String response)
{
}
});

2.2 post请求

OkHttpUtils
.post()
.url(url)
.addParams("username", "siwen")
.addParams("password", "123")
.build()
.execute(callback);

2.3 Post String

OkHttpUtils
.postString()
.url(url)
.content(new Gson().toJson(new User("zhy", "123")))
.build()
.execute(new MyStringCallback());

将string作为请求体传入到服务端，例如json字符串。

2.4 Post File

OkHttpUtils
.postFile()
.url(url)
.file(file)
.build()
.execute(new MyStringCallback());

将file作为请求体传入到服务端.

2.5 基于post文件上传（类似web上的表单）

OkHttpUtils.post()//
.addFile("mFile", "messenger_01.png", file)//
.addFile("mFile", "test1.txt", file2)//
.url(url)
.params(params)//
.headers(headers)//
.build()//
.execute(new MyStringCallback());

2.6 下载文件

OkHttpUtils//
.get()//
.url(url)//
.build()//
.execute(new FileCallBack(Environment.getExternalStorageDirectory().getAbsolutePath(), "gson-2.2.1.jar")//
{
@Override
public void inProgress(float progress)
{
mProgressBar.setProgress((int) (100 * progress));
}
@Override
public void onError(Request request, Exception e)
{
Log.e(TAG, "onError :" + e.getMessage());
}
@Override
public void onResponse(File file)
{
Log.e(TAG, "onResponse :" + file.getAbsolutePath());
}
});

2.7 显示图片

OkHttpUtils
.get()//
.url(url)//
.build()//
.execute(new BitmapCallback()
{
@Override
public void onError(Request request, Exception e)
{
mTv.setText("onError:" + e.getMessage());
}
@Override
public void onResponse(Bitmap bitmap)
{
mImageView.setImageBitmap(bitmap);
}
});

三、对于上传下载的回调

new Callback<?>()
{
//...
@Override
public void inProgress(float progress)
{
//use progress: 0 ~ 1
}
}

四、对于自动解析为实体类

目前去除了Gson的依赖，提供了自定义Callback的方式，让用户自己去解析返回的数据，目前提供了StringCallback，FileCallback,BitmapCallback 分别用于返回string，文件下载，加载图片。

当然如果你希望解析为对象，你可以：

public abstract class UserCallback extends Callback<User>
{
//非UI线程，支持任何耗时操作
@Override
public User parseNetworkResponse(Response response) throws IOException
{
String string = response.body().string();
User user = new Gson().fromJson(string, User.class);
return user;
}
}

解析成List，则如下：

public abstract class ListUserCallback extends Callback<List<User>>
{
@Override
public List<User> parseNetworkResponse(Response response) throws IOException
{
String string = response.body().string();
List<User> user = new Gson().fromJson(string, List.class);
return user;
}
}

五、对于https单向认证

非常简单，拿到xxx.cert的证书。

然后调用

public abstract class ListUserCallback extends Callback<List<User>>
{
@Override
public List<User> parseNetworkResponse(Response response) throws IOException
{
String string = response.body().string();
List<User> user = new Gson().fromJson(string, List.class);
return user;
}
}

建议使用方式，例如我的证书放在assets目录（别忘了注册Application）：

/**
* Created by zhy on 15/8/25.
*/
public class MyApplication extends Application
{
@Override
public void onCreate()
{
super.onCreate();
try
{
OkHttpUtils
.getInstance()
.setCertificates(getAssets().open("aaa.cer"),
getAssets().open("server.cer"));
} catch (IOException e)
{
e.printStackTrace();
}
}
}

注意：如果https网站为权威机构颁发的证书，不需要以上设置。自签名的证书才需要。

六、配置

（1）全局配置

可以在Application中，通过：

OkHttpClient client = OkHttpUtils.getInstance().getOkHttpClient();
client.setConnectTimeout(100000, TimeUnit.MILLISECONDS);

配置OkhttpClient(别忘了在AndroidManifest中设置)

默认情况下，将直接使用okhttp默认的配置生成OkhttpClient，如果你有任何配置，记得在Application中调用initClient方法进行设置。

public class MyApplication extends Application
{
@Override
public void onCreate()
{
super.onCreate();
OkHttpClient okHttpClient = new OkHttpClient.Builder()
//                .addInterceptor(new LoggerInterceptor("TAG"))
.connectTimeout(10000L, TimeUnit.MILLISECONDS)
.readTimeout(10000L, TimeUnit.MILLISECONDS)
//其他配置
.build();

OkHttpUtils.initClient(okHttpClient);
}
}

（2）为单个请求设置超时（比如涉及到文件的需要设置读写等待时间多一点）

OkHttpUtils
.get()//
.url(url)//
.tag(this)//
.build()//
.connTimeOut(20000)
.readTimeOut(20000)
.writeTimeOut(20000)
.execute()

调用build()之后，可以随即设置各种timeOut.

（3）取消单个请求

RequestCall call = OkHttpUtils.get().url(url).build();
call.cancel();

（4）根据tag取消请求

目前对于支持的方法都添加了最后一个参数Object tag，取消则通过OkHttpUtils.cancelTag(tag)执行。

例如：在Activity中，当Activity销毁取消请求：

OkHttpUtils
.get()//
.url(url)//
.tag(this)//
.build()//
@Override
protected void onDestroy()
{
super.onDestroy();
//可以取消同一个tag的
OkHttpUtils.cancelTag(this);//取消以Activity.this作为tag的请求
}

比如，当前Activity页面所有的请求以Activity对象作为tag，可以在onDestory里面统一取消。

（5） 混淆

#okhttputils
-dontwarn com.zhy.http.**
-keep class com.zhy.http.**{*;}

#okhttp
-dontwarn okhttp3.**
-keep class okhttp3.**{*;}

#okio
-dontwarn okio.**
-keep class okio.**{*;}

详细使用，可参考鸿洋的demo：https://github.com/hongyangAndroid/okhttputils