Android 一个改进的okHttp封装库

Posted 2020-06-17

一、概述

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

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

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

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

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

• 一般的get请求
• 一般的post请求
• 基于Http的文件上传
• 文件下载
• 上传下载的进度回调
• 加载图片
• 支持请求回调，直接返回对象、对象集合
• 支持session的保持
• 支持自签名网站https的访问，提供方法设置下证书就行
• 支持取消某个请求

源码地址：https://github.com/hongyangAndroid/okhttp-utils

二、基本用法

目前基本的用法格式为：

new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .headers(headers)
    .tag(tag)
    .get(callback);

通过Builder去根据自己的需要添加各种参数，最后调用get(callback)进行执行，传入callback则代表是异步。如果单纯的get()则代表同步的方法调用。

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

类似的，除了get方法，还有post、upload、download、displayImage。用法基本都一致。下面简单看一下。

（1）GET请求

//最基本
new OkHttpRequest.Builder()
    .url(url)
    .get(callback);
//扩展
new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .headers(headers)
    .tag(tag)
    .get(callback);

（2）POST请求

//最基本
new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .post(callback);
//扩展
new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .headers(headers)
    .tag(tag)
    .post(callback);

（3）基于POST的文件上传

//基本
new OkHttpRequest.Builder()
    .url(url)
    .files(files)
    .upload(callback);
//扩展
new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .headers(headers)
    .tag(tag)
    .files(files)
    .upload(callback);

（4）下载文件

//基本
new OkHttpRequest.Builder()
    .url(url)
    .destFileDir(destFileDir)
    .destFileName(destFileName)
    .download(callback);
//扩展
new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .headers(headers)
    .tag(tag)
    .destFileDir(destFileDir)
    .destFileName(destFileName)
    .download(callback);

（5）显示图片

//基本
 new OkHttpRequest.Builder()
    .url(url)
    .imageview(imageView)
    .displayImage(callback);
//扩展
new OkHttpRequest.Builder()
    .url(url)
    .params(params)
    .headers(headers)
    .tag(tag)
    .imageview(imageView)
    .errorResId(errorResId)
    .displayImage(callback);

会自动根据ImageView的大小进行压缩。

哈，目前来看，清晰多了。

三、对于上传下载的回调

new ResultCallback<List<User>>()
{
    //...
    @Override
    public void inProgress(float progress)
    {
       //use progress: 0 ~ 1
    }
}

对于传入的callback有个inProgress方法，当调用upload(callback)，download(callback)方法时，progress回调0~1.(UI线程)。

四、对于自动解析为实体类

//对象
new ResultCallback <User>()
{
    //...
    @Override
    public void onResponse(User user)
    {
        mTv.setText(user.username);
    }
}

//集合
new ResultCallback<List<User>>()
{
    //...
    @Override
    public void onResponse(List<User> users)
    {
        mTv.setText(users.get(0).username);
    }
}

目前支持单个对象，或者集合，内部依赖Gson完成。

注意：泛型一定要设置，如果你不需要转化为实体对象，就写new ResultCallback<String>(){}，

五、对于https单向认证

非常简单，拿到xxx.cert的证书。

然后调用

OkHttpClientManager.getInstance()
        .getHttpsDelegate()
       .setCertificates(inputstream);

建议使用方式，例如我的证书放在assets目录：

/**
 * Created by zhy on 15/8/25.
 */
public class MyApplication extends Application
{
    @Override
    public void onCreate()
    {
        super.onCreate();

        try
        {
            OkHttpClientManager.getInstance()
                        .getHttpsDelegate()
                    .setCertificates(getAssets().open("aaa.cer"),
                            getAssets().open("server.cer"));
        } catch (IOException e)
        {
            e.printStackTrace();
        }
    }
}

即可。别忘了注册Application。

注意：如果https网站为权威机构颁发的证书，不需要以上设置。自签名的证书才需要。

六、浅谈封装

其实整个封装的过程比较简单，这里简单描述下，对于okhttp一个请求的流程大致是这样的：

//创建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();
    }
});             

其中主要的差异，其实就是request的构建过程。

我对Request抽象了一个类：OkHttpRequest

public abstract class OkHttpRequest
{
    protected RequestBody requestBody;
    protected Request request;

    protected String url;
    protected String tag;
    protected Map<String, String> params;
    protected Map<String, String> headers;

    protected OkHttpRequest(String url, String tag,
                            Map<String, String> params, Map<String, String> headers)
    {
        this.url = url;
        this.tag = tag;
        this.params = params;
        this.headers = headers;
    }

    protected abstract Request buildRequest();
    protected abstract RequestBody buildRequestBody();

    protected void prepareInvoked(ResultCallback callback)
    {
        requestBody = buildRequestBody();
        requestBody = wrapRequestBody(requestBody, callback);
        request = buildRequest();
    }

    protected RequestBody wrapRequestBody(RequestBody requestBody, final ResultCallback callback)
    {
        return requestBody;
    }


    public void invokeAsyn(ResultCallback callback)
    {
        prepareInvoked(callback);
        mOkHttpClientManager.execute(request, callback);
    }


     // other common methods
 }   

一个request的构建呢，我分三个步骤：buildRequestBody , wrapRequestBody ,buildRequest这样的次序，当以上三个方法没有问题时，我们就拿到了request，然后执行即可。

但是对于不同的请求，requestBody以及request的构建过程是不同的，所以大家可以看到buildRequestBody ,buildRequest为抽象的方法，也就是不同的请求类，比如OkHttpGetRequest、OkHttpPostRequest等需要自己去构建自己的request。

对于wrapRequestBody方法呢，可以看到它默认基本属于空实现，主要是因为并非所有的请求类都需要复写它，只有上传的时候呢，需要回调进度，需要对requestBody进行包装，所以这个方法类似于一个钩子。

其实这个过程有点类似模板方法模式，有兴趣可以看看一个短篇介绍设计模式 模版方法模式 展现程序员的一天 .

对于更加详细的用法，可以查看github上面的readme，以及demo，目前demo包含：

对于上传文件的两个按钮，需要自己搭建服务器，其他的按钮可以直接测试。