okhttp-OkGo README

The project's README from github.com/jeasonlzy/okhttp-OkGo. As one markdown file: README.md.

OkGo - 3.0 震撼来袭, 一个基于okhttp的标准RESTful风格的网络框架

工程结构全新优化
支持RxJava
支持RxJava2
支持自定义缓存策略
支持下载管理
支持上传管理

该库部分思想借鉴了以下项目：

在此特别感谢上述作者，喜欢原作的可以去使用原项目。同时欢迎大家下载体验本项目，如果使用过程中遇到什么问题，欢迎反馈。

友情链接

本项目中使用的图片选择是我的另一个开源项目

完全仿微信的图片选择库，自带矩形图片裁剪和圆形图片裁剪功能，有需要的可以去下载使用。
附上地址：https://github.com/jeasonlzy/ImagePicker

本项目中的九宫格控件也是我的开源项目

类似QQ空间，微信朋友圈，微博主页等，展示图片的九宫格控件，自动根据图片的数量确定图片大小和控件大小，使用Adapter模式设置图片，对外提供接口回调，使用接口加载图片，支持任意的图片加载框架如：Glide、ImageLoader、xUtils3、Picasso 等，支持点击图片全屏预览大图。
附上地址：https://github.com/jeasonlzy/NineGridView

联系方式

演示

imageimageimageimageimageimage

未来版本

[v3.1.x]版本

[v3.2.x]版本

其他功能暂时还没想出来，大家有想法的可以积极加群讨论，或者直接在issue里面提出你的想法，我会第一时间回复。

使用

Codacy Badge

Android Studio用户

一般来说，只需要添加第一个okgo的核心包即可，其余的三个库根据自己的需要选择添加！！！

//必须使用
compile 'com.lzy.net:okgo:3.0.4'

//以下三个选择添加，okrx和okrx2不能同时使用
compile 'com.lzy.net:okrx:1.0.2'
compile 'com.lzy.net:okrx2:2.0.2'  
compile 'com.lzy.net:okserver:2.0.5'

Eclipse的用户(赶紧换AS吧)，可以选择添加本项目根目录中 /jar 目录下的jar包:

一般来说，至少需要okhttp、okio、okgo三个jar包，其余的三个扩展jar包根据自己的需要选择添加！！！

必须使用

okhttp-3.8.1.jar
okio-1.13.0.jar
okgo-3.0.4.jar

以下三个选择添加，okrx和okrx2不能同时使用

okrx-1.0.2.jar
okrx2-2.0.2.jar
okserver-2.0.5.jar

文档

该项目的文档全部以Wiki的形式展示，wiki文档永远与最新版本的库保持同步，如果你发现文档的说明与你的写法不一样，那么请升级到最新版本，重要的事情说三遍

如果你实在不愿意升级到3.x版本，这里有2.x版本的文档，点击查看，注意：老版本库的问题将不在维护，所有bug会在最新版本修复，所以建议跟随最新版本的库。

如果遇到使用问题，解决办法如下：

  1. 看上述文档中是否有相关描述
  2. 看别人提的issues是否有你的问题，这里面有很多人的提问，点击这里看别人的提问。
  3. 如果你感觉是bug，或者有疑问，也欢迎在issues里面提问，我每天都会认真解答，点击这里提问。
  4. 还有疑问，加入联系方式中的QQ群，大家一起讨论。

如果你不想编译项目，提供了apk供直接运行，方便查看效果，点击图标下载：

本项目Demo使用的是我自己的服务器，有时候可能不稳定，网速比较慢时请耐心等待，尴尬呀。。

如果你想查看历史版本信息，请点击图标：

如果你使用遇到了问题，首先请看控制台log，如果log无法看出问题，无法确定是该库的bug还是服务端的问题，建议抓包查看网络数据，详细的抓包方法猛戳这里

如果你觉得好，对你有过帮助，请给我一点打赏鼓励吧，一分也是爱呀！

混淆

okgo, okrx, okrx2, okserver 所有代码均可以混淆,但是由于底层使用的是 okhttp,它不能混淆,所以只需要添加以下混淆代码就可以了

#okhttp
-dontwarn okhttp3.**
-keep class okhttp3.**{*;}

#okio
-dontwarn okio.**
-keep class okio.**{*;}

当然如果你确实不需要混淆okgo的代码,可以继续添加以下代码

#okgo
-dontwarn com.lzy.okgo.**
-keep class com.lzy.okgo.**{*;}

#okrx
-dontwarn com.lzy.okrx.**
-keep class com.lzy.okrx.**{*;}

#okrx2
-dontwarn com.lzy.okrx2.**
-keep class com.lzy.okrx2.**{*;}

#okserver
-dontwarn com.lzy.okserver.**
-keep class com.lzy.okserver.**{*;}

Licenses

 Copyright 2016 jeasonlzy(廖子尧)

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

okhttp-OkGo (jeasonlzy/okhttp-OkGo)

Searching Database…

10.5K ·GitHub
Okhttp-OkGo
这是干什么的?OkGo 是一个免费开源的 Android 网络请求框架。它基于 OkHttp 构建,把 HTTP 请求封装成一套标准的 RESTful 风格 API,是一个添加到你的应用里使用的 Java 库。
为什么不直接用 OkHttp,要选它?它补上了原生 OkHttp 留给你自己处理的部分:自定义缓存策略、断点下载管理、上传管理,还提供可选的 RxJava 和 RxJava2 支持——全部采用 RESTful 的请求风格。
怎么把它加到我的 Android 项目里?用 Android Studio 的话,把 okgo 核心包作为 Gradle 依赖添加即可——通常只加这一个就够了,因为另外三个库都是可选的。用 Eclipse 的用户可以直接把 /jar 目录下的 jar 包复制进去。
它到底依赖哪些 jar?两个 RxJava 版本能一起用吗?你需要 okhttp-3.8.1、okio-1.13.0 和 okgo-3.0.4。可选的扩展包:okrx(RxJava 1)和 okrx2(RxJava 2)——这两个不能同时使用,只能二选一——另外还有用于下载和上传管理的 okserver。
打包正式版时 ProGuard 有什么坑?okgo、okrx、okrx2 和 okserver 的代码都可以混淆,但底层的 okhttp 库不行——你必须按建议添加 keep 规则,保证 okhttp 不被混淆。
文档和我代码里的写法对不上,是怎么回事?文档放在项目的 Wiki 里,始终与最新发布版本保持一致。如果示例和你的代码不一样,请升级到最新版本——旧的 2.x 分支已经不再维护了。
接进我的应用之前,能先试试效果吗?可以,项目提供了现成的 demo APK,可以直接下载体验。不过要有耐心:demo 连接的是作者的个人服务器,可能比较慢,也不太稳定。
之后的版本有什么计划?v3.1.x 计划支持动态 URL 路径替换(paramsPath、paramsQuery、params)、请求优先级和自定义线程池。v3.2.x 计划推出 OkAnno,一种类似 Retrofit 但更简单的注解式请求方式。
What are similar projects?MVPArms, RxPermissions, Android-Universal-Image-Loader, EventBus, flexbox-layout, uCrop, MaterialDrawer, SlidingMenu
Which topics is it in?rxjava, restful, download-manager, http-client, android-library, mobile-development, http, rest-api, developers, java, mobile, networking
Creator
jeasonlzy
Size
82.9 MB
Stars
10.5K
Updated
CommitAug 11Releasev3.0.4Jul 17
Age
10y
Commits · 90 Days