RxSON
Reactive HTTP Client for Java and Android.
Reactive JSON: Java Reactive approach to JSON.
A light library for composing asynchronous and event-based REST client by using observable json streams. It extends the Java Http Client to support Reactive json stream.
Why RxSON
-
Fast: makes it easy for the application to use JSON streamed chunks as soon as they arrive, and rendering you code faster.
-
Reactive Programming supports RxJava and Reactor: An Asynchronous Reactive JSON REST Client to stream any REST resource
-
Non-Blocking JSON parsing
-
Fetching huge JSON payload larger than the available memory:
- RxSON can load json trees larger than the available memory.
- Fetch response in chunks.
- No need to deserialize entire json into memory.
-
JsonPath to selectively extract desired json data
Getting started
RxSON is available at the Central Maven Repository with drivers for RxJava and Reactor
Rxjava
- Maven
<!--Rxjava--> <dependency> <groupId>com.github.rxson</groupId> <artifactId>rxson-rxjava</artifactId> <version>1.1.0</version> </dependency>
- Gradle
implementation 'com.github.rxson:rxson-rxjava:1.1.0'
Simple to use
Given the JSON stream
[
{
"Airport": {
"Code": "LA",
"Name": "LA: LA International"
}
},
{
"Airport": {
"Code": "ATL",
"Name": "Atlanta: Atlanta International"
}
},
//Incomplete and that's ok, more chunks expected to come
RxSON example
String serviceURL = "https://think.cs.vt.edu/corgis/datasets/json/airlines/airlines.json";
HttpRequest req = HttpRequest.newBuilder(URI.create(serviceURL)).GET().build();
RxSON rxson = new RxSON.Builder().build();
String jsonPath = "$[*].Airport.Name";
Flowable<String> airportStream = (Flowable<String>)rxson.create(String.class, req, jsonPath);
airportStream
.doOnNext(it -> System.out.println("Received new item: " + it))
//Just for test
.toList()
.blockingGet();
Object example:
package io.rxson.rxjava.model.airline;
import com.fasterxml.jackson.annotation.JsonProperty;
public class Airport {
@JsonProperty("Code")
public String code;
@JsonProperty("Name")
public String name;
public String getCode() { return code; }
public void setCode(String code) { this.code = code; }
public String getName() { return name; }
public void setName(String name) { this.name = name; }
} String serviceURL = "https://think.cs.vt.edu/corgis/datasets/json/airlines/airlines.json";
HttpRequest req = HttpRequest.newBuilder(URI.create(serviceURL)).GET().build();
RxSON rxson = new RxSON.Builder().build();
String jsonPath = "$[*].Airport";
Flowable<Airport> airportStream = (Flowable<Airport>)rxson.create(Airport.class, req, jsonPath);
airportStream
.observeOn(Schedulers.io())
.subscribeOn(Schedulers.io())
.doOnNext(it -> System.out.println("Received a flow item: " + it.getName()))
//Just for test
.toList()
.blockingGet();
If you need a Model example:
//Create your own models
public class JsonNodeModel {
@Reactive(path = "$[*].Airport")
private Flowable<JsonNode> result;
public Flowable<JsonNode> getResult() { return result; }
public void setResult(final Flowable<JsonNode> result) { this.result = result; }
} String serviceURL = "https://think.cs.vt.edu/corgis/datasets/json/airlines/airlines.json";
final HttpClient client = HttpClient.newBuilder().version(HttpClient.Version.HTTP_2).build();
final HttpRequest req = HttpRequest.newBuilder(URI.create(serviceURL)).GET().build();
final RxSON rxson = new RxSON.Builder().client(client).build();
final var airlinesStream = rxson.create(JsonNodeModel.class, req);
airlinesStream.getResult()
.doOnNext(it -> System.out.println("Received a flow item: " + it.get("Name")))
.toList().blockingGet();
Reactor project
- Maven
<!--Reactor--> <dependency> <groupId>com.github.rxson</groupId> <artifactId>rxson-reactor</artifactId> <version>1.1.0</version> </dependency>
- Gradle
implementation 'com.github.rxson:rxson-reactor:1.1.0'
RxSON example
String serviceURL = "https://think.cs.vt.edu/corgis/datasets/json/airlines/airlines.json";
HttpRequest req = HttpRequest.newBuilder(URI.create(serviceURL)).GET().build();
RxSON rxson = new RxSON.Builder().build();
String jsonPath = "$[*].Airport.Name";
Flux<String> airportStream = (Flux<String>) rxson.create(String.class, req, jsonPath);
airportStream
.doOnNext(it -> System.out.println("Received new item: " + it))
//Just for test
.blockLast();
More detailed examples are available in tests.
Goal
RxSON designed to speed up you code by providing reactive objects before the response complete. This library provides an Asynchronous Reactive REST Client to stream any REST resource. RxSON makes it easy for the application to use JSON streamed chunks from the response as soon as they arrive, and rendering you code faster.
RxSON treats the HTTP response as a series of small, useful chunks and map them to Java Objects
Useful helpers
Prerequisites: Java 11 +
License
Apache 2.0, see LICENSE.
Support
If you need help, please reach out to me: [email protected]