Android okhttp入门到熟悉全讲解

2020-08-12 14:26:00

最近一年来身边开发的朋友越来越多的提到非常火爆的网络请求库OkHttp，我也试了一下，确实是好用多了，比起从前自己写网络框架封装，继承，还要自己捕获处理有可能的每一种异常，洋洋洒洒一下来就是一两个礼拜几千行代码，现在确实是方便快捷了很多，大大的提高了开发效率。现在先让我们来说过一下okhttp跟volley的差异和优劣。

okhttp

使用OkHttp需要 okio.jar (80k), okhttp.jar(330k)这2个jar包，总大小差不多400k,加上自己的封装，差不多得410k。

OkHttp 提供了对 HTTP/2 和 SPDY 的支持，并提供了连接池，GZIP 压缩和 HTTP 响应缓存功能。

优点

支持http请求，https请求。

支持文件下载。

使用的是HttpURLConnection,不要担心android版本的变换。（至少目前是都支持的）。

支持get，post请求。

基于Http的文件上传。

加载图片。

缺点

比如callback回来是在线程里面, 不能刷新UI，需要我们手动处理。

封装比较麻烦。

Volley

使用Volley 需要Volley.jar(120k)，加上自己的封装最多140k。

2013年Google I/O大会上推出了一个新的网络通信框架Volley，它是开源的。特点：特别适合数据量小，通信频繁的网络操作。

优点

非常适合进行数据量不大，但通信频繁的网络操作。

内部分装了异步线程。

支持get，post网络请求。

图片下载。

可直接在主线程调用服务端并处理返回结果。

可以取消请求，容易扩展，面向接口编程。

缺点

对大文件下载 Volley的表现非常糟糕。

只支持http请求。

在BasicNetwork中判断了statusCode(statusCode < 200 || statusCode > 299)，如果合条件直

图片加载性能一般。

使用的是httpclient，HttpURLConnection。不过在android 6.0不支持httpclient了，如果想支持得添加org.apache.http.legacy.jar。

因为我现在正在用okhttp，所以，Volley下次再讲

OkHttp官网地址：http://square.github.io/okhttp/

OkHttp GitHub地址：https://github.com/square/okhttp

官方文档上概括起来：OkHttp是一款优秀的HTTP框架，它支持get请求和post请求，支持基于Http的文件上传和下载，支持加载图片，支持下载文件透明的GZIP压缩，支持响应缓存避免重复的网络请求，支持使用连接池来降低响应延迟问题。

okhttp的简单使用，主要包含：

一般的get请求
一般的post请求
基于Http的文件上传
文件下载
加载图片
支持请求回调，直接返回对象、对象集合
支持session的保持

最后会对上述几个功能进行封装，完整的封装类的地址见：https://github.com/hongyangAndroid/okhttp-utils

使用前，对于Android Studio的用户，可以选择添加:

compile 'com.squareup.okhttp:okhttp:2.4.0'

或者Eclipse的用户，可以下载最新的jar https://search.maven.org/remote_content?g=com.squareup.okhttp&a=okhttp&v=LATEST ，添加依赖就可以用了。

注意:okhttp内部依赖okio，别忘了同时导入okio：

gradle: compile 'com.squareup.okio:okio:1.5.0'

最新的jar地址： https://search.maven.org/remote_content?g=com.squareup.okio&a=okio&v=LATEST

使用

（一）Http Get

网络加载库，那么最常见的肯定就是http get请求了，比如获取一个网页的内容

//创建okHttpClient对象

OkHttpClient mOkHttpClient = new OkHttpClient();

//创建一个Request

final Request request = new Request.Builder()

.url("https://github.com/hongyangAndroid")

.build();

//new call

Call call = mOkHttpClient.newCall(request);

//请求加入调度

call.enqueue(new Callback()

{

@Override

public void onFailure(Request request, IOException e)

{

}

@Override

public void onResponse(final Response response) throws IOException

{

//String htmlStr = response.body().string();

}

});

以上就是发送一个get请求的步骤，首先构造一个Request对象，参数最起码有个url，当然你可以通过Request.Builder设置更多的参数比如：header、method等。
然后通过request的对象去构造得到一个Call对象，类似于将你的请求封装成了任务，既然是任务，就会有execute()和cancel()等方法。
最后，我们希望以异步的方式去执行请求，所以我们调用的是call.enqueue，将call加入调度队列，然后等待任务执行完成，我们在Callback中即可得到结果。

需要注意几点：

1、onResponse回调的参数是response，一般情况下，比如我们希望获得返回的字符串，可以通过response.body().string()获取；如果希望获得返回的二进制字节数组，则调用response.body().bytes()；如果你想拿到返回的inputStream，则调用response.body().byteStream()

看到这，你可能会奇怪，竟然还能拿到返回的inputStream，看到这个最起码能意识到一点，这里支持大文件下载，有inputStream我们就可以通过IO的方式写文件。不过也说明一个问题，这个onResponse执行的线程并不是UI线程。的确是的，如果你希望操作控件，还是需要使用handler等，例如：

@Override

public void onResponse(final Response response) throws IOException

