/okhttp-RxHttp

🔥🔥🔥30秒上手,比Retrofit更好用的协程、RxJava2、RxJava3,史上最优雅的实现文件上传/下载/进度监听、动态/多域名、缓存;支持第三方数据解析工具、自定义请求、自动关闭请求等等

Primary LanguageJavaApache License 2.0Apache-2.0

Download

RxHttp主要优势

1. 30秒即可上手,学习成本极低

2. 史上最优雅的支持 Kotlin 协程

3. 史上最优雅的处理多个BaseUrl及动态BaseUrl

4. 史上最优雅的对错误统一处理,且不打破Lambda表达式

5. 史上最优雅的实现文件上传/下载及进度的监听,且支持断点下载

6. 支持Gson、Xml、ProtoBuf、FastJson等第三方数据解析工具

7. 支持Get、Post、Put、Delete等任意请求方式,可自定义请求方式

8. 支持在Activity/Fragment/View/ViewModel/任意类中,自动关闭请求

9. 支持全局加解密、添加公共参数及头部、网络缓存,均支持对某个请求单独设置

Gradle依赖

//以下三个为必须,其它均为非必须
implementation 'com.ljx.rxhttp:rxhttp:2.2.3'
implementation 'com.squareup.okhttp3:okhttp:4.6.0'  //rxhttp v2.2.2版本起,需要手动依赖okhttp
annotationProcessor 'com.ljx.rxhttp:rxhttp-compiler:2.2.3' //生成RxHttp类,kotlin用户,请使用kapt替代annotationProcessor

implementation 'com.ljx.rxlife:rxlife-coroutine:2.0.0'  //管理协程生命周期,页面销毁,关闭请求
implementation 'com.ljx.rxlife2:rxlife-rxjava:2.0.0'    //管理RxJava2生命周期,页面销毁,关闭请求
implementation 'com.ljx.rxlife3:rxlife-rxjava:3.0.0'    //管理RxJava3生命周期,页面销毁,关闭请求

//Converter 根据自己需求选择 RxHttp默认内置了GsonConverter
implementation 'com.ljx.rxhttp:converter-jackson:2.2.3'
implementation 'com.ljx.rxhttp:converter-fastjson:2.2.3'
implementation 'com.ljx.rxhttp:converter-protobuf:2.2.3'
implementation 'com.ljx.rxhttp:converter-simplexml:2.2.3'

遇到问题,点击这里,99%的问题都能自己解决

RxHttp&RxLife 交流群:378530627

准备工作

1、RxHttp 要求项目使用Java 8 或更高版本,请在 app 的 build.gradle 添加以下代码

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}

2、RxHttp 2.2.0版本起,内部不在依赖RxJava相关库,采用外挂的方法替代,如你需要结合RxJava发送请求,请单独配置,如下:

defaultConfig {
    javaCompileOptions {
        annotationProcessorOptions {
            //手动告知RxHttp要使用的RxJava版本,才会生成asXxx方法
            arguments = [rxhttp_rxjava: 'rxjava3']  //可传入rxjava2、rxjava3
        }
    }
}
//并自行依赖RxJava相关库,RxJava2/Rxjava3二选一,如下:
dependencies {
   //rxjava2
   implementation 'io.reactivex.rxjava2:rxjava:2.2.8'
   implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
   implementation 'com.ljx.rxlife2:rxlife-rxjava:2.0.0'    //管理RxJava2生命周期,页面销毁,关闭请求

   //rxjava3
   implementation 'io.reactivex.rxjava3:rxjava:3.0.2'
   implementation 'io.reactivex.rxjava3:rxandroid:3.0.0'
   implementation 'com.ljx.rxlife3:rxlife-rxjava:3.0.0'    //管理RxJava3生命周期,页面销毁,关闭请求
}

最后,rebuild一下(此步骤是必须的) ,就会自动生成RxHttp类,到这,准备工作完毕。

API兼容

RxHttp最低要求为API 15,但是由于OkHttp 3.14.x以上版本, 最低要求为API 21, 如果你想要兼容到API 15,请依赖OkHttp 3.12.x 版本,并告知rxhttp你依赖的okhttp版本,如下:

defaultConfig {
    javaCompileOptions {
        annotationProcessorOptions {
            //如你依赖的okhttp并非最新版本,都需要告知RxHttp你依赖的okhttp版本
            arguments = [rxhttp_okhttp: '3.12.6']  //可传入3.12.0至4.6.0任一版本(4.3.0除外)
        }
    }
}
dependencies {
   implementation 'com.squareup.okhttp3:okhttp:3.12.6' //此版本最低要求 API 9
}

注:RxHttp目前对OkHttp 的 v3.12.0 - v4.6.0均已完成适配工作(v4.3.0除外,该版本有一bug,暂时无法适配)

上手教程

30秒上手教程:https://juejin.im/post/5cfcbbcbe51d455a694f94df

掘金详细文档:https://juejin.im/post/5ded221a518825125d14a1d4

wiki详细文档:https://github.com/liujingxing/okhttp-RxHttp/wiki (此文档会持续更新)

协程文档:RxHttp ,比Retrofit 更优雅的协程体验

自动关闭请求用到的RxLife类,详情请查看RxLife库

更新日志      已知问题      Java工程依赖注意事项

混淆

RxHttp作为开源库,可混淆,也可不混淆,如果不希望被混淆,请在proguard-rules.pro文件添加以下代码

-keep class rxhttp.**{*;}

小技巧

在这教大家一个小技巧,由于使用RxHttp发送请求都遵循请求三部曲,故我们可以在android studio 设置代码模版,如下

image

如图设置好后,写代码时,输入rp,就会自动生成模版,如下:

image

Demo演示

更多功能,请下载Demo体验

Donations

如果它对你帮助很大,并且你很想支持库的后续开发和维护,那么你可以扫下方二维码随意打赏我,就当是请我喝杯咖啡或是啤酒,开源不易,感激不尽

image

Licenses

Copyright 2019 liujingxing

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.