3 Star 34 Fork 5

327744707 / okhttp-RxHttp

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

RxHttp

English | 中文文档

(RxHttp 3.0 更新指南,升级必看)

加我微信 ljx-studio 拉你进微信群(备注RxHttp)

1、主要优势

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. 支持全局加解密、添加公共参数及头部、网络缓存,均支持对某个请求单独设置

2、请求三部曲

代码表示, toObservableXxx、toAwaitXxx、toFlowXxx方法介绍点这里

Await Flow RxJava
(Kotlin)
RxJava
(Java)
//同步式写法
val user = RxHttp.get("/server/..")
    .add("key", "value")
    .toAwait<User>()
    .await() //tryAwait return User?

//回调式写法
RxHttp.get("/server/..")
    .add("key", "value")
    .toAwait<User>()  
    .awaitResult { 
        //成功回调   
    }.onFailure {  
        //异常回调  
    } 
RxHttp.get("/server/..")
    .add("key", "value")
    .toFlow<User>()  
    .catch { 
        //异常回调   
    }.collect {  
        //成功回调  
    }           
RxHttp.get("/server/..")
    .add("key", "value")
    .toObservable<User>()  
    .subscribe({ 
        //成功回调   
    }, {  
        //异常回调  
    })           
RxHttp.get("/server/..")
    .add("key", "value")
    .toObservable(User.class)  
    .subscribe(user - > { 
        //成功回调   
    }, throwable -> {  
        //异常回调  
    })           

RxHttp与Retrofit对比

功能说明 RxHttp Retrofit
版本 v3.2.5 v2.9.0
状态 维护中 维护中
标准RESTful风格
学习成本
扩展性
源码大小 73k 75k
jar包大小 210k 123k
RxJava RxJava ❌
RxJava2✅
RxJava3✅
RxJava ✅
RxJava2✅
RxJava3✅
Kotlin协程
Flow流
Converter Gson✅
Jackson✅
fastJson✅
Moshi✅
Protobuf✅
simplexml✅
kotlinx.serialization✅
自定义✅
Gson✅
Jackson✅
fastJson✅
Moshi✅
Protobuf✅
simplexml✅
kotlinx.serialization✅
自定义✅
关闭请求 手动✅
自动✅
批量✅
手动✅
自动✅
批量✅
文件上传/下载/进度监听 ❌需再次封装
Android 10分区存储 ❌需再次封装
公共参数 ❌需再次封装
多域名/动态域名 ✅好用 ✅一般
日志打印
Json数据格式化输出 ❌需再次封装
业务code统一判断 ❌需再次封装
请求缓存 ❌需再次封装
全局加解密 ❌需再次封装
部分字段解密 ❌需再次封装

说明

也许你有会有疑问,RxHttp源码大小仅比retrofit大6k的情况下,jar包大小为何会大一倍多?功能太多导致的代码臃肿?并不是,而是由kotlin导致的,在RxHttp内部,为了支持Await/Flow,运用了大量的kotlin内联方法及扩展方法,这些方法在编译为字节码后,都会相对较大,其中AwaitTransform.ktCallFactoryToAwait.ktCallFactoryToFlow.kt这3个kotlin文件,编译字节码后,就接近70k

3、相关文档

30秒上手教程:30秒上手新一代Http请求神器RxHttp

Flow文档:RxHttp + Flow 三步搞定任意请求

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

RxJava及核心Api介绍:RxHttp 让你眼前一亮的Http请求框架

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

(RxHttp 3.0 更新指南,升级必看)

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

4、上手准备

1、RxHttp依赖有3种方式,选择其中一种就好, ksp、kapt、annotationProcessor 如何选择点击这里

2、asXxx方法内部通过RxJava实现,如需使用,需额外依赖RxJava并告知RxHttp你依赖的Rxjava版本

3、RxHttp已适配OkHttp 3.12.0 - v4.12.0版本(4.3.0除外), 如需兼容21以下,请依赖OkHttp 3.12.x,该版本最低要求 API 9

4、Maven依赖点击这里

4.1、必须

annotationProcessor依赖
//1、项目的build.gradle文件
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}
//2、java 8或更高
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}
//3、添加依赖
dependencies {
    def rxhttp_version = '3.2.5'
    implementation 'com.squareup.okhttp3:okhttp:4.12.0'  
    implementation "com.github.liujingxing.rxhttp:rxhttp:$rxhttp_version"
    annotationProcessor "com.github.liujingxing.rxhttp:rxhttp-compiler:$rxhttp_version"
}
kapt依赖
//1、项目的build.gradle文件
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}
//2、java 8或更高
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}
//3、添加插件及依赖
plugins {
    id 'kotlin-kapt'
}
 
