Android Studio 配置gradle:
compile 'com.squareup.okhttp:okhttp:2.7.5'
compile 'com.squareup.okio:okio:1.7.0'
1. 异步Get请求
最简单的Get请求,老规矩请求百度:
public void getAsynHttp(){
OkHttpClient okHttpClient = new OkHttpClient();
final com.squareup.okhttp.Request request= new com.squareup.okhttp.Request.Builder().url("http://baidu.com").build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(com.squareup.okhttp.Request request, IOException e) {
}
@Override
public void onResponse(com.squareup.okhttp.Response response) throws IOException {
String str = response.body().string();
Log.i("zsj", str);
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(getApplicationContext(), "请求成功", Toast.LENGTH_LONG).show();
}
});
}
});
}
值得关注的是,onRespsonse回调并不是UI线程
2. 同步GET请求
public String getSyncHttp() throws IOException{
OkHttpClient okHttpClient = new OkHttpClient();
final com.squareup.okhttp.Request request = new com.squareup.okhttp.Request.Builder().url("http://baidu.com").build();
Call call = okHttpClient.newCall(request);
com.squareup.okhttp.Response mResponse = call.execute();
if (mResponse.isSuccessful()){
return mResponse.body().string();
}
else{
throw new IOException("Unexpected code" + mResponse);
}
}
同步Get请求和异步调用区别就是调用了call的execute()方法
3. 异步POST请求
public void postAsynHttp(){
OkHttpClient okHttpClient = new OkHttpClient();
com.squareup.okhttp.RequestBody fromBody = new FormEncodingBuilder().add("size", "10").build();
com.squareup.okhttp.Request request = new com.squareup.okhttp.Request.Builder().url("http://39.108.135.114:8001/ZRobot/function/getAppResponce").post(fromBody).build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(com.squareup.okhttp.Request request, IOException e) {
}
@Override
public void onResponse(com.squareup.okhttp.Response response) throws IOException {
final String str = response.body().string();
Log.i("zsj", str);
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(getApplicationContext(), str, Toast.LENGTH_LONG).show();
}
});
}
});
}
- post与get不同的就是要要创建RequestBody并传进Request中
- 同样,其回调不在UI线程
4. 请求缓存设置
全局用户唯一的缓存访问实例,okhttp框架全局必须只有一个OkHttpClient实例(new OkHttpClient()),并在第一次创建实例的时候,配置好缓存。
Step 1 : 设置缓存路径和大小,并设置给okHttpClient:(okHttpClient需要是一个全局的实例)
okHttpClient = new OkHttpClient();
File sdcache = getExternalCacheDir();
int cacheSize = 10*1024*1024;
okHttpClient.setCache(new Cache(sdcache.getAbsoluteFile(), cacheSize));
Step 2 : 异步请求
public void getAsynHttpCache(){
final com.squareup.okhttp.Request request = new com.squareup.okhttp.Request.Builder().url("http://www.baidu.com").build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(com.squareup.okhttp.Request request, IOException e) {
}
@Override
public void onResponse(com.squareup.okhttp.Response response) throws IOException {
if(response.cacheResponse() != null){
String str = response.cacheResponse().toString();
Log.i("zsj", "cache--" + str);
}
else{
response.body().string();
String str = response.networkResponse().toString();
Log.i("zsj", "net--" + str);
}
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(getApplicationContext(), "缓存post请求成功", Toast.LENGTH_LONG).show();
}
});
}
});
}
5. 设置超时时间
mOkHttpClient = new OkHttpClient();
mOkHttpClient.setConnectTimeout(15, TimeUnit.SECONDS);
mOkHttpClient.setWriteTimeout(20, TimeUnit.SECONDS);
mOkHttpClient.setReadTimeout(20, TimeUnit.SECONDS);
6. 取消请求
- 使用call.cancel()可以立即停止掉一个正在执行的call。如果一个线程正在写请求或者读响应,将会引发IOException。当用户离开一个应用时或者跳到其他界面时,使用Call.cancel()可以节约网络资源,另外不管同步还是异步的call都可以取消。
- 也可以通过tags来同时取消多个请求。当你构建一请求时,使用RequestBuilder.tag(tag)来分配一个标签。之后你就可以用OkHttpClient.cancel(tag)来取消所有带有这个tag的call。
Step 1 : 为了模拟场景,创建一个定时的线程池
private ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);
Step 2 : 实现取消请求
private void cancel(){
final Request request = new Request.Builder()
.url("http://www.baidu.com")
.cacheControl(CacheControl.FORCE_NETWORK)
.build();
Call call=null;
call = mOkHttpClient.newCall(request);
final Call finalCall = call;
//100毫秒后取消call
executor.schedule(new Runnable() {
@Override public void run() {
finalCall.cancel();
}
}, 100, TimeUnit.MILLISECONDS);
call.enqueue(new Callback() {
@Override
public void onFailure(Request request, IOException e) {
}
@Override
public void onResponse(final Response response) {
if (null != response.cacheResponse()) {
String str = response.cacheResponse().toString();
Log.i("wangshu", "cache---" + str);
} else {
try {
response.body().string();
} catch (IOException e) {
Log.i("wangshu", "IOException");
e.printStackTrace();
}
String str = response.networkResponse().toString();
Log.i("wangshu", "network---" + str);
}
}
});
Log.i("wangshu", "是否取消成功"+call.isCanceled());
}
7. 关于封装
OkHttpFinal是一个很不错的选择
oKHttp 2.x和3.x的注意内容
1. OkHttp3异步POST请求没有FormEncodingBuilder类,替代它的是功能更加强大的FormBody
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();
Log.i("zsj", str);
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(getApplicationContext(), "请求成功", Toast.LENGTH_SHORT).show();
}
});
}
});
}
2. OkHttp3不能通过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();
补全okHttp的用法
1.异步上传文件
- 上传文件本身是一个Post请求
Step 1 : 定义上传文件类型
public static final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");
Setp 2 : 将根目录中的zhongshijie.txt文件上传到服务器
private void postAsynFile() {
mOkHttpClient=new OkHttpClient();
File file = new File("/sdcard/zhongshijie.txt");
Request request = new Request.Builder()
.url("https://api.github.com/markdown/raw")
.post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file))
.build();
mOkHttpClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
Log.i("zsj",response.body().string());
}
});
}
文件权限需要加上
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
2. 异步下载文件
private void downAsynFile() {
mOkHttpClient = new OkHttpClient();
String url = "https://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/wangshu.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) {
Log.i("zsj", "IOException");
e.printStackTrace();
}
Log.d("zsj", "文件下载成功");
}
});
}
3. 异步上传Multipart文件
这种场景很常用,我们有时会上传文件同时还需要传其他类型的字段,OkHttp3实现起来很简单,需要注意的是没有服务器接收我这个Multipart文件,所以这里只是举个例子,具体的应用还要结合实际工作中对应的服务器。
首先定义上传文件类型:
private static final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");
private void sendMultipart(){
mOkHttpClient = new OkHttpClient();
RequestBody requestBody = new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("title", "wangshu")
.addFormDataPart("image", "wangshu.jpg",
RequestBody.create(MEDIA_TYPE_PNG, new File("/sdcard/wangshu.jpg")))
.build();
Request request = new Request.Builder()
.header("Authorization", "Client-ID " + "...")
.url("https://api.imgur.com/3/image")
.post(requestBody)
.build();
mOkHttpClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
Log.i("wangshu", response.body().string());
}
});
}