1 简介
OKHttp是一个当前主流的网络请求的开源框架
Square公司开发，用于替代HttpUrlConnection和Apache HttpClient
Android4.4开始，google已经开始将源码中的HttpURLConnection替换为OkHttp
Android6.0里已移除HttpClient
优点 （版本一）
支持HTTP2/SPDY（SPDY是Google开发的基于TCP的传输层协议，用以最小化网络延迟，提升网络速度，优化用户的网络使用体验。）
socket自动选择最好路线，并支持自动重连，拥有自动维护的socket连接池，减少握手次数，减少了请求延迟，共享Socket,减少对服务器的请求次数。
基于Headers的缓存策略减少重复的网络请求。
拥有Interceptors轻松处理请求与响应（自动处理GZip压缩）。
优点 （版本二）
1)支持http2，对一台机器的所有请求共享同一个socket
2)内置连接池，支持连接复用，减少延迟
3)支持透明的gzip压缩响应体
4)通过缓存避免重复的请求
5)请求失败时自动重试主机的其他ip，自动重定向
6)好用的API
功能
PUT，DELETE，POST，GET等请求
文件的上传下载
加载图片(内部会图片大小自动压缩)
支持请求回调，直接返回对象、对象集合
支持session的保持
2 基本使用
首先记得在build.gradle 和 配置文件分别加上依赖 和 网络权限
compile 'com.squareup.okhttp3:okhttp:3.8.0' compile 'com.squareup.okio:okio:1.12.0'
<uses-permission android:name="android.permission.INTERNET"/>
2-1 异步Get请求
异步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的方式写文件
实例：
我新建了一个活动，并在布局里放入一个按钮，点击就会开始执行网络请求
private void getRequest() { //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() { //请求失败执行的方法
@Override
public void onFailure(Call call, IOException e) {
} //请求成功执行的方法
@Override
public void onResponse(Call call, Response response) throws IOException {
String data = response.body().string();
Log.d("response",data);
runOnUiThread(new Runnable() { @Override
public void run() { //更新UI
}
});
}
});
}打个断点可以看到请求成功，返回了一串html的文字
2-2 同步Get请求 （较少用）
同步GET请求和异步GET请求基本一样，不同地方是同步请求调用Call的execute()方法，而异步请求调用call.enqueue()方法
//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() { @Override
public void run() { try { //同步调用,返回Response,会抛出IO异常
Response response = call.execute();
} catch (IOException e) {
e.printStackTrace();
}
}
}).start();2-3 异步POST——键值对
通过FormBody
添加多个String键值对
最后为Request添加post方法并传入formBody经过对比我们发现异步的POST请求和GET请求步骤很相似
这里就不赘述了
private void postAsynHttp() {
mOkHttpClient=new OkHttpClient();
RequestBody formBody = new FormBody.Builder()
.add("size", "10")
.build();
Request request = new Request.Builder()
.url("http://api.1-blog.com/biz/bizserver/article/list.do")
.post(formBody)
.build();
Call call = mOkHttpClient.newCall(request);
call.enqueue(new Callback() { @Override
public void onFailure(Call call, IOException e) {
} @Override
public void onResponse(Call call, Response response) throws IOException {
String str = response.body().string();
runOnUiThread(new Runnable() { @Override
public void run() {
Toast.makeText(getApplicationContext(), "请求成功", Toast.LENGTH_SHORT).show();
}
});
}
});
}2-4 异步POST——上传文件
我们需要设置上传类型MIME，我们打算上传一个纯文本
因此需要用到MediaType.parse("text/plain; charset=utf-8")
常见的类型有： 更多参考这里
再来看例子
// step 1: 创建 OkHttpClient 对象
OkHttpClient okHttpClient = new OkHttpClient(); //step 2:创建 RequestBody 以及所需的参数
//2.1 获取文件
File file = new File(Environment.getExternalStorageDirectory() + "test.txt"); //2.2 创建 MediaType 设置上传文件类型
MediaType MEDIATYPE = MediaType.parse("text/plain; charset=utf-8"); //2.3 获取请求体
RequestBody requestBody = RequestBody.create(MEDIATYPE, file); //step 3：创建请求
Request request = new Request.Builder().url("http://www.baidu.com")
.post(requestBody)
.build(); //step 4 建立联系
okHttpClient.newCall(request).enqueue(new Callback() { @Override
public void onFailure(Call call, IOException e) { // 请求失败
} @Override
public void onResponse(Call call, Response response) throws IOException { // 请求成功
}
});最后别忘了加文件权限
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
2-5 异步Get请求——下载文件
比如下载一张图片，我们得到Response后将流写进我们指定的图片文件中就可以了
private void downAsynFile() {
mOkHttpClient = new OkHttpClient();
String url = "http://img.my.csdn.net/uploads/201603/26/1458988468_5804.jpg";
Request request = new Request.Builder().url(url).build();
mOkHttpClient.newCall(request).enqueue(new Callback() { @Override
public void onFailure(Call call, IOException e) {
} @Override
public void onResponse(Call call, Response response) {
InputStream inputStream = response.body().byteStream();
FileOutputStream fileOutputStream = null; try {
fileOutputStream = new FileOutputStream(new File("/sdcard/123.jpg")); byte[] buffer = new byte[2048]; int len = 0; while ((len = inputStream.read(buffer)) != -1) {
fileOutputStream.write(buffer, 0, len);
}
fileOutputStream.flush();
} catch (IOException e) {
e.printStackTrace();
}
Log.d("123", "文件下载成功");
}
});
}2-6 异步上传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() { @Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
}
});3 其他配置
3-1 设置超时时间和缓存
和OkHttp2.x有区别的是不能通过OkHttpClient直接设置超时时间和缓存了，而是通过OkHttpClient.Builder来设置，通过builder配置好OkHttpClient后用builder.build()来返回OkHttpClient，所以我们通常不会调用new OkHttpClient()来得到OkHttpClient，而是通过builder.build()：
File sdcache = getExternalCacheDir();int cacheSize = 10 * 1024 * 1024; OkHttpClient.Builder builder = new OkHttpClient.Builder() .connectTimeout(15, TimeUnit.SECONDS) .writeTimeout(20, TimeUnit.SECONDS) .readTimeout(20, TimeUnit.SECONDS) .cache(new Cache(sdcache.getAbsoluteFile(), cacheSize)); OkHttpClient mOkHttpClient=builder.build();
3-2 添加请求头
将请求头以键值对形式添加，可添加多个请求头
Request.Builder builder = new Request.Builder().url(url);
builder.addHeader("X-UA","android");3-3 取消请求
有时候网络条件不好的情况下，用户会主动关闭页面，这时候需要取消正在请求的http request, OkHttp提供了cancel方法，但是实际在使用过程中发现，如果调用cancel()方法，会回调到CallBack里面的 onFailure方法中，
测试发现不同的失败类型返回的IOException e 不一样，所以可以通过e.toString 中的关键字来区分不同的错误类型
自己主动取消的错误的 java.net.SocketException: Socket closed超时的错误是 java.net.SocketTimeoutException网络出错的错误是java.net.ConnectException: Failed to connect to xxxxx
因此我们可以做如下处理
call.enqueue(new Callback() { @Override
public void onFailure(Call call, IOException e) { if(e.toString().contains("closed")) { //如果是主动取消的情况下
}else{ //其他情况下
}
}在okhttp3.Callback的回调方法里面有个参数是Call
这个call可以单独取消相应的请求，随便在onFailure或者onResponse方法内部执行call.cancel()都可以
如果想取消所有的请求，则可以okhttpclient.dispatcher().cancelAll();
- Android不规则图片点击事件响应-中国地图
- Android 滑动列表实现条目悬浮顶端
- Attempt to invoke virtual method 'int android.view.View.getImportantForAccessibility()
- android P Service遇到的坑
- Android Q Beta 1版调整了屏显布局 这样的安卓你接受吗
- Android Q 首个 Beta 版本推送，正式版第三季度到来
- 2019年Android面试必备
- 安卓中 WebView 使用漏洞
- Android：最全面的 Webview 详解
- Android常见问题及答案2
- 2019Android面试题基础
- 2019Android面试题及答案2
- 2019Android面试题及答案
- 金三银四，冲击大厂，你值得拥有的一份2019初中级Android开发社招面试总结+解答
- 使用ViewPager实现三个fragment切换
- Android RadioButton设置选中时文字和背景颜色同时改变
- Android底部导航选项卡
- Viewpager无限循环
- app在手机上安卓失败问题
- OkHttp上传文件，监听上传进度
- Android实现富文本
- WebViewClient与WebChromeClient有和不同
- android在AES加密时出现：no such provider: Crypto 的问题
- Android性能优化之内存泄漏
- Android性能优化之布局优化
- Java中的堆、栈和堆栈的区别介绍
- 如何把一个布局转化为Drawable
- Android7.0 无法打开相机
- FontMetrics基本知识
- TextView获取指定行文字