Skip to content

Latest commit

 

History

History
396 lines (304 loc) · 9.18 KB

README.md

File metadata and controls

396 lines (304 loc) · 9.18 KB
Raw

RxHttp

English | 中文文档

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

A type-safe HTTP client for Android. Written based on OkHttp

sequence_chart_en.jpg

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

//or awaitResult return kotlin.Result<T>
RxHttp.get("/server/..")
    .add("key", "value")
    .toAwait<User>()  
    .awaitResult { 
        //Success
    }.onFailure {  
        //Failure
    } 
RxHttp.get("/server/..")
    .add("key", "value")
    .toFlow<User>()  
    .catch { 
        //Failure
    }.collect {  
        //Success
    }           
RxHttp.get("/server/..")
    .add("key", "value")
    .toObservable<User>()  
    .subscribe({ 
        //Success
    }, {  
        //Failure
    })           
RxHttp.get("/server/..")
    .add("key", "value")
    .toObservable(User.class)  
    .subscribe(user - > { 
        //Success
    }, throwable -> {  
        //Failure
    })

1、Feature

  • Support kotlin coroutines, RxJava2, RxJava3

  • Support Gson, Xml, ProtoBuf, FastJson and other third-party data parsing tools

  • Supports automatic closure of requests in FragmentActivity, Fragment, View, ViewModel, and any class

  • Support global encryption and decryption, add common parameters and headers, network cache, all support a request set up separately

2、usage

1、Adding dependencies and configurations

Required

1、Add jitpack to your build.gradle 
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}
2、Java 8 or higher 
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}
3、Add RxHttp dependency 
plugins {
    // kapt/ksp choose one
    // id 'kotlin-kapt'
    id 'com.google.devtools.ksp' version '1.9.23-1.0.19'
}
    
dependencies {
    def rxhttp_version = '3.3.0'
    implementation 'com.squareup.okhttp3:okhttp:4.12.0'  
    implementation "com.github.liujingxing.rxhttp:rxhttp:$rxhttp_version"
    // ksp/kapt/annotationProcessor choose one
    ksp "com.github.liujingxing.rxhttp:rxhttp-compiler:$rxhttp_version"
 }

Optional

1、Converter

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"

2、RxJava

RxHttp + 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, Automatic close request
RxHttp + 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, Automatic close request
ksp passes the RxJava version 
ksp {
    arg("rxhttp_rxjava", "3.1.6")
}
Kapt passes the RxJava version 
kapt {
    arguments {
        arg("rxhttp_rxjava", "3.1.6")
    }
}
javaCompileOptions passes the RxJava version 
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [
                    rxhttp_rxjava: '3.1.6', 
                ]
            }
        }
    }
}

3、set RxHttp class package name

ksp pass package name 
ksp {
     arg("rxhttp_package", "rxhttp.xxx")
}
kapt pass package name 
kapt {
    arguments {
       arg("rxhttp_package", "rxhttp.xxx") 
    }
}
javaCompileOptions pass package name 
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [
                    rxhttp_package: 'rxhttp.xxx'
                ]
            }
        }
    }
}

Finally, rebuild the project, which is necessary

2、Initialize the SDK

This step is optional

RxHttpPlugins.init(OkHttpClient)  
    .setDebug(boolean)  
    .setOnParamAssembly(Consumer)
    ....

3、Configuration BaseUrl

This step is optional

public class Url {

    //Add the @defaultDomain annotation to BASE_URL
    @DefaultDomain
    public static BASE_URL = "https://..."
}

4、Perform the requested

// java
RxHttp.get("/service/...")   //1、You can choose get,postFrom,postJson etc
    .addQuery("key", "value")               //add query param
    .addHeader("headerKey", "headerValue")  //add request header
    .toObservable(Student.class)  //2、Use the toXxx method to determine the return value type, customizable
    .subscribe(student -> {  //3、Subscribing observer
        //Success callback，Default IO thread
    }, throwable -> {
        //Abnormal callback
    });

// kotlin 
RxHttp.postForm("/service/...")          //post FormBody
    .add("key", "value")                 //add param to body
    .addQuery("key1", "value1")          //add query param
    .addFile("file", File(".../1.png"))  //add file to body
    .toObservable<Student>()           
    .subscribe({ student ->       
        //Default IO thread
    }, { throwable ->
        
    })

// kotlin coroutine
val students = RxHttp.postJson("/service/...")  //1、post {application/json; charset=utf-8}
    .toAwaitList<Student>()                          //2、Use the toXxx method to determine the return value type, customizable
    .await()                                    //3、Get the return value, await is the suspend method

3、Advanced usage

 1、Close the request

//In Rxjava2 , Automatic close request
RxHttp.get("/service/...")
    .toObservableString()
    .as(RxLife.as(this))  //The Activity destroys and automatically closes the request
    .subscribe(s -> {
        //Default IO thread
    }, throwable -> {

    });

//In Rxjava3 , Automatic close request
RxHttp.get("/service/...")
    .toObservableString()
    .to(RxLife.to(this))  //The Activity destroys and automatically closes the request
    .subscribe(s -> {
        //Default IO thread
    }, throwable -> {
        
    });


//In RxJava2/RxJava3, close the request manually
Disposable disposable = RxHttp.get("/service/...")
    .toObservableString()
    .subscribe(s -> {
        //Default IO thread
    }, throwable -> {
        
    });

disposable.dispose(); //Close the request at the appropriate time

4、ProGuard

If you are using RxHttp v2.2.8 or above the shrinking and obfuscation rules are included automatically. Otherwise you must manually add the options in rxhttp.pro.

5、Donations

If this project helps you a lot and you want to support the project's development and maintenance of this project, feel free to scan the following QR code for donation. Your donation is highly appreciated. Thank you!

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.