dependencies {
    def rxhttp_version = '3.2.5'
    implementation 'com.squareup.okhttp3:okhttp:4.12.0'  
    implementation "com.github.liujingxing.rxhttp:rxhttp:$rxhttp_version"
    kapt "com.github.liujingxing.rxhttp:rxhttp-compiler:$rxhttp_version"
}
ksp依赖
//1、项目的build.gradle文件
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}
//2、java 8或更高,及配置sourceSets
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}
//3、添加插件及依赖
plugins {
    id 'com.google.devtools.ksp' version '1.9.23-1.0.19'
}
 
dependencies {
    def rxhttp_version = '3.2.5'
    implementation 'com.squareup.okhttp3:okhttp:4.12.0'  
    implementation "com.github.liujingxing.rxhttp:rxhttp:$rxhttp_version"
    ksp "com.github.liujingxing.rxhttp:rxhttp-compiler:$rxhttp_version"
}

4.2、可选

4.2.1、配置RxJava

如果你需要结合toObservableXxx方法发请求,就需要额外依赖RxJava,并且告知rxhttp你依赖的RxJava版本号

  • 依赖RxJava,RxJava2/RxJava3选其一
//RxJava3 
implementation 'io.reactivex.rxjava3:rxjava:3.1.6'
implementation 'io.reactivex.rxjava3:rxandroid:3.0.2'
implementation 'com.github.liujingxing.rxlife:rxlife-rxjava3:2.2.2' //管理RxJava3生命周期,页面销毁,关闭请求

//RxJava2
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.2' //管理RxJava2生命周期,页面销毁,关闭请求
  • 通过ksp/kapt/annotationProcessor,其中一种方式传递RxJava版本号
通过ksp传递RxJava版本
ksp {
    arg("rxhttp_rxjava", "3.1.6")
}
通过kapt传递RxJava版本
kapt {
    arguments {
        arg("rxhttp_rxjava", "3.1.6")
    }
}
通过annotationProcessor传递RxJava版本
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [
                    //使用asXxx方法时必须,传入你依赖的RxJava版本
                    rxhttp_rxjava: '3.1.6', 
                ]
            }
        }
    }
}

4.2.2、配置Converter

//非必须,根据自己需求选择 RxHttp默认内置了GsonConverter
implementation "com.github.liujingxing.rxhttp:converter-serialization:$rxhttp_version"
implementation "com.github.liujingxing.rxhttp:converter-fastjson:$rxhttp_version"
implementation "com.github.liujingxing.rxhttp:converter-jackson:$rxhttp_version"
implementation "com.github.liujingxing.rxhttp:converter-moshi:$rxhttp_version"
implementation "com.github.liujingxing.rxhttp:converter-protobuf:$rxhttp_version"
implementation "com.github.liujingxing.rxhttp:converter-simplexml:$rxhttp_version"

4.2.3、指定RxHttp相关类的存放目录

如果你有多个module依赖rxhttp-compiler(不建议这么做,一般base module依赖就好),则每个module下都会生成RxHttp类,且目录相同,在运行或打包时,就会出现RxHttp类冲突的问题,此时就需要你自定义RxHttp的存放目录,也就是RxHttp类的包名,ksp/kapt/annotationProcessor选择其中一种方式就好

通过ksp指定RxHttp相关类包名
ksp {
    arg("rxhttp_package", "rxhttp")  //指定RxHttp类包名,可随意指定 
}
通过kapt指定RxHttp相关类包名
 
kapt {
    arguments {
        arg("rxhttp_package", "rxhttp")  //指定RxHttp类包名,可随意指定
    }
}
通过javaCompileOptions指定RxHttp相关类包名
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [
                    rxhttp_package: 'rxhttp',  //指定RxHttp类包名,可随意指定
                ]
            }
        }
    }
}

最后,rebuild一下(此步骤是必须的) ,就会自动生成RxHttp类

5、混淆

  • RxHttp v2.2.8及以上版本,无需添加任何混淆规则,将你自己的Bean类Keep下就好
  • RxHttp v2.2.8以下版本,将RxHttp 混淆规则,添加到自己项目中,并将你自己的Bean类Keep下

6、Demo演示

更多功能,请下载apk体验

7、Donations

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

donations.png

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.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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.

简介

30秒上手,支持协程、RxJava2、RxJava3,史上最优雅的实现文件上传/下载/进度监听、动态/多域名、缓存;支持第三方数据解析工具、自定义请求、自动关闭请求等等 展开 收起
Android 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Android
1
https://gitee.com/327744707/okhttp-RxHttp.git
git@gitee.com:327744707/okhttp-RxHttp.git
327744707
okhttp-RxHttp
okhttp-RxHttp
master

搜索帮助