Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lygttpod/RxHttpUtils
Rxjava+Retrofit封装，便捷使用
https://github.com/lygttpod/RxHttpUtils
Last synced: 21 days ago
JSON representation
Rxjava+Retrofit封装，便捷使用
- Host: GitHub
- URL: https://github.com/lygttpod/RxHttpUtils
- Owner: lygttpod
- Created: 2016-12-26T10:43:06.000Z (almost 8 years ago)
- Default Branch: 2.x
- Last Pushed: 2019-06-13T09:19:57.000Z (over 5 years ago)
- Last Synced: 2024-11-16T19:03:46.228Z (26 days ago)
- Language: Java
- Size: 426 KB
- Stars: 642
- Watchers: 17
- Forks: 126
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-hacking-lists - lygttpod/RxHttpUtils - Rxjava+Retrofit封装，便捷使用 (Java)
README
[](https://jitpack.io/#lygttpod/RxHttpUtils)
# 重磅推出 RxHttpUtils 2.x 版本
## RxJava+Retrofit封装，基于RxJava2和Retrofit2重构，便捷使用，支持动态切换baseUrl
### 添加Gradle依赖
先在项目根目录的 build.gradle 的 repositories 添加:
```
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
然后在dependencies添加:
```
dependencies {
...
compile 'com.github.lygttpod:RxHttpUtils:2.3.3'
}
```
# 使用说明
### 1、在application类里边进行初始化配置
> ##### 在自己的Application的onCreate方法中进行初始化配置
```
public class MyApplication extends Application {
Map headerMaps = new HashMap<>();
@Override
public void onCreate() {
super.onCreate();
OkHttpClient okHttpClient = new OkHttpConfig
.Builder(this)
//全局的请求头信息
.setHeaders(new BuildHeadersListener() {
@Override
public Map buildHeaders() {
HashMap hashMap = new HashMap<>();
hashMap.put("appVersion", BuildConfig.VERSION_NAME);
hashMap.put("client", "android");
hashMap.put("token", "your_token");
hashMap.put("other_header", URLEncoder.encode("中文需要转码"));
return hashMap;
}
})
//开启缓存策略(默认false)
//1、在有网络的时候，先去读缓存，缓存时间到了，再去访问网络获取数据；
//2、在没有网络的时候，去读缓存中的数据。
.setCache(true)
.setHasNetCacheTime(10)//默认有网络时候缓存60秒
.setNoNetCacheTime(3600)//默认有网络时候缓存3600秒
//全局持久话cookie,保存到内存（new MemoryCookieStore()）或者保存到本地（new SPCookieStore(this)）
//不设置的话，默认不对cookie做处理
.setCookieType(new SPCookieStore(this))
//可以添加自己的拦截器(比如使用自己熟悉三方的缓存库等等)
//.setAddInterceptor(null)
//全局ssl证书认证
//1、信任所有证书,不安全有风险（默认信任所有证书）
//.setSslSocketFactory()
//2、使用预埋证书，校验服务端证书（自签名证书）
//.setSslSocketFactory(cerInputStream)
//3、使用bks证书和密码管理客户端证书（双向认证），使用预埋证书，校验服务端证书（自签名证书）
//.setSslSocketFactory(bksInputStream,"123456",cerInputStream)
//全局超时配置
.setReadTimeout(10)
//全局超时配置
.setWriteTimeout(10)
//全局超时配置
.setConnectTimeout(10)
//全局是否打开请求log日志
.setDebug(true)
.build();
//一个项目多url的配置方法(这种写法的前提是事先已经知道所有的baseUrl了)
RxUrlManager.getInstance().setMultipleUrl(urlMap);
//如果是动态从服务器获取的baseUrl的话也可以添加进来
key是对url做区分使用，value就是服务器下发的baseUrl（baseUrl必须以"xxx/"斜杠结尾，retrofit的要求）
RxUrlManager.getInstance().addUrl("urlKey", "urlValue");
RxHttpUtils
.getInstance()
.init(this)
.config()
//使用自定义factory的用法
//.setCallAdapterFactory(RxJava2CallAdapterFactory.create())
//.setConverterFactory(ScalarsConverterFactory.create(),GsonConverterFactory.create(GsonAdapter.buildGson()))
//配置全局baseUrl
.setBaseUrl("https://api.douban.com/")
//开启全局配置
.setOkClient(okHttpClient);
}
}
```
### 2、默认已实现三种数据格式
* 1、CommonObserver （直接写自己的实体类即可，不用继承任何base）
* 2、StringObserver (直接String接收数据)
* 3、DataObserver (适合{"code":200,"msg":"描述",data:{}}这样的格式，需要使用BaseData<T> ,其中T为data中的数据模型)
> 如果以上三种不能满足你的需要，可以分别继承对应的baseObserver方法实现自己的逻辑
# 代码实例
> ## 使用Application里边的全局配置的参数
### 2.1、使用CommonObserver请求示例
```
a、 数据结构
{
"code": 0,
"msg": "success",
"username":"Allen",
"job":"Android",
...
}
备注：TestBean为以上数据结构的模型
b、 @GET("api/test")
Observable getTestData();
c、 RxHttpUtils
.createApi(ApiService.class)
.getTestData()
.compose(Transformer.switchSchedulers())
.subscribe(new CommonObserver() {
@Override
protected void onError(String errorMsg) {
//错误处理
}
@Override
protected void onSuccess(TestBean bookBean) {
//业务处理
}
});
```
### 2.2、使用DataObserver请求示例
```
a、 数据结构
{
"code":0,
"msg":"success",
"data":{
"username":"Allen",
"job":"Android Dev"
...
}
}
备注：TestBean为data中的数据模型
b、 @GET("api/test")
Observable> geTestData();
c、
RxHttpUtils.createApi(ApiServer.class)
.geTestData()
.compose(Transformer.>switchSchedulers())
.subscribe(new DataObserver() {
@Override
protected void onError(String errorMsg) {
}
@Override
protected void onSuccess(TestBean data) {
}
});
```
### 2.3、使用StringObserver请求示例
```
a、 @GET("api/test")
Observable geTestData();
b、
RxHttpUtils.createApi(ApiServer.class)
.geTestData()
.compose(Transformer.switchSchedulers())
.subscribe(new StringObserver() {
@Override
protected void onError(String errorMsg) {
}
@Override
protected void onSuccess(String data) {
}
});
```
### 2.4、链式请求示例--请求参数是上个请求的结果
```
RxHttpUtils
.createApi(ApiService.class)
.getBook()
.flatMap(new Function>() {
@Override
public ObservableSource apply(@NonNull BookBean bookBean) throws Exception {
return RxHttpUtils
.createApi(ApiService.class)
.getTop250(20);
}
})
.compose(Transformer.switchSchedulers(loading_dialog))
.subscribe(new CommonObserver() {
@Override
protected void onError(String errorMsg) {
//错误处理
}
@Override
protected void onSuccess(Top250Bean top250Bean) {
//业务处理
}
});
```
# 3、多baseUrl使用说明
> ### 动态切换全局单个baseUrl的方法
```
RxUrlManager.getInstance().clear().setUrl("baseUrl");
```
### 3.1、使用不同的baseUrl发送请求
```
创建格式如下
RxHttpUtils.createApi("xxxUrlKey", "xxxUrlValue", xxxApi.class)
以下是demo中示例的三个不同baseUrl的使用方法
RxHttpUtils.createApi(AppUrlConfig.DOUBAN_KEY, AppUrlConfig.DOUBAN_URL, DouBanApi.class)
RxHttpUtils.createApi(AppUrlConfig.WANANDROID_KET, AppUrlConfig.WANANDROID_URL, WanAndroidApi.class)
RxHttpUtils.createApi(AppUrlConfig.OTHER_OPEN_KEY, AppUrlConfig.OTHER_OPEN_URL, OtherOpenApi.class)
```
### 3.2、不同的baseUrl可以定制retrofit相关参数
```
ApiFactory.getInstance().setConverterFactory(...).setCallAdapterFactory(...).setOkClient(...).createApi(...)
```
### 3.3、注意事项：RxHttpUtils是对ApiFactory的封装，两种写法都可以
```
1、全局配置并且唯一baseUrl的两种写法如下
①、RxHttpUtils.createApi(XXXApi.class)
②、ApiFactory.getInstance().createApi(XXXApi.class)
2、多个baseUrl两种写法如下
①、RxHttpUtils.createApi("xxxUrlKey", "xxxUrlValue", XXXApi.class)
②、ApiFactory.getInstance().createApi("xxxUrlKey", "xxxUrlValue", XXXApi.class)
```
### 3.4、温馨提示
> #### 一般情况下某一个baseUrl下会有很多不同的请求，每次都写一遍3.3中提到的写法的话代码重复太多，建议对不同的baseUrl进行提取，具体可参照demo中ApiHelper的写法
```
public class ApiHelper {
/**
* 豆瓣url相关接口
* 注意：DouBanApi里边是baseUrl为豆瓣的所有请求,这样写就可以为不同的baseUrl创建不同的retrofit对象
* 可以为不同baseUrl设置不同的配置属性
*
* @return
*/
public static DouBanApi getDouBanApi() {
return RxHttpUtils.createApi(AppUrlConfig.DOUBAN_KEY, AppUrlConfig.DOUBAN_URL, DouBanApi.class);
}
/**
* 玩安卓url相关接口
* 注意：WanAndroidApi里边是baseUrl为玩安卓的所有请求,这样写就可以为不同的baseUrl创建不同的retrofit对象
*
* @return
*/
public static WanAndroidApi getWanAndroidApi() {
return RxHttpUtils.createApi(AppUrlConfig.WANANDROID_KET, AppUrlConfig.WANANDROID_URL, WanAndroidApi.class);
}
/**
* 其他开放的api接口
* 注意：OtherOpenApi里边是baseUrl为其他开放接口的所有请求,这样写就可以为不同的baseUrl创建不同的retrofit对象
*
* @return
*/
public static OtherOpenApi getOtherOpenApi() {
return RxHttpUtils.createApi(AppUrlConfig.OTHER_OPEN_KEY, AppUrlConfig.OTHER_OPEN_URL, OtherOpenApi.class);
}
}
```
### 4、文件下载 ----使用简单粗暴
```
String url = "https://t.alipayobjects.com/L1/71/100/and/alipay_wap_main.apk";
final String fileName = "alipay.apk";
RxHttpUtils
.downloadFile(url)
//.subscribe(new DownloadObserver(fileName,destFileDir) 其中 destFileDir是自定义下载存储路径
.subscribe(new DownloadObserver(fileName) {
//可以通过配置tag用于取消下载请求
@Override
protected String setTag() {
return "download";
}
@Override
protected void onError(String errorMsg) {
}
@Override
protected void onSuccess(long bytesRead, long contentLength, float progress, boolean done, String filePath) {
download_http.setText("下 载中：" + progress + "%");
if (done) {
responseTv.setText("下载文件路径：" + filePath);
}
}
});
```
### 5、上传图片
上传单张图片的接口
```
RxHttpUtils.uploadImg(uploadUrl, uploadPath)
.compose(Transformer.switchSchedulers(loading_dialog))
.subscribe(new CommonObserver() {
@Override
protected void onError(String errorMsg) {
Log.e("allen", "上传失败: " + errorMsg);
showToast(errorMsg);
}
@Override
protected void onSuccess(ResponseBody responseBody) {
try {
showToast(responseBody.string());
Log.e("allen", "上传完毕: " + responseBody.string());
} catch (IOException e) {
e.printStackTrace();
}
}
});
```
上传多张图片的接口
```
RxHttpUtils.uploadImgs("yourPicUrl", uploadPaths)
.compose(Transformer.switchSchedulers(loading_dialog))
.subscribe(new CommonObserver() {
@Override
protected void onError(String errorMsg) {
}
@Override
protected void onSuccess(ResponseBody responseBody) {
}
});
```
### 6、取消请求 相关配置
```
new XXXObserver() {
//重写setTag方法配置当前请求的tag
//温馨提示：可以多个请求设置相同的tag自动归为一组，可以一次取消相同tag的所有请求
//(适用于一个页面多个请求，配置相同tag，在页面销毁时一次性取消)
@Override
protected String setTag() {
return "yourTag";
}
@Override
protected void onError(String errorMsg) {
}
@Override
protected void onSuccess(BookBean bookBean) {
}
}
```
```
//调取如下方法取消某个或某组请求
RxHttpUtils.cancel("yourTag");
//调取如下方法取消多个或多组请求
RxHttpUtils.cancel("yourTag1","yourTag2","yourTag3");
```
### 7、onError中默认Toast显示隐藏的配置
* #### 在CommonObserver或DataObserver或StringObserver中重写isHideToast方法，默认false显示toast
```
//默认false 隐藏onError的提示
@Override
protected boolean isHideToast() {
return true;
}
```
### 8、混淆
* 如果使用到DataObserver需要对BaseData实体类混淆
```
-keep class com.allen.library.bean.**{*;}
```
# 参数说明
> 全局参数：在application中配置的参数都是以setXXX开头的,根据实际需求配置相应参数即可
```
// 获取证书
// InputStream cerInputStream = null;
// InputStream bksInputStream = null;
// try {
// cerInputStream = getAssets().open("YourSSL.cer");
// bksInputStream = getAssets().open("your.bks");
// } catch (IOException e) {
// e.printStackTrace();
// }
OkHttpClient okHttpClient = new OkHttpConfig
.Builder(this)
//全局的请求头信息
.setHeaders(new BuildHeadersListener() {
@Override
public Map buildHeaders() {
HashMap hashMap = new HashMap<>();
hashMap.put("appVersion", BuildConfig.VERSION_NAME);
hashMap.put("client", "android");
hashMap.put("token", "your_token");
hashMap.put("other_header", URLEncoder.encode("中文需要转码"));
return hashMap;
}
})
//开启缓存策略(默认false)
//1、在有网络的时候，先去读缓存，缓存时间到了，再去访问网络获取数据；
//2、在没有网络的时候，去读缓存中的数据。
.setCache(true)
.setHasNetCacheTime(10)//默认有网络时候缓存60秒
.setNoNetCacheTime(3600)//默认有网络时候缓存3600秒
//全局持久话cookie,保存到内存（new MemoryCookieStore()）或者保存到本地（new SPCookieStore(this)）
//不设置的话，默认不对cookie做处理
.setCookieType(new SPCookieStore(this))
//可以添加自己的拦截器(比如使用自己熟悉三方的缓存库等等)
//.setAddInterceptor(null)
//全局ssl证书认证
//1、信任所有证书,不安全有风险（默认信任所有证书）
//.setSslSocketFactory()
//2、使用预埋证书，校验服务端证书（自签名证书）
//.setSslSocketFactory(cerInputStream)
//3、使用bks证书和密码管理客户端证书（双向认证），使用预埋证书，校验服务端证书（自签名证书）
//.setSslSocketFactory(bksInputStream,"123456",cerInputStream)
//全局超时配置
.setReadTimeout(10)
//全局超时配置
.setWriteTimeout(10)
//全局超时配置
.setConnectTimeout(10)
//全局是否打开请求log日志
.setDebug(true)
.build();
RxHttpUtils
.getInstance()
.init(this)
.config()
//配置全局baseUrl
.setBaseUrl("https://api.douban.com/")
//开启全局配置
.setOkClient(okHttpClient);
```
```
new XXXObserver() {
//重写setTag方法配置当前请求的tag
//温馨提示：可以多个请求设置相同的tag自动归为一组，可以一次取消相同tag的所有请求
//(适用于一个页面多个请求，配置相同tag，在页面销毁时一次性取消)
@Override
protected String setTag() {
return "yourTag";
}
//默认false 隐藏onError的提示
@Override
protected boolean isHideToast() {
return false;
}
//请求错误回调
@Override
protected void onError(String errorMsg) {
}
//请求成功回调
@Override
protected void onSuccess(XXX xxx) {
}
}
```
# [更新日志](https://github.com/lygttpod/RxHttpUtils/releases)
# 意见反馈
或者手动加QQ群：688433795
如果遇到问题或者好的建议，请反馈到：[issue](https://github.com/lygttpod/RxHttpUtils/issues)、[[email protected]](mailto:[email protected]) 或者[[email protected]](mailto:[email protected])
如果觉得对你有用的话，点一下右上的星星赞一下吧!
# [**Demo下载地址**](https://fir.im/dzm1) 或者扫码下载demo
# License
Copyright 2019 Allen
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.