关闭

Android 一个改善的okHttp封装库

标签: Androidandroid开发appandroid studio
235人阅读 评论(0) 收藏 举报
分类:

http://blog.csdn.net/lmj623565791/article/details/49734867
本文出自:【张鸿洋的博客】


一、概述

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

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

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

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

ok,那么目前,该封装库志支持:

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

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


引入:

Android Studio

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

1、compile project(':okhttputils')
或者
1、compile 'com.zhy:okhttputils:2.0.0'

Eclipse


自行copy源码。


二、基本用法

目前基本的用法格式为:

OkHttpUtils
    .get()
    .url(url)
    .addParams("username", "hyman")
    .addParams("password", "123")
    .build()
    .execute(callback);


通过链式去根据自己的需要添加各种参数,最后调用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)
                {

                }
            });

(2)POST请求

OkHttpUtils
    .post()
    .url(url)
    .addParams("username", "hyman")
    .addParams("password", "123")
    .build()
    .execute(callback);

(3)Post String

OkHttpUtils
    .postString()
    .url(url)
    .content(new Gson().toJson(new User("zhy", "123")))
    .build()
    .execute(new MyStringCallback()); 

将string作为请求体传入到服务端,例如json字符串。

(4)Post File

OkHttpUtils
    .postFile()
    .url(url)
    .file(file)
    .build()
    .execute(new MyStringCallback());

将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());

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

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


三、对于上传下载的回调

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

对于传入的callback有个inProgress方法,需要拿到进度直接复写该方法即可。

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

目前去除了Gson的依赖,提供了自定义Callback的方式,让用户自己去解析返回的数据,目前提供了StringCallbackFileCallback,BitmapCallback 分别用于返回string,文件下载,加载图片。

当然如果你希望解析为对象,你可以:

public abstract class UserCallback extends Callback<User>
{
    //非UI线程,支持任何耗时操作
    @Override
    public User parseNetworkResponse(Response response) throws IOException
    {
        String string = response.body().string();
        User user = new Gson().fromJson(string, User.class);
        return user;
    }
}

自己使用自己喜欢的Json解析库完成即可。

解析成List<User>,则如下:

public abstract class ListUserCallback extends Callback<List<User>>
{
    @Override
    public List<User> parseNetworkResponse(Response response) throws IOException
    {
        String string = response.body().string();
        List<User> user = new Gson().fromJson(string, List.class);
        return user;
    }


}


五、对于https单向认证

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

然后调用

OkHttpUtils.getInstance()
        .setCertificates(inputstream);
建议使用方式,例如我的证书放在assets目录:

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

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

即可。别忘了注册Application。

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

六、配置

(1)全局配置

可以在Application中,通过:

<code class="language-java hljs  has-numbering">OkHttpClient client = 
OkHttpUtils.getInstance().getOkHttpClient();</code>

然后调用client的各种set方法。

例如:

<code class="language-java hljs  has-numbering">client.setConnectTimeout(<span class="hljs-number">100000</span>, TimeUnit.MILLISECONDS);</code>

(2)为单个请求设置超时

比如涉及到文件的需要设置读写等待时间多一点。

<code class="language-java hljs  has-numbering"> OkHttpUtils
    .get()<span class="hljs-comment">//</span>
    .url(url)<span class="hljs-comment">//</span>
    .tag(<span class="hljs-keyword">this</span>)<span class="hljs-comment">//</span>
    .build()<span class="hljs-comment">//</span>
    .connTimeOut(<span class="hljs-number">20000</span>)
    .readTimeOut(<span class="hljs-number">20000</span>)
    .writeTimeOut(<span class="hljs-number">20000</span>)
    .execute()</code>

调用build()之后,可以随即设置各种timeOut.

(3)取消单个请求

<code class="language-java hljs  has-numbering"> RequestCall call = OkHttpUtils.get().url(url).build();
 call.cancel();</code>

4)根据tag取消请求

目前对于支持的方法都添加了最后一个参数Object tag,取消则通过OkHttpUtils.cancelTag(tag)执行。

例如:在Activity中,当Activity销毁取消请求:

