https://github.com/bakerjq/rxretrohttp
RxJava2 + Retrofit2 http request lib, supports multiple api result data structures and multiple urls. Http请求库，支持同时存在多种返回格式和多个base url
https://github.com/bakerjq/rxretrohttp
http retrofit retrofit2 rxjava rxjava2
Last synced: 6 months ago
JSON representation
RxJava2 + Retrofit2 http request lib, supports multiple api result data structures and multiple urls. Http请求库，支持同时存在多种返回格式和多个base url
- Host: GitHub
- URL: https://github.com/bakerjq/rxretrohttp
- Owner: BakerJQ
- Created: 2019-01-15T12:20:03.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T11:17:38.000Z (about 2 years ago)
- Last Synced: 2024-01-06T07:41:30.345Z (about 2 years ago)
- Topics: http, retrofit, retrofit2, rxjava, rxjava2
- Language: Java
- Homepage:
- Size: 225 KB
- Stars: 57
- Watchers: 5
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RxRetroHttp
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://jitpack.io/#BakerJQ/RxRetroHttp)
Android http request lib, supports multiple api result data structures and multiple urls
Http请求库，支持同时存在多种返回格式和多个base url（[中文文档](https://github.com/BakerJQ/RxRetroHttp/blob/master/README_cn.md)）
## Why RxRetroHttp
In some case, we have to include more than one http request style -- eg. multiple result structure, multiple host address, multiple http settings, etc-- in one app.
This usually happens when we need to use some third party api or combine multiple system in one project.
RxRetroHttp suppose to simplify your http request realization in this situation.
## Gradle via JitPack
Add it in your root build.gradle at the end of repositories:
``` groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Add the dependency
``` groovy
dependencies {
implementation 'com.github.BakerJQ:RxRetroHttp:1.2.10'
}
```
## How to use
### Initialize
#### Main Api Request
Initialize the sdk in Application, the code below shows the initialization of the main url request settings
```java
RxRetroHttp.init(this)
.setBaseUrl("https://api.github.com/")//your main url
.setDefaultErrMsg("Github开小差了")//default error hint message
.setApiResultClass(GithubApiResult.class)//your main api result structure, if not, will use default gson converter
.generateRetroClient()
```
#### Other Api Request
If your app includes other api request, try the code below
Mention:
- You need to do this after you called init()
- DON'T forget to add the 'Tag' in generateRetroClient() function
- If you don't set an ApiResultClass, the lib will use GsonConverterFactory as default, this means that the lib will not deal with response logic for you, or you can add your own ResponseConverter
```java
RxRetroHttp.getInstance()
.setApiResultClass(YourApiResult.class)//other result
.setBaseUrl("http://host/api/data/")//other url
.generateRetroClient("YourTag");//other request tag
```
#### Settings
You can customize your http settings by get and reset the builders, or calling setting functions
Mention: This must be done AFTER init() and BEFORE generateRetroClient() function
```java
RxRetroHttp.init().setXXX().setXXX();
Retrofit.Builder retrofitBuilder = RxRetroHttp.getRetrofitBuilder();
retrofitBuilder.setXXX().setXXX();
OkHttpClient.Builder okHttpBuilder = RxRetroHttp.getOkHttpClientBuilder();
okHttpBuilder.setXXX().setXXX();
RxRetroHttp.getInstance().generateRetroClient();
//RxRetroHttp.getInstance().generateRetroClient("YourTag")
```
### Api Request
#### Step 1. Define Api Result Structure by Implement IApiResult
Code below is just a simple sample
```java
public class YourApiResult implements IApiResult {
private int code;//result code
private String msg;//result message
private T result;//result data
//define what means a successful result(eg. code == 1)
@Override
public boolean isSuccess();
//return the structured data
@Override
public T getData();
//return the message
@Override
public String getResultMsg();
//return the code
@Override
public String getResultCode();
//return the key name of "result" in the response json
@Override
public String getDataField();
}
```
#### Step 2. Define Retrofit Api Service
Define the ApiService, to be mentioned, you DO NOT need to use wrapped api result like "Observable>", and add RetroTag annotation if this is a tagged request
```java
@RetroTag("YourTag")
public interface YourApiService {
@GET("test/info")
Observable getTestInfo();
@GET("test/list")
Observable> getTestInfo();
}
```
#### Step 3. Call Request
Just define a call like Retrofit
```java
RxRetroHttp.create(YourApiService.class).getTestInfo()
```
### Mock Data
You can mock your api data in two ways: from file or from json string.
You should enable mock when init;
```java
RxRetroHttp.init(this).setMockEnable(true)
```
#### Mock From File
Step 1. Put your mock data file under assets dir
Step 2. Add headers to your api function
```java
@Headers({RxRetroHttp.MOCK_FILE_PATH_KEY + ":mockfile.json")
@GET("test/info")
Observable getTestInfo();
```
#### Mock From Json String
Just add headers to your api function
```java
@Headers({RxRetroHttp.MOCK_DATA_KEY + ":{\"testInfo\":\"info\"}")
@GET("test/info")
Observable getTestInfo();
```
#### Header Keys
| key | desc |
| ---- | ---- |
| MOCK_DATA_KEY | mock json string |
| MOCK_FILE_PATH_KEY | mock assets file path |
| MOCK_ENABLE_KEY | enable or disable mock |
| MOCK_DELAY_KEY | delay duration of response |
## Proguard
- Add Retrofit proguard
- Add OkHttp proguard
- Deal with your data entity
## For Android Api Level 21-
For 21- projects, add the dependency like below
``` groovy
dependencies {
implementation ('com.github.BakerJQ:RxRetroHttp:1.2.0'){
exclude group: 'com.squareup.okhttp3', module: 'okhttp'
}
implementation 'com.squareup.okhttp3:okhttp:3.12.0'
}
```
## Thanks
Thanks To （[RxEasyHttp](https://github.com/zhou-you/RxEasyHttp)）
## *License*
RxRetroHttp is released under the Apache 2.0 license.
```
Copyright 2019 BakerJ.
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 following link.
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.
```