Android OkHttp3简介和使用详解

一 OKHttp简介

OKHttp是一个处理网络请求的开源项目，Android 当前最火热网络框架，由移动支付Square公司贡献，用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里已移除HttpClient）。
OKHttpGitHub地址

OKHttp优点

支持HTTP2/SPDY（SPDY是Google开发的基于TCP的传输层协议，用以最小化网络延迟，提升网络速度，优化用户的网络使用体验。）
socket自动选择最好路线，并支持自动重连，拥有自动维护的socket连接池，减少握手次数，减少了请求延迟，共享Socket,减少对服务器的请求次数。
基于Headers的缓存策略减少重复的网络请求。
拥有Interceptors轻松处理请求与响应（自动处理GZip压缩）。

OKHttp的功能

PUT，DELETE，POST，GET等请求
文件的上传下载
加载图片(内部会图片大小自动压缩)
支持请求回调，直接返回对象、对象集合
支持session的保持

二 OkHttp3使用

主要介绍 OkHttp3 的 Get 请求、 Post 请求、上传下载文件、上传下载图片等功能。

添加OkHttp3的依赖

compile 'com.squareup.okhttp3:okhttp:3.7.0'
compile 'com.squareup.okio:okio:1.12.0'

添加网络权限

<uses-permission android:name="android.permission.INTERNET"/>

1.异步GET请求

        //1.创建OkHttpClient对象OkHttpClient okHttpClient = new OkHttpClient();//2.创建Request对象，设置一个url地址（百度地址）,设置请求方式。Request request = new Request.Builder().url("http://www.baidu.com").method("GET",null).build();//3.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//4.请求加入调度，重写回调方法call.enqueue(new Callback() {//请求失败执行的方法@Overridepublic void onFailure(Call call, IOException e) {}//请求成功执行的方法@Overridepublic void onResponse(Call call, Response response) throws IOException {}});

上面就是发送一个异步GET请求的4个步骤：

创建OkHttpClient对象
通过Builder模式创建Request对象，参数必须有个url参数，可以通过Request.Builder设置更多的参数比如：header、method等
通过request的对象去构造得到一个Call对象，Call对象有execute()和cancel()等方法。
以异步的方式去执行请求，调用的是call.enqueue，将call加入调度队列，任务执行完成会在Callback中得到结果。

注意事项：

异步调用的回调函数是在子线程,我们不能在子线程更新UI,需要借助于 runOnUiThread() 方法或者 Handler 来处理。
onResponse回调有一个参数是response，如果我们想获得返回的是字符串，可以通过response.body().string()获取；如果希望获得返回的二进制字节数组，则调用response.body().bytes()；如果你想拿到返回的inputStream，则调response.body().byteStream()，有inputStream我们就可以通过IO的方式写文件（后面会有例子）。

2.同步GET请求

        //1.创建OkHttpClient对象OkHttpClient okHttpClient = new OkHttpClient();//2.创建Request对象，设置一个url地址（百度地址）,设置请求方式。Request request = new Request.Builder().url("http://www.baidu.com").method("GET",null).build();//3.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//4.同步调用会阻塞主线程,这边在子线程进行new Thread(new Runnable() {@Overridepublic void run() {try {//同步调用,返回Response,会抛出IO异常Response response = call.execute();} catch (IOException e) {e.printStackTrace();}}}).start();

同步GET请求和异步GET请求基本一样，不同地方是同步请求调用Call的execute()方法，而异步请求调用call.enqueue()方法（具体2个方法的不同点我下一遍具体源码详解再说）。

3.POST请求提交键值对

        //1.创建OkHttpClient对象OkHttpClient  okHttpClient = new OkHttpClient();//2.通过new FormBody()调用build方法,创建一个RequestBody,可以用add添加键值对 RequestBody  requestBody = new FormBody.Builder().add("name","zhangqilu").add("age","25").build();//3.创建Request对象，设置URL地址，将RequestBody作为post方法的参数传入Request request = new Request.Builder().url("url").post(requestBody).build();//4.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//5.请求加入调度,重写回调方法call.enqueue(new Callback() {@Overridepublic void onFailure(Call call, IOException e) {}@Overridepublic void onResponse(Call call, Response response) throws IOException {}});

上面就是一个异步POST请求提交键值对的5个步骤：

创建OkHttpClient对象。
通过new FormBody()调用build方法,创建一个RequestBody,可以用add添加键值对，FormBody 是 RequestBody 的子类。
创建Request对象，设置URL地址，将RequestBody作为post方法的参数传入。
创建一个call对象,参数就是Request请求对象。
请求加入调度,重写回调方法。

通过对比我们发现异步的POST请求和GET请求步骤很相似。

4.异步POST请求提交字符串