<code class="hljs java has-numbering">OkHttpUtils
    .get()<span class="hljs-comment">//</span>
    .url(url)<span class="hljs-comment">//</span>
    .tag(<span class="hljs-keyword">this</span>)<span class="hljs-comment">//</span>
    .build()<span class="hljs-comment">//</span>

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onDestroy</span>()
{
    <span class="hljs-keyword">super</span>.onDestroy();
    <span class="hljs-comment">//可以取消同一个tag的</span>
    OkHttpUtils.cancelTag(<span class="hljs-keyword">this</span>);<span class="hljs-comment">//取消以Activity.this作为tag的请求</span>
}</code>

比如,当前Activity页面所有的请求以Activity对象作为tag,可以在onDestory里面统一取消。

七、浅谈封装

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

<code class="language-java hljs  has-numbering"><span class="hljs-comment">//创建okHttpClient对象</span>
OkHttpClient mOkHttpClient = <span class="hljs-keyword">new</span> OkHttpClient();
<span class="hljs-comment">//创建一个Request</span>
<span class="hljs-keyword">final</span> Request request = <span class="hljs-keyword">new</span> Request.Builder()
                .url(<span class="hljs-string">"https://github.com/hongyangAndroid"</span>)
                .build();
<span class="hljs-comment">//new call</span>
Call call = mOkHttpClient.newCall(request); 
<span class="hljs-comment">//请求加入调度</span>
call.enqueue(<span class="hljs-keyword">new</span> Callback()
{
    <span class="hljs-annotation">@Override</span>
    <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onFailure</span>(Request request, IOException e)
    {
    }

    <span class="hljs-annotation">@Override</span>
    <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onResponse</span>(<span class="hljs-keyword">final</span> Response response) <span class="hljs-keyword">throws</span> IOException
    {
            <span class="hljs-comment">//String htmlStr =  response.body().string();</span>
    }
});             </code>

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

我对Request抽象了一个类:OkHttpRequest

<code class="language-java hljs  has-numbering"><span class="hljs-keyword">public</span> <span class="hljs-keyword">abstract</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">OkHttpRequest</span>
{</span>
    <span class="hljs-keyword">protected</span> RequestBody requestBody;
    <span class="hljs-keyword">protected</span> Request request;

    <span class="hljs-keyword">protected</span> String url;
    <span class="hljs-keyword">protected</span> String tag;
    <span class="hljs-keyword">protected</span> Map<String, String> params;
    <span class="hljs-keyword">protected</span> Map<String, String> headers;

    <span class="hljs-keyword">protected</span> <span class="hljs-title">OkHttpRequest</span>(String url, String tag,
                            Map<String, String> params, Map<String, String> headers)
    {
        <span class="hljs-keyword">this</span>.url = url;
        <span class="hljs-keyword">this</span>.tag = tag;
        <span class="hljs-keyword">this</span>.params = params;
        <span class="hljs-keyword">this</span>.headers = headers;
    }

    <span class="hljs-keyword">protected</span> <span class="hljs-keyword">abstract</span> Request <span class="hljs-title">buildRequest</span>();
    <span class="hljs-keyword">protected</span> <span class="hljs-keyword">abstract</span> RequestBody <span class="hljs-title">buildRequestBody</span>();

    <span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title">prepareInvoked</span>(ResultCallback callback)
    {
        requestBody = buildRequestBody();
        requestBody = wrapRequestBody(requestBody, callback);
        request = buildRequest();
    }

    <span class="hljs-keyword">protected</span> RequestBody <span class="hljs-title">wrapRequestBody</span>(RequestBody requestBody, <span class="hljs-keyword">final</span> ResultCallback callback)
    {
        <span class="hljs-keyword">return</span> requestBody;
    }


    <span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">invokeAsyn</span>(ResultCallback callback)
    {
        prepareInvoked(callback);
        mOkHttpClientManager.execute(request, callback);
    }


     <span class="hljs-comment">// other common methods</span>
 }   </code>

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

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

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

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

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

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




0
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:217994次
    • 积分:3502
    • 等级:
    • 排名:第10535名
    • 原创:100篇
    • 转载:293篇
    • 译文:0篇
    • 评论:67条
    最新评论