2018-03-29

okHttpUtils(hongyang)的配置及使用(网络框架)

okHttpUtils很方便,可以直接更新UI

对okhttp的封装类,okhttp见:https://github.com/square/okhttp.

目前对应okhttp版本3.3.1.

用法

Android Studio

compile 'com.zhy:okhttputils:2.6.2'

Eclipse

下载最新jar:okhttputils-2_6_2.jar

注:需要同时导入okhttp和okio的jar,下载见:https://github.com/square/okhttp.

目前对以下需求进行了封装

一般的get请求

一般的post请求

基于Http Post的文件上传(类似表单)

文件下载/加载图片

上传下载的进度回调

支持取消某个请求

支持自定义Callback

支持HEAD、DELETE、PATCH、PUT

支持session的保持

支持自签名网站https的访问,提供方法设置下证书就行

配置OkhttpClient

默认情况下,将直接使用okhttp默认的配置生成OkhttpClient,如果你有任何配置,记得在Application中调用initClient方法进行设置。

publicclassMyApplicationextendsApplication{@OverridepublicvoidonCreate()    {super.onCreate();OkHttpClientokHttpClient=newOkHttpClient.Builder()//.addInterceptor(new LoggerInterceptor("TAG")).connectTimeout(10000L,TimeUnit.MILLISECONDS)                  .readTimeout(10000L,TimeUnit.MILLISECONDS)//其他配置.build();OkHttpUtils.initClient(okHttpClient);    }}

别忘了在AndroidManifest中设置。

对于Cookie(包含Session)

对于cookie一样,直接通过cookiejar方法配置,参考上面的配置过程。

CookieJarImpl cookieJar = new CookieJarImpl(new PersistentCookieStore(getApplicationContext()));

OkHttpClient okHttpClient = new OkHttpClient.Builder()

          .cookieJar(cookieJar)

          //其他配置

        .build();


OkHttpUtils.initClient(okHttpClient);

目前项目中包含:

PersistentCookieStore //持久化cookie

SerializableHttpCookie //持久化cookie

MemoryCookieStore //cookie信息存在内存中

如果遇到问题,欢迎反馈,当然也可以自己实现CookieJar接口,编写cookie管理相关代码。

此外,对于持久化cookie还可以使用https://github.com/franmontiel/PersistentCookieJar.

相当于框架中只是提供了几个实现类,你可以自行定制或者选择使用。

对于Log

初始化OkhttpClient时,通过设置拦截器实现,框架中提供了一个LoggerInterceptor,当然你可以自行实现一个Interceptor 。

OkHttpClient okHttpClient = new OkHttpClient.Builder()

      .addInterceptor(new LoggerInterceptor("TAG"))

        //其他配置

        .build();

OkHttpUtils.initClient(okHttpClient);

对于Https

依然是通过配置即可,框架中提供了一个类HttpsUtils

设置可访问所有的https网站

HttpsUtils.SSLParams sslParams = HttpsUtils.getSslSocketFactory(null, null, null);

OkHttpClient okHttpClient = new OkHttpClient.Builder()

        .sslSocketFactory(sslParams.sSLSocketFactory, sslParams.trustManager)

        //其他配置

        .build();

OkHttpUtils.initClient(okHttpClient);

设置具体的证书

HttpsUtils.SSLParams sslParams = HttpsUtils.getSslSocketFactory(证书的inputstream, null, null);

OkHttpClient okHttpClient = new OkHttpClient.Builder()

        .sslSocketFactory(sslParams.sSLSocketFactory, sslParams.trustManager))

        //其他配置

        .build();

OkHttpUtils.initClient(okHttpClient);

双向认证

HttpsUtils.getSslSocketFactory(

证书的inputstream,

本地证书的inputstream,

本地证书的密码)

同样的,框架中只是提供了几个实现类,你可以自行实现SSLSocketFactory,传入sslSocketFactory即可。

##其他用法示例

GET请求

Stringurl="http://www.csdn.net/";OkHttpUtils.get()    .url(url)    .addParams("username","hyman")    .addParams("password","123")    .build()    .execute(newStringCallback()        {@OverridepublicvoidonError(Requestrequest,Exceptione)            {                            }@OverridepublicvoidonResponse(Stringresponse)            {            }        });

POST请求

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

Post JSON

OkHttpUtils.postString()    .url(url)    .content(newGson().toJson(newUser("zhy","123")))    .mediaType(MediaType.parse("application/json; charset=utf-8"))    .build()    .execute(newMyStringCallback());

提交一个Gson字符串到服务器端,注意:传递JSON的时候,不要通过addHeader去设置contentType,而使用.mediaType(MediaType.parse("application/json; charset=utf-8")).。

Post File

OkHttpUtils.postFile().url(url).file(file).build().execute(newMyStringCallback());

将文件作为请求体,发送到服务器。

Post表单形式上传文件

OkHttpUtils.post()//.addFile("mFile","messenger_01.png", file)//.addFile("mFile","test1.txt", file2)//.url(url)    .params(params)//.headers(headers)//.build()//.execute(newMyStringCallback());

支持单个多个文件,addFile的第一个参数为文件的key,即类别表单中的name属性。

自定义CallBack

目前内部包含StringCallBack,FileCallBack,BitmapCallback,可以根据自己的需求去自定义Callback,例如希望回调User对象:

publicabstractclassUserCallbackextendsCallback{@OverridepublicUserparseNetworkResponse(Responseresponse)throwsIOException{Stringstring=response.body().string();Useruser=newGson().fromJson(string,User.class);returnuser;    }}OkHttpUtils.get()//.url(url)//.addParams("username","hyman")//.addParams("password","123")//.build()//.execute(newUserCallback()    {@OverridepublicvoidonError(Requestrequest,Exceptione)        {            mTv.setText("onError:"+e.getMessage());        }@OverridepublicvoidonResponse(Userresponse)        {            mTv.setText("onResponse:"+response.username);        }    });

通过parseNetworkResponse回调的response进行解析,该方法运行在子线程,所以可以进行任何耗时操作,详细参见sample。

下载文件

OkHttpUtils//.get()//.url(url)//.build()//.execute(newFileCallBack(Environment.getExternalStorageDirectory().getAbsolutePath(),"gson-2.2.1.jar")//{@OverridepublicvoidinProgress(floatprogress)    {        mProgressBar.setProgress((int) (100*progress));    }@OverridepublicvoidonError(Requestrequest,Exceptione)    {Log.e(TAG,"onError :"+e.getMessage());    }@OverridepublicvoidonResponse(Filefile)    {Log.e(TAG,"onResponse :"+file.getAbsolutePath());    }});

注意下载文件可以使用FileCallback,需要传入文件需要保存的文件夹以及文件名。

显示图片

OkHttpUtils.get()//.url(url)//.build()//.execute(newBitmapCallback()    {@OverridepublicvoidonError(Requestrequest,Exceptione)        {            mTv.setText("onError:"+e.getMessage());        }@OverridepublicvoidonResponse(Bitmapbitmap)        {            mImageView.setImageBitmap(bitmap);        }    });

显示图片,回调传入BitmapCallback即可。

上传下载的进度显示

newCallback(){//...@OverridepublicvoidinProgress(floatprogress)    {//use progress: 0 ~ 1}}

callback回调中有inProgress方法,直接复写即可。

HEAD、DELETE、PUT、PATCH

OkHttpUtils.put()//also can use delete() ,head() , patch().requestBody(RequestBody.create(null,"may be something"))//.build()//.execute(newMyStringCallback());

如果需要requestBody,例如:PUT、PATCH,自行构造进行传入。

同步的请求

Response response = OkHttpUtils

    .get()//

    .url(url)//

    .tag(this)//

    .build()//

    .execute();

execute方法不传入callback即为同步的请求,返回Response。

取消单个请求

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

根据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里面统一取消。

混淆

#okhttputils

-dontwarn com.zhy.http.**

-keep class com.zhy.http.**{*;}

#okhttp

-dontwarn okhttp3.**

-keep class okhttp3.**{*;}

#okio

-dontwarn okio.**

-keep class okio.**{*;}

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,928评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,192评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,468评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,186评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,295评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,374评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,403评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,186评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,610评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,906评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,075评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,755评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,393评论 3 320
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,079评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,313评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,934评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,963评论 2 351

推荐阅读更多精彩内容