POST请求提交字符串和POST请求提交键值对非常相似，不同地方主要是RequestBody，下面我们来具体看一下。
在有些情况下客户端需要向服务端传送字符串，我们该怎么做？
我们需要用到另一种方式来构造一个 RequestBody 如下所示:

        MediaType mediaType = MediaType.parse("application/json; charset=utf-8");//"类型,字节码"//字符串String value = "{username:admin;password:admin}"; //1.创建OkHttpClient对象OkHttpClient  okHttpClient = new OkHttpClient();//2.通过RequestBody.create 创建requestBody对象RequestBody requestBody =RequestBody.create(mediaType, value);//3.创建Request对象，设置URL地址，将RequestBody作为post方法的参数传入Request request = new Request.Builder().url("url").post(requestBody).build();//4.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//5.请求加入调度,重写回调方法call.enqueue(new Callback() {@Overridepublic void onFailure(Call call, IOException e) {}@Overridepublic void onResponse(Call call, Response response) throws IOException {}});

5.异步POST请求上传文件

我们这里举一个上传图片的例子，也可以是其他文件如，TXT文档等，不同地方主要是RequestBody，首先我们要添加存储卡读写权限,在 AndroidManifest.xml 文件中添加如下代码:

 <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

下面我们具体看一下上传文件代码。

        //1.创建OkHttpClient对象OkHttpClient  okHttpClient = new OkHttpClient();//上传的图片File file = new File(Environment.getExternalStorageDirectory(), "zhuangqilu.png");//2.通过RequestBody.create 创建requestBody对象,application/octet-stream 表示文件是任意二进制数据流RequestBody requestBody =RequestBody.create(MediaType.parse("application/octet-stream"), file);//3.创建Request对象，设置URL地址，将RequestBody作为post方法的参数传入Request request = new Request.Builder().url("url").post(requestBody).build();//4.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//5.请求加入调度,重写回调方法call.enqueue(new Callback() {@Overridepublic void onFailure(Call call, IOException e) {}@Overridepublic void onResponse(Call call, Response response) throws IOException {}});

6.异步GET请求下载文件

下载文件也是我们经常用到的功能，我们就举个下载图片的例子吧

        //1.创建OkHttpClient对象OkHttpClient okHttpClient = new OkHttpClient();//2.创建Request对象，设置一个url地址（百度地址）,设置请求方式。Request request = new Request.Builder().url("https://www.baidu.com/img/bd_logo1.png").get().build();//3.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//4.请求加入调度,重写回调方法call.enqueue(new Callback() {@Overridepublic void onFailure(Call call, IOException e) {Log.e(TAG, "onFailure: "+call.toString() );}@Overridepublic void onResponse(Call call, Response response) throws IOException {//拿到字节流InputStream is = response.body().byteStream();int len = 0;//设置下载图片存储路径和名称File file = new File(Environment.getExternalStorageDirectory(),"baidu.png");FileOutputStream fos = new FileOutputStream(file);byte[] buf = new byte[128];while((len = is.read(buf))!= -1){fos.write(buf,0,len);Log.e(TAG, "onResponse: "+len );}fos.flush();fos.close();is.close();}});

Get请求下载文件还是比较简单，设置下载地址，在回调函数中拿到了图片的字节流,然后保存为了本地的一张图片。

从网络下载一张图片并直接设置到ImageView中。

@Override
public void onResponse(Call call, Response response) throws IOException {InputStream is = response.body().byteStream();//使用 BitmapFactory 的 decodeStream 将图片的输入流直接转换为 Bitmap final Bitmap bitmap = BitmapFactory.decodeStream(is);//在主线程中操作UIrunOnUiThread(new Runnable() {@Overridepublic void run() {//然后将Bitmap设置到 ImageView 中imageView.setImageBitmap(bitmap);}});is.close();
}

主要注释已在代码中了。

7.异步POST请求上传Multipart文件

我们在有些情况下既要上传文件还要上传其他类型字段。比如在个人中心我们可以修改名字，年龄，修改图像，这其实就是一个表单。这里我们用到MuiltipartBody ,它是RequestBody 的一个子类,我们提交表单就是利用这个类来构建一个 RequestBody，我们来看一下具体代码。

        //1.创建OkHttpClient对象OkHttpClient  okHttpClient = new OkHttpClient();//上传的图片File file = new File(Environment.getExternalStorageDirectory(), "zhuangqilu.png");//2.通过new MultipartBody build() 创建requestBody对象，RequestBody  requestBody = new MultipartBody.Builder()//设置类型是表单.setType(MultipartBody.FORM)//添加数据.addFormDataPart("username","zhangqilu").addFormDataPart("age","25").addFormDataPart("image","zhangqilu.png",
RequestBody.create(MediaType.parse("image/png"),file)).build();//3.创建Request对象，设置URL地址，将RequestBody作为post方法的参数传入Request request = new Request.Builder().url("url").post(requestBody).build();//4.创建一个call对象,参数就是Request请求对象Call call = okHttpClient.newCall(request);//5.请求加入调度,重写回调方法call.enqueue(new Callback() {@Overridepublic void onFailure(Call call, IOException e) {}@Overridepublic void onResponse(Call call, Response response) throws IOException {}});

注意事项

如果提交的是表单,一定要设置表单类型， setType(MultipartBody.FORM)
提交文件 addFormDataPart() 方法的第一个参数就是类似于键值对的键,是供服务端使用的，第二个参数是文件的本地的名字，第三个参数是 RequestBody，里面包含了我们要上传的文件的路径以及 MidiaType。