{

final String res = response.body().string();

runOnUiThread(new Runnable()

{

@Override

public void run()

{

mTv.setText(res);

}

});

}

2、我们这里是异步的方式去执行，当然也支持阻塞的方式，上面我们也说了Call有一个execute()方法，你也可以直接调用call.execute()通过返回一个Response。

(二) Http Post 携带参数

看来上面的简单的get请求，基本上整个的用法也就掌握了，比如post携带参数，也仅仅是Request的构造的不同。

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(){});

大家都清楚，post的时候，参数是包含在请求体中的；所以我们通过FormEncodingBuilder。添加多个String键值对，然后去构造RequestBody，最后完成我们Request的构造。

（三）基于Http的文件上传

接下来我们在介绍一个可以构造RequestBody的Builder，叫做MultipartBuilder。当我们需要做类似于表单上传的时候，就可以使用它来构造我们的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()

{

//...

});

上述代码向服务器传递了一个键值对username:码农和一个文件。我们通过MultipartBuilder的addPart方法可以添加键值对或者文件。

其实类似于我们拼接模拟浏览器行为的方式，如果你对这块不了解，可以参考：从原理角度解析Android （Java） http 文件上传

ok，对于我们最开始的目录还剩下图片下载，文件下载；这两个一个是通过回调的Response拿到byte[]然后decode成图片；文件下载，就是拿到inputStream做写文件操作，我们这里就不赘述了。

封装

（一）使用

一般的get请求

OkHttpClientManager.getAsyn("https://www.baidu.com", new OkHttpClientManager.ResultCallback<String>()
{
@Override
public void onError(Request request, Exception e)
{
e.printStackTrace();
}

@Override
public void onResponse(String u)
{
mTv.setText(u);//注意这里是UI线程
}
});
对于一般的请求，我们希望给个url，然后CallBack里面直接操作控件。
文件上传且携带参数
我们希望提供一个方法，传入url,params,file,callback即可。
OkHttpClientManager.postAsyn("http://192.168.1.103:8080/okHttpServer/fileUpload",// new OkHttpClientManager.ResultCallback<String>() { @Override public void onError(Request request, IOException e) { e.printStackTrace(); } @Override public void onResponse(String result) { } },// file,// "mFile",// new OkHttpClientManager.Param[]{ new OkHttpClientManager.Param("username", "manong"), new OkHttpClientManager.Param("password", "123")} );
键值对没什么说的，参数3为file，参数4为file对应的name，这个name不是文件的名字；对应于http中的<input type="file" name="mFile" >
对应的是name后面的值，即mFile
文件下载
对于文件下载，提供url，目标dir，callback即可。
OkHttpClientManager.downloadAsyn(
"http://192.168.1.103:8080/okHttpServer/files/messenger_01.png",
Environment.getExternalStorageDirectory().getAbsolutePath(),
new OkHttpClientManager.ResultCallback<String>()
{
@Override
public void onError(Request request, IOException e)
{

}
@Override
public void onResponse(String response)
{
//文件下载成功，这里回调的reponse为文件的absolutePath
}
});
展示图片

展示图片，我们希望提供一个url和一个imageview，如果下载成功，直接帮我们设置上即可。

OkHttpClientManager.displayImage(mImageView,

"http://images.csdn.net/20150817/1.jpg");

内部会自动根据imageview的大小自动对图片进行合适的压缩。虽然，这里可能不适合一次性加载大量图片的场景，但是对于app中偶尔有几个图片的加载，还是可用的。

整合Gson

很多人提出项目中使用时，服务端返回的是Json字符串，希望客户端回调可以直接拿到对象，于是整合进入了Gson，完善该功能。

（一）直接回调对象

例如现在有个User实体类：

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;

}

@Override

public String toString()

{

return "User{" +

"username='" + username + '\'' +

", password='" + password + '\'' +

'}';

}

服务端返回：

{"username":"manong","password":"123"}

客户端可以如下方式调用：

OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUser",

new OkHttpClientManager.ResultCallback<User>()

{

@Override

public void onError(Request request, Exception e)

{

e.printStackTrace();

}

@Override

public void onResponse(User user)

{

mTv.setText(u.toString());//UI线程

}

});

我们传入泛型User，在onResponse里面直接回调User对象。

这里特别要注意的事，如果在json字符串->实体对象过程中发生错误，程序不会崩溃，onError方法会被回调。

注意：这里做了少许的更新，接口命名从StringCallback修改为ResultCallback。接口中的onFailure方法修改为onError。

(二) 回调对象集合

依然是上述的User类，服务端返回

[{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]

则客户端可以如下调用：

OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUsers",

new OkHttpClientManager.ResultCallback<List<User>>()

{

@Override

public void onError(Request request, Exception e)

{

e.printStackTrace();

}

@Override

public void onResponse(List<User> us)

{

Log.e("TAG", us.size() + "");

mTv.setText(us.get(1).toString());

}

});

唯一的区别，就是泛型变为List<User> ，ok ，如果发现bug或者有任何意见欢迎留言。

欢迎关注我的微博： http://blog.csdn.net/wang492239163