# okhttp-RxHttp **Repository Path**: lc1224/okhttp-RxHttp ## Basic Information - **Project Name**: okhttp-RxHttp - **Description**: 30秒上手，支持协程、RxJava2、RxJava3，史上最优雅的实现文件上传/下载/进度监听、动态/多域名、缓存；支持第三方数据解析工具、自定义请求、自动关闭请求等等 - **Primary Language**: Android - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 6 - **Created**: 2021-11-20 - **Last Updated**: 2021-11-20 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # RxHttp [English](https://github.com/liujingxing/rxhttp/blob/master/README.md) | 中文文档 [![](https://jitpack.io/v/liujingxing/rxhttp.svg)](https://jitpack.io/#liujingxing/rxhttp) [![](https://img.shields.io/badge/change-更新日志-success.svg)](https://github.com/liujingxing/rxhttp/wiki/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97) ![](https://img.shields.io/badge/API-9+-blue.svg) [![](https://img.shields.io/badge/掘金-@不怕天黑-blue.svg)](https://juejin.cn/user/272334612601559/posts) [![](https://img.shields.io/badge/QQ群-378530627-red.svg)](https://jq.qq.com/?_wv=1027&k=E53Hakvv) ***加我微信 ljx-studio 拉你进微信群(注：不要给我发红包，我脸皮薄，不好意思收，你非要给，请直接[Donations](https://github.com/liujingxing/rxhttp/blob/master/README_zh.md#donations)，这里手动狗头)*** # 主要优势 ***1. 30秒即可上手，学习成本极低*** ***2. 史上最优雅的支持 Kotlin 协程*** ***3. 史上最优雅的处理多个BaseUrl及动态BaseUrl*** ***4. 史上最优雅的对错误统一处理，且不打破Lambda表达式*** ***5. 史上最优雅的文件上传/下载/断点下载/进度监听，已适配Android 10*** ***6. 支持Gson、Xml、ProtoBuf、FastJson等第三方数据解析工具*** ***7. 支持Get、Post、Put、Delete等任意请求方式，可自定义请求方式*** ***8. 支持在Activity/Fragment/View/ViewModel/任意类中，自动关闭请求*** ***9. 支持全局加解密、添加公共参数及头部、网络缓存，均支持对某个请求单独设置*** # 请求三部曲 ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/96962077a7874293919bc8379b2d45ac~tplv-k3u1fbpfcp-watermark.image) ***代码表示*** ```kotlin //Kotlin + Await //Kotlin + Flow //Kotlin + RxJava //Java + RxJava RxHttp.get("/server/..") RxHttp.get("/server/..") RxHttp.get("/server/..") RxHttp.get("/server/..") .add("key", "value") .add("key", "value") .add("key", "value") .add("key", "value") .toClass() .toFlow() .asClass() .asClass(User.class) .awaitResult { .catch { .subscribe({ .subscribe(user -> { //成功回调 //异常回调 //成功回调 //成功回调 }.onFailure { }.collect { }, { }, throwable -> { //异常回调 //成功回调 //异常回调 //异常回调 } } }) }); ``` # 上手教程 30秒上手教程：[30秒上手新一代Http请求神器RxHttp](https://juejin.im/post/5cfcbbcbe51d455a694f94df) Flow文档：[RxHttp + Flow 三步搞定任意请求](https://juejin.cn/post/7017604875764629540) Await文档：[RxHttp ，比Retrofit 更优雅的协程体验](https://juejin.im/post/5e77604fe51d4527066eb81a#heading-2) RxJava及核心Api介绍：[RxHttp 让你眼前一亮的Http请求框架](https://juejin.im/post/5ded221a518825125d14a1d4) wiki详细文档：https://github.com/liujingxing/rxhttp/wiki (此文档会持续更新) 自动关闭请求用到的RxLife类，详情请查看[RxLife库](https://github.com/liujingxing/rxlife) [更新日志](https://github.com/liujingxing/rxhttp/wiki/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97)      [遇到问题，点击这里，99%的问题都能自己解决](https://github.com/liujingxing/rxhttp/wiki/FAQ) # 上手准备 ***[Maven依赖点击这里](https://github.com/liujingxing/rxhttp/blob/master/maven_dependency.md)*** ***1、RxHttp目前已适配`OkHttp 3.12.0 - 4.9.1`版本(4.3.0版本除外), 如你想要兼容21以下，请依赖`OkHttp 3.12.x`，该版本最低要求 API 9*** ***2、asXxx方法内部是通过RxJava实现的，而RxHttp 2.2.0版本起，内部已剔除RxJava，如需使用，请自行依赖RxJava并告知RxHttp依赖的Rxjava版本*** ## 必须
1、配置jitpack到项目的build.gradle文件中 ```java allprojects { repositories { maven { url "https://jitpack.io" } } } ```
2、配置ava 8或更高 ```java android { //必须，java 8或更高 compileOptions { sourceCompatibility JavaVersion.VERSION_1_8 targetCompatibility JavaVersion.VERSION_1_8 } } ```
3、添加RxHttp依赖 ```java //使用kapt依赖rxhttp-compiler时必须 apply plugin: 'kotlin-kapt' dependencies { implementation 'com.squareup.okhttp3:okhttp:4.9.1' implementation 'com.github.liujingxing.rxhttp:rxhttp:2.7.3' kapt 'com.github.liujingxing.rxhttp:rxhttp-compiler:2.7.3' //生成RxHttp类，纯Java项目，请使用annotationProcessor代替kapt } ```
`注：如果项目未集成kotlin，请使用annotationProcessor代替kapt，且不需要导入kotlin-kapt插件` ## 可选 ### 1、配置Coverter ```java //非必须，根据自己需求选择 RxHttp默认内置了GsonConverter implementation 'com.github.liujingxing.rxhttp:converter-fastjson:2.7.3' implementation 'com.github.liujingxing.rxhttp:converter-jackson:2.7.3' implementation 'com.github.liujingxing.rxhttp:converter-moshi:2.7.3' implementation 'com.github.liujingxing.rxhttp:converter-protobuf:2.7.3' implementation 'com.github.liujingxing.rxhttp:converter-simplexml:2.7.3' ``` ### 2、配置RxJava
RxHttp + RxJava3 ```java implementation 'io.reactivex.rxjava3:rxjava:3.1.1' implementation 'io.reactivex.rxjava3:rxandroid:3.0.0' implementation 'com.github.liujingxing.rxlife:rxlife-rxjava3:2.2.1' //管理RxJava3生命周期，页面销毁，关闭请求 ```
RxHttp + RxJava2 ```java implementation 'io.reactivex.rxjava2:rxjava:2.2.8' implementation 'io.reactivex.rxjava2:rxandroid:2.1.1' implementation 'com.github.liujingxing.rxlife:rxlife-rxjava2:2.2.1' //管理RxJava2生命周期，页面销毁，关闭请求 ```
通过kapt告知RxHttp你依赖的RxJava版本 ```java android { kapt { arguments { //依赖了RxJava时，rxhttp_rxjava参数为必须，传入RxJava版本号 arg("rxhttp_rxjava", "3.1.1") } } } ```
通过javaCompileOptions告知RxHttp你依赖的RxJava版本 ```java android { defaultConfig { javaCompileOptions { annotationProcessorOptions { arguments = [ //使用asXxx方法时必须，传入你依赖的RxJava版本 rxhttp_rxjava: '3.1.1', ] } } } } ```
`注：kapt/javaCompileOptions二选一，如果集成了kotlin，就使用kapt` ### 3、指定RxHttp相关类包名
通过kapt指定RxHttp相关类包名 ```java android { kapt { arguments { arg("rxhttp_package", "rxhttp") //指定RxHttp类包名，可随意指定 } } } ```
通过javaCompileOptions指定RxHttp相关类包名 ```java android { defaultConfig { javaCompileOptions { annotationProcessorOptions { arguments = [ rxhttp_package: 'rxhttp', //指定RxHttp类包名，可随意指定 ] } } } } ```
`注：kapt/javaCompileOptions二选一，如果集成了kotlin，就使用kapt` 最后，***rebuild一下(此步骤是必须的)*** ，就会自动生成RxHttp类 # 混淆 `RxHttp v2.2.8`版本起，无需添加任何混淆规则(内部自带混淆规则)，v2.2.8以下版本，请[查看混淆规则](https://github.com/liujingxing/rxhttp/wiki/关于混淆),并添加到自己项目中 # Demo演示 > 更多功能，请[下载apk](https://github.com/liujingxing/rxhttp/blob/master/screen/app-debug.apk)体验 ## Donations 如果它对你帮助很大，并且你很想支持库的后续开发和维护，那么你可以扫下方二维码随意打赏我，就当是请我喝杯咖啡或是啤酒，开源不易，感激不尽 ![rxhttp_donate.png](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/aafa7d05cfda4b2ea2a092bba8ebc1a0~tplv-k3u1fbpfcp-watermark.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. ```