转发出处: 
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的用户,能够采用丰硕:

    compile project(':okhttputils')
    

     

  • 或者

    compile 'com.zhy:okhttputils:2.0.0'
    

     

二 、基本用法

现阶段着力的用法格式为:

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中,通过:

OkHttpClient client = 
OkHttpUtils.getInstance().getOkHttpClient();

 

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

例如:

client.setConnectTimeout(100000, TimeUnit.MILLISECONDS);

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

例如涉及到文件的要求安装读写等待时间多一些。

 OkHttpUtils
    .get()//
    .url(url)//
    .tag(this)//
    .build()//
    .connTimeOut(20000)
    .readTimeOut(20000)
    .writeTimeOut(20000)
    .execute()

调用build()之后,能够跟着设置各个timeOut.

(3)撤除单个请求

 RequestCall call = OkHttpUtils.get().url(url).build();
 call.cancel()

 

(4)遵照tag打消请求

近来对此支撑的法子都添加了最后贰个参数Object tag,撤废则通过OkHttpUtils.cancelTag(tag)执行。

譬如:在Activity中,当Activity销毁撤除请求:

OkHttpUtils
    .get()//
    .url(url)//
    .tag(this)//
    .build()//

@Override
protected void onDestroy()
{
    super.onDestroy();
    //可以取消同一个tag的
    OkHttpUtils.cancelTag(this);//取消以Activity.this作为tag的请求
}

譬如说,当前Activity页面全体的请求以Activity对象作为tag,能够在onDestory里面统一裁撤。

七 、浅谈封装

实在任何封装的进程相比简单,那里大致描述下,对于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为架空的法门,也等于例外的请求类,比如OkHttpGetRequestOkHttpPostRequest等急需团结去营造友好的request。

对于wrapRequestBody格局吗,能够见见它暗中同意基本属于空完毕,首尽管因为不用全体的呼吁类都要求复写它,唯有上传的时候呢,必要回调进程,需求对requestBody进行李包裹装,所以这几个艺术类似于3个钩子。

实在那几个历程有点类似模板方法方式,有趣味可以看看3个短篇介绍设计形式模版方法模式展现程序员的一天 .

对此越来越详实的用法,能够查阅github下边包车型大巴readme,以及demo,近年来demo蕴含:

图片 1

对此上传文件的多个按钮,必要自个儿搭建服务器,其余的按钮能够一直测试

最后,由于自家水平有限,以及时光相比较匆忙~~发现标题,欢迎提issue,笔者会抽时间消除。
have a nice day ~

相关文章

网站地图xml地图