Android 开发 - 基于okhttp框架封装的开发框架oknet

概述

在android开发中经常要访问网络,目前最流行的网络访问框架就是Okhttp了,然而我们在具体使用时,往往仍然需要二次封装。我使用Builder设计模式进行了封装形成oknet开源库。

介绍

oknet是一套基于okhttp的android网络http框架,封装了请求参数处理,日志打印。

名称:oknet
github地址:https://github.com/vir56k/oknet
作者: zhangyunfeiVir

特性

1.简洁的语法
2.支持自定义处理 message code 不等于0 的情形
3.支持文件上传
4.完整清晰的log日志输出
5.支持 公共参数 的配置
6.支持每个http请求的 日志 记录
7.支持 默认异常 的处理
8.支持 移除文件下载(通过FileDownloader)

适用场景

和服务端产生约定消息结构:

返回的响应的json格式一定为:

{code:0,   msg:"", body:""}
参数说明:
1.服务端 响应成功 则返回对应的json
2.code=0表示成功,body里如正确响应json.
3.code非零表示失败,msg表示失败的文本。
4.body 节点里放置你的自定义json数据

引用

在你的项目的根目录下的 build.gradle 文件中添加引用

compile 'zhangyf.vir56k:oknet:0.0.1'

示例:

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'zhangyf.vir56k:oknet:0.0.1'
}

在系统启动时进行一些配置

比如在你的继承自Application的子类中,或者主Activity启动时配置。

    //配置okhttp 缓存位置
    OknetConfig.setExternalCacheDir(getExternalCacheDir());
    //OknetConfig.setRequestParaInterceptor(new CustomRequestParaInterceptor1());
    OknetConfig.setRequestParaInterceptor(new CustomRequestParaInterceptor_jlb_app());
    OknetConfig.setDefaultExceptionHandler(new CustomDefalutExceptionHandler());
    OknetConfig.setLogInterceptor(new LogInterceptor() {
        @Override
        public void onLog(String tag, String msg) {
        //Log.i("日志拦截器拦截到 tag =" + tag, " msg = " + msg);
        }
    });

post简单请求,和String类型的响应

RequestBuilder.with(getActivity()).URL(Apis.GAEA_URLS.CAB_ADVERT_LIST).
            onSuccess(new CommonCallback<String>(String.class) {
                @Override
                public void onSuccess(String result, CommonMessage responseMessage, String responseString) {
                    Log.i(TAG, "==成功:" + result);
                    alert("==成功");
                }
            }).excute();

带参数的请求,和 Json序列化的回调

Type t = new TypeToken<List<Demo2Cell>>() {
}.getType();
RequestBuilder.with(getActivity())
        .URL(Apis.Cab_Urls.GET_BOX_FREE_NEWS)
        .para("cabinet_code", "1412345678")
        .onSuccess(new CommonCallback<List<Demo2Cell>>(t) {
            @Override
            public void onSuccess(List<Demo2Cell> result, CommonMessage responseMessage, String responseString) {
                Log.i(TAG, "!!! 成功:" + result.get(0));
                alert("!!成功" + result.get(0));
            }
        })
        .excute();

自定义处理异常代码(服务返回的消息里的 message code 不等于0) 的情形

   RequestBuilder.with(getActivity())
            .URL(Apis.GAEA_URLS.CAB_ADVERT_LIST)
            .onSuccess(new CommonCallback<String>(String.class) {
                @Override
                public void onSuccess(String result, CommonMessage responseMessage, String responseString) {
                    Log.i(TAG, "==成功:" + result);
                    alert("==成功");
                }
                @Override
                public boolean onFailure(int httpCode, Exception ex, CommonMessage responseMessage, String responseString) {
                    if (ex instanceof NoZeroException) {
                        NoZeroException noZeroException = (NoZeroException) ex;
                        int code = noZeroException.getCode();
                        Log.i(TAG, "!!!!!!!!失败:" + noZeroException);
                        alert("!!!!!!!!!!!!!!!!失败," + noZeroException);
                        //return false;//如果不需要 默认异常处理器再次处理,这里可以返回true
                    }
                    return super.onFailure(httpCode, ex, responseMessage, responseString);
                }
            })
            .excute();

上传文件

