Android 一个改善的okHttp封装库

一、概述

之前写了篇Android OkHttp完全解析 是时候来了解OkHttp了，其实主要是作为okhttp的普及文章，当然里面也简单封装了工具类，没想到关注和使用的人还挺多的，由于这股热情，该工具类中的方法也是剧增，各种重载方法，以致于使用起来极不方便，实在惭愧。

于是，在这个周末，抽点时间对该工具类，进行了重新的拆解与编写，顺便完善下功能，尽可能的提升其使用起来的方便性和易扩展性。

标题的改善，也是指的是对于我之前的代码进行改善。

如果你对okhttp不了解，可以通过Android OkHttp完全解析 是时候来了解OkHttp了进行了解。

ok，那么目前，该封装库志支持：

一般的get请求
一般的post请求
基于Http的文件上传
文件下载
上传下载的进度回调
加载图片
支持请求回调，直接返回对象、对象集合
支持session的保持
支持自签名网站https的访问，提供方法设置下证书就行
支持取消某个请求
源码地址：https://github.com/hongyangAndroid/okhttp-utils

引入：

Android Studio

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

compile project(‘:okhttputils’)
1
1
或者

compile ‘com.zhy:okhttputils:2.0.0’
1
1
Eclipse

自行copy源码。

二、基本用法

目前基本的用法格式为：

OkHttpUtils
.get()
.url(url)
.addParams(“username”, “hyman”)
.addParams(“password”, “123”)
.build()
.execute(callback);
1
2
3
4
5
6
7
1
2
3
4
5
6
7
通过链式去根据自己的需要添加各种参数，最后调用execute(callback)进行执行，传入callback则代表是异步。如果单纯的execute()则代表同步的方法调用。

可以看到，取消了之前一堆的get重载方法，参数也可以进行灵活的选择了。

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

（1）GET请求

String url = “http://www.csdn.net/“;
OkHttpUtils
.get()
.url(url)
.addParams(“username”, “hyman”)
.addParams(“password”, “123”)
.build()
.execute(new StringCallback()
{
@Override
public void onError(Request request, Exception e)
{

            }            @Override            public void onResponse(String response)            {            }        });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
（2）POST请求

OkHttpUtils
.post()
.url(url)
.addParams(“username”, “hyman”)
.addParams(“password”, “123”)
.build()
.execute(callback);
1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
8
（3）Post String

OkHttpUtils
.postString()
.url(url)
.content(new Gson().toJson(new User(“zhy”, “123”)))
.build()
.execute(new MyStringCallback());
1
2
3
4
5
6
1
2
3
4
5
6
将string作为请求体传入到服务端，例如json字符串。

（4）Post File

OkHttpUtils
.postFile()
.url(url)
.file(file)
.build()
.execute(new MyStringCallback());
1
2
3
4
5
6
1
2
3
4
5
6
将file作为请求体传入到服务端.

（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());
1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
8
（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());    }});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
（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);    }});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
哈，目前来看，清晰多了。

三、对于上传下载的回调

new Callback