RxHttp Documentation

To use the kapt method, apply the kotlin-kapt plugin and ensure your project uses Java 8 or higher with the JitPack repository.

// 1. Project build.gradle
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

// 2. Android build.gradle
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// 3. Plugins and Dependencies
plugins {
    id 'kotlin-kapt'
}
 
dependencies {
    def rxhttp_version = '3.5.1'
    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"
}

If you are using RxJava, you must include the appropriate RxJava and RxAndroid dependencies. Additionally, you should use rxlife for automatic request closure.

You can pass the specific RxJava version to the RxHttp compiler using ksp, kapt, or javaCompileOptions to ensure compatibility.

// RxJava3 Setup
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'

// Pass RxJava version to KSP
ksp {
    arg("rxhttp_rxjava", "3.1.6")
}

RxHttp supports various third-party data parsing tools via optional converter modules. Add the one that matches your preferred serialization library.

// Example converters
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"

To use the ksp method, apply the com.google.devtools.ksp plugin and ensure your project uses Java 8 or higher with the JitPack repository.

// 1. Project build.gradle
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

// 2. Android build.gradle
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// 3. Plugins and Dependencies
plugins {
    id 'com.google.devtools.ksp' version '2.3.4'
}
 
dependencies {
    def rxhttp_version = '3.5.1'
    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"
}

To use the annotationProcessor method, ensure your project uses Java 8 or higher and includes the JitPack repository.

Note: RxHttp is compatible with OkHttp 3.12.0 - v4.12.0 (excluding 4.3.0). For compatibility with API levels below 21, use OkHttp 3.12.x.

// 1. Project build.gradle
allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

// 2. Android build.gradle (Java 8 requirement)
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// 3. Dependencies
dependencies {
    def rxhttp_version = '3.5.1'
    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"
}

RxHttp includes a default GsonConverter. If you prefer other serialization libraries, add the corresponding dependency. Choose only one converter from the following list:

// Choose one based on your needs
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"

If you have multiple modules depending on rxhttp-compiler, you may encounter class conflicts because RxHttp classes are generated in the same default directory. To avoid this, customize the package name for the generated RxHttp classes using rxhttp_package via ksp, kapt, or annotationProcessor. After configuration, you must rebuild the project.

// Using KSP
ksp {
    arg("rxhttp_package", "rxhttp")
}

// Using KAPT
kapt {
    arguments {
        arg("rxhttp_package", "rxhttp")
    }
}

// Using annotationProcessor
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [
                    rxhttp_package: 'rxhttp',
                ]
            }
        }
    }
}

You can customize the generated RxHttp class package name by passing the rxhttp_package argument to your annotation processor (KSP, Kapt, or javaCompileOptions).

// Using KSP
ksp {
     arg("rxhttp_package", "rxhttp.xxx")
}

// Using javaCompileOptions
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [
                    rxhttp_package: 'rxhttp.xxx'
                ]
            }
        }
    }
}

Obfuscation requirements depend on your RxHttp version:

• RxHttp v2.2.8 and above: No specific RxHttp rules are required. You only need to add -keep rules for your own Bean classes.
• RxHttp below v2.2.8: You must add the official RxHttp obfuscation rules to your project in addition to keeping your Bean classes.