Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ParadiseHell/convex
An elegant tool based on Retrofit to help developers just focus on business data.
https://github.com/ParadiseHell/convex
android java retrofit2 retrofit2-converter
Last synced: 14 days ago
JSON representation
An elegant tool based on Retrofit to help developers just focus on business data.
- Host: GitHub
- URL: https://github.com/ParadiseHell/convex
- Owner: ParadiseHell
- License: apache-2.0
- Created: 2021-03-08T10:11:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-06T16:54:27.000Z (over 3 years ago)
- Last Synced: 2024-08-01T17:36:29.297Z (3 months ago)
- Topics: android, java, retrofit2, retrofit2-converter
- Language: Kotlin
- Homepage:
- Size: 2.11 MB
- Stars: 52
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Override
Convex is an elegant tool based on [Retrofit](https://github.com/square/retrofit)
to help developers just focus on business data.
With the ability of Convex you can process different **BaseResponse** simply
and uniformly.
# Background
Lots of Restful APIs' responses are designed as following :
```json
{
"code" : 0,
"message" : "",
"data" : {}
}
```
or
```json
{
"status" : 0,
"message" : "",
"data" : {}
}
```
and so on.
So when developers use **Retrofit**, they have to design a **BaseResponse**
as following :
```kotlin
data class BaseResponse(
@SerializedName("code")
val code : Int = 0,
@SerializedName("message")
val message : String?,
@SerializedName("data")
val data : T?
)
```
And when define a service method they need to wrap business data with
**BaseReponse** as following :
```kotlin
interface UserService {
@GET("/users")
suspend fun getAllUsers() : BaseResponse>
}
```
# Thoughts
Handing **BaseResponse** is really boring and repetitive.😖
Is there a way to just handle **BaseResponse** only once?🤔
Is there a way to remove the business data wraper **BaseResponse**?🤔
So **Convex** comes out.🎉 🎉 🎉
# How to use
For more details, please see the [ConvexTest](https://github.com/ParadiseHell/convex/blob/main/convex/src/test/kotlin/org/paradisehell/convex/ConvexTest.kt) or the [Android-Project](https://github.com/ParadiseHell/convex/blob/main/app/src/main/java/org/paradisehell/convex/MainActivity.kt).
### Grab Convex from Maven Central
In your build.gradle :
```gradle
dependencies {
implementation "org.paradisehell.convex:convex:1.0.0"
}
```
### Implement a ConvexTansformer
```kotlin
private class UserConvexTransformer : ConvexTransformer {
@Throws(IOException::class)
override fun transform(original: InputStream): InputStream {
TODO("Return the business data InputStream.")
}
}
```
### Add ConvexConverterFactory to Retrofit
```kotlin
Retrofit.Builder()
.baseUrl("https://users.com/")
// add ConvexConverterFactory first !!!
.addConverterFactory(ConvexConverterFactory())
.addConverterFactory(GsonConverterFactory.create())
.build()
```
### Define service method with `Transformer` annotation
```kotlin
interface UserService {
@GET("/users")
@Transformer(UserConvexTransformer::class)
suspend fun getAllUsers() : List // No BaseResponse is needed anymore.👻👻👻
}
```
**That's All, enjoy yourself with Convex.**
# More convenience usage
As you can see below, every service's method need to annotation with `Transformer`,
which is boring and repetitive. So `Convex` provide a plugin called `convex-booster`
to automatic to do this work.
### Add `booster-gradle-plugin` and `convex-booster` to classpath
In your root `build.gradle`
```gradle
buildscript {
dependencies {
// booster
classpath "com.didiglobal.booster:booster-gradle-plugin:3.3.1"
// convex-booster
classpath "org.paradisehell.convex:convex-booster:1.0.0"
}
}
```
### Apply booster plugin
In your app `build.gradle`
```
plugins {
id 'com.didiglobal.booster'
}
```
or
```
apply plugin: "com.didiglobal.booster"
```
### Define service with `Transformer` annotation
```kotlin
@Transformer(UserConvexTransformer::class)
interface UserService {
@GET("/users")
suspend fun getAllUsers() : List // No BaseResponse is needed anymore.👻👻👻
}
```
If you do not want `ConvexTransformer` to work with some service methods, you
can use `DisableTransformer` annotation with these method as following.
```kotlin
@Transformer(UserConvexTransformer::class)
interface UserService {
@GET("/users")
@DisableTransformer // Convex will ignore UserConvexTransformer
suspend fun getAllUsers() : BaseResponse>
}
```
# Thanks
- [booter](https://github.com/didi/booster)
- Optimizer for mobile applications.🚀🚀🚀
- An elegant framework to process bytecode really simply.👍👍👍
License
=======
Copyright 2021 ParadiseHell.
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.