Merge pull request #92 from avaje/feature/JsonOutput

Add JsonOutput to optimise writing to Nima ServerResponse

Author: rbygrave

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java_version: [17]
+        java_version: [19]
         os: [ubuntu-latest]
 
     steps:

jsonb-jackson/src/main/java/io/avaje/jsonb/jackson/JacksonAdapter.java

@@ -10,6 +10,7 @@
 import io.avaje.jsonb.spi.BytesJsonWriter;
 import io.avaje.jsonb.spi.JsonStreamAdapter;
 import io.avaje.jsonb.spi.PropertyNames;
+import io.avaje.jsonb.stream.JsonOutput;
 
 import java.io.*;
 
@@ -207,7 +208,6 @@ public JsonWriter writer(Writer writer) {
     }
   }
 
-
   @Override
   public JsonWriter writer(OutputStream outputStream) {
     try {
@@ -217,6 +217,16 @@ public JsonWriter writer(OutputStream outputStream) {
     }
   }
 
+  @Override
+  public JsonWriter writer(JsonOutput output) {
+    try {
+      // just unwrap the underlying OutputStream, not supporting JsonOutput per say
+      return new JacksonWriter(jsonFactory.createGenerator(output.unwrapOutputStream()), serializeNulls, serializeEmpty);
+    } catch (IOException e) {
+      throw new JsonIoException(e);
+    }
+  }
+
   @Override
   public BufferedJsonWriter bufferedWriter() {
     SegmentedStringWriter buffer = new SegmentedStringWriter(jsonFactory._getBufferRecycler());

jsonb/pom.xml

@@ -20,6 +20,14 @@
       <optional>true</optional>
     </dependency>
 
+    <dependency>
+      <groupId>io.helidon.nima.webserver</groupId>
+      <artifactId>helidon-nima-webserver</artifactId>
+      <version>4.0.0-ALPHA4</version>
+      <scope>provided</scope>
+      <optional>true</optional>
+    </dependency>
+
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>junit</artifactId>

jsonb/src/main/java/io/avaje/jsonb/JsonView.java

@@ -1,5 +1,7 @@
 package io.avaje.jsonb;
 
+import io.avaje.jsonb.stream.JsonOutput;
+
 import java.io.OutputStream;
 import java.io.Writer;
 
@@ -58,4 +60,9 @@ public interface JsonView<T> {
    * Write to the given outputStream.
    */
   void toJson(T value, OutputStream outputStream);
+
+  /**
+   * Write to the given output.
+   */
+  void toJson(T value, JsonOutput output);
 }

jsonb/src/main/java/io/avaje/jsonb/Jsonb.java

@@ -5,6 +5,7 @@
 import io.avaje.jsonb.spi.Bootstrap;
 import io.avaje.jsonb.spi.JsonStreamAdapter;
 import io.avaje.jsonb.spi.PropertyNames;
+import io.avaje.jsonb.stream.JsonOutput;
 
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -314,6 +315,11 @@ static Builder newBuilder() {
    */
   JsonWriter writer(OutputStream outputStream);
 
+  /**
+   * Return the JsonWriter used to write json to the given output.
+   */
+  JsonWriter writer(JsonOutput output);
+
   /**
    * Return the property names as PropertyNames.
    * <p>

jsonb/src/main/java/io/avaje/jsonb/core/DJsonType.java

@@ -3,6 +3,7 @@
 import io.avaje.jsonb.*;
 import io.avaje.jsonb.spi.BufferedJsonWriter;
 import io.avaje.jsonb.spi.BytesJsonWriter;
+import io.avaje.jsonb.stream.JsonOutput;
 
 import java.io.*;
 import java.lang.reflect.Type;
@@ -98,7 +99,15 @@ public final void toJson(T value, OutputStream outputStream) {
     close(outputStream);
   }
 
-  private void close(OutputStream outputStream) {
+  @Override
+  public final void toJson(T value, JsonOutput output) {
+    try (JsonWriter writer = jsonb.writer(output)) {
+      toJson(value, writer);
+    }
+    close(output);
+  }
+
+  private void close(Closeable outputStream) {
     try {
       outputStream.close();
     } catch (IOException e) {

jsonb/src/main/java/io/avaje/jsonb/core/DJsonb.java

@@ -2,6 +2,7 @@
 
 import io.avaje.jsonb.*;
 import io.avaje.jsonb.spi.*;
+import io.avaje.jsonb.stream.JsonOutput;
 import io.avaje.jsonb.stream.JsonStream;
 
 import java.io.InputStream;
@@ -94,6 +95,11 @@ public JsonWriter writer(OutputStream outputStream) {
     return io.writer(outputStream);
   }
 
+  @Override
+  public JsonWriter writer(JsonOutput output) {
+    return io.writer(output);
+  }
+
   @Override
   public JsonReader reader(Reader reader) {
     return io.reader(reader);

jsonb/src/main/java/io/avaje/jsonb/core/ViewBuilder.java

@@ -4,6 +4,7 @@
 import io.avaje.jsonb.spi.BufferedJsonWriter;
 import io.avaje.jsonb.spi.BytesJsonWriter;
 import io.avaje.jsonb.spi.PropertyNames;
+import io.avaje.jsonb.stream.JsonOutput;
 
 import java.io.IOException;
 import java.io.OutputStream;
@@ -243,6 +244,13 @@ public void toJson(T value, OutputStream outputStream) {
         toJson(value, writer);
       }
     }
+
+    @Override
+    public void toJson(T value, JsonOutput output) {
+      try (JsonWriter writer = jsonb.writer(output)) {
+        toJson(value, writer);
+      }
+    }
   }
 
   @SuppressWarnings({"rawtypes", "unchecked"})

jsonb/src/main/java/io/avaje/jsonb/spi/JsonStreamAdapter.java

@@ -2,6 +2,7 @@
 
 import io.avaje.jsonb.JsonReader;
 import io.avaje.jsonb.JsonWriter;
+import io.avaje.jsonb.stream.JsonOutput;
 
 import java.io.*;
 
@@ -40,6 +41,11 @@ public interface JsonStreamAdapter {
    */
   JsonWriter writer(OutputStream outputStream);
 
+  /**
+   * Return the JsonWriter given the output.
+   */
+  JsonWriter writer(JsonOutput output);
+
   /**
    * Return a JsonWriter for use for writing to json string.
    */

jsonb/src/main/java/io/avaje/jsonb/stream/DJsonOutput.java

@@ -0,0 +1,36 @@
+package io.avaje.jsonb.stream;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * Default implementation that simply wraps OutputStream.
+ */
+final class DJsonOutput implements JsonOutput {
+
+  private final OutputStream outputStream;
+
+  DJsonOutput(OutputStream outputStream) {
+    this.outputStream = outputStream;
+  }
+
+  @Override
+  public void write(byte[] content, int offset, int length) throws IOException {
+    outputStream.write(content, offset, length);
+  }
+
+  @Override
+  public void flush() throws IOException {
+    outputStream.flush();
+  }
+
+  @Override
+  public void close() throws IOException {
+    outputStream.close();
+  }
+
+  @Override
+  public OutputStream unwrapOutputStream() {
+    return outputStream;
+  }
+}