File f = new File(Environment.getExternalStorageDirectory().getPath(), "ImageCache/CloseIcon.png");
    if (!f.exists())
        throw new RuntimeException("not found ImageCache/CloseIcon.png");
    RequestBuilder.with(getActivity())
            .URL("http://10.0.1.232:8888/uc/suser/upload_avatar")
            .para("uid", "100202")
            .para("sid", "50e2904ca493d5d25475e4e080858925")
                    /************************ 威力仅仅在这一行,其他都一样 ***************************/
            .file("file", f)
                    /************************ 威力仅仅在这一行,其他都一样 ***************************/
            .onSuccess(new CommonCallback<Demo3Bean>(Demo3Bean.class) {
                @Override
                public void onSuccess(Demo3Bean result, CommonMessage responseMessage, String responseString) {
                    Log.i(TAG, "!!! 成功:" + result.count);
                    alert("!!成功" + result.count);
                }
            })
            .excute();

处理需要显示进度条的情形

RequestBuilder.with(getActivity())
            .URL(Apis.GAEA_URLS.CAB_NOTICE_LIST)
            .para("cabinet_code", "1412345678")
                    /******** 没错,你没有看错,仅仅 下面 一行,进度条就闪亮登场 ************/
            .progress(new DialogProgressIndicator(getActivity()))
                    /******** 没错,你没有看错,仅仅 上面 一行,进度条就闪亮登场 ************/
            .onSuccess(new CommonCallback<Demo3Bean>(Demo3Bean.class) {
                @Override
                public void onSuccess(Demo3Bean result, CommonMessage responseMessage, String responseString) {
                    Log.i(TAG, "!!! 成功:" + result.count);
                    alert("!!成功" + result.count);
                }
            })
            .excute();

这里的 DialogProgressIndicator类 是一个“进度条指示器”对象。

同步的方式发送http请求

private void demo_syncExcuete() {

    new AsyncTask<Void, Void, Void>() {
        boolean isok;
        String mResult1;

        @Override
        protected Void doInBackground(Void... params) {
            RequestBuilder.with(getActivity())
                    .URL(Apis.GAEA_URLS.CAB_ADVERT_LIST)
                    .para("cabinet_code", "1412345678")
                    .onSuccess(new CommonCallback<String>(String.class) {
                        @Override
                        public void onSuccess(String result, CommonMessage responseMessage, String responseString) {
                            isok = true;
                            mResult1 = result;
                        }

                        @Override
                        public boolean onFailure(int httpCode, Exception exception, CommonMessage responseMessage, String allResponseString) {
                            isok = false;
                            return super.onFailure(httpCode, exception, responseMessage, allResponseString);
                        }
                    })
                    .syncExcute();

            return null;
        }

        @Override
        protected void onPostExecute(Void aVoid) {
            if (isok) {
                Log.i(TAG, "==成功:" + mResult1);
                alert("==成功");
            }
        }
    }.execute();

}

下载文件

public static void downloadFileDemo() {
    String url = "http://d.hiphotos.baidu.com/zhidao/pic/item/08f790529822720e67a9065978cb0a46f21fab2a.jpg";
    File dest = new File(Environment.getExternalStorageDirectory(), "6f21fab2a.jpg");
    FileDownloader.downloadFile(url, dest, new FileDownloader.DownloadFileProgressListener2() {
        @Override
        public void onFailure(Call call, IOException e) {
            System.out.println("Err: " + e.getMessage());
        }

        @Override
        public void onProgress(long bytesRead, long contentLength, boolean done) {
            System.out.println(String.format("文件下载进度, read %s/%s", bytesRead, contentLength));
        }

        @Override
        protected void onSuccess(Call call, File file) {
            System.out.println("文件下载成功吗 =" + file.exists());

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,065评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 已经立秋多日,仍是高温的天气,秋天毕竟一步步向我们走来。秋天来了,瓜果会成熟,树叶会枯落,一些账目是要算一算的。 ...
    xhy0606阅读 559评论 2 5
  • 今日看了文友小美写的《最好的风水,在你嘴上》让我获益匪浅。她分别用了三个小标题: (1)你嘴上所说的人生,...
    漫苏阅读 1,113评论 1 6
  • Spring Boot官方推荐的数据库连接池是HikariCP,从一些第三方的评测结果看,HikariCP的性能比...
    蓝色的咖啡阅读 11,240评论 5 5