Merge pull request #140 from avaje/feature/support-interfaces

Support @JSON on interfaces and abstract types

Author: rbygrave

blackbox-test/src/main/java/org/example/customer/iface/AIFace.java

@@ -0,0 +1,11 @@
+package org.example.customer.iface;
+
+import io.avaje.jsonb.Json;
+
+@Json
+public interface AIFace {
+
+  String one();
+
+  long two();
+}

blackbox-test/src/main/java/org/example/customer/iface/BIFace.java

@@ -0,0 +1,16 @@
+package org.example.customer.iface;
+
+import io.avaje.jsonb.Json;
+
+@Json
+public interface BIFace {
+
+  String getOne();
+
+  boolean isTwo();
+
+  String getThree();
+
+  String four();
+
+}

blackbox-test/src/main/java/org/example/customer/iface/CIFace.java

@@ -0,0 +1,10 @@
+package org.example.customer.iface;
+
+public interface CIFace {
+
+  String oneToBe();
+
+  long twoNotHere();
+
+  String hi();
+}

blackbox-test/src/main/java/org/example/customer/iface/package-info.java

@@ -0,0 +1,4 @@
+@Json.Import(value = CIFace.class, jsonSettings = @Json(naming = Json.Naming.LowerHyphen))
+package org.example.customer.iface;
+
+import io.avaje.jsonb.Json;

blackbox-test/src/test/java/org/example/customer/iface/AIFaceTest.java

@@ -0,0 +1,40 @@
+package org.example.customer.iface;
+
+import io.avaje.jsonb.JsonType;
+import io.avaje.jsonb.JsonView;
+import io.avaje.jsonb.Jsonb;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class AIFaceTest {
+
+  Jsonb jsonb = Jsonb.builder().build();
+
+  record Foo(String one, long two) implements AIFace {
+  }
+
+  @Test
+  void toJson() {
+    JsonType<AIFace> type = jsonb.type(AIFace.class);
+
+    String asJson = type.toJson(new Foo("a", 42));
+    assertThat(asJson).isEqualTo("{\"one\":\"a\",\"two\":42}");
+  }
+
+  @Test
+  void toJsonView() {
+    JsonType<AIFace> type = jsonb.type(AIFace.class);
+
+    JsonView<AIFace> view0 = type.view("(one)");
+    String asJson = view0.toJson(new Foo("a", 42));
+    assertThat(asJson).isEqualTo("{\"one\":\"a\"}");
+
+    JsonView<AIFace> view1 = type.view("(one,two)");
+    assertThat(view1.toJson(new Foo("a", 42))).isEqualTo("{\"one\":\"a\",\"two\":42}");
+
+    JsonView<AIFace> view2 = type.view("(two)");
+    assertThat(view2.toJson(new Foo("a", 42))).isEqualTo("{\"two\":42}");
+  }
+
+}

blackbox-test/src/test/java/org/example/customer/iface/BIFaceTest.java

@@ -0,0 +1,54 @@
+package org.example.customer.iface;
+
+import io.avaje.jsonb.JsonType;
+import io.avaje.jsonb.JsonView;
+import io.avaje.jsonb.Jsonb;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class BIFaceTest {
+
+  Jsonb jsonb = Jsonb.builder().build();
+
+  record Foo(String one, boolean two, String three, String four) implements BIFace {
+    @Override
+    public String getOne() {
+      return one;
+    }
+
+    @Override
+    public boolean isTwo() {
+      return two;
+    }
+
+    @Override
+    public String getThree() {
+      return three;
+    }
+  }
+
+  @Test
+  void toJson() {
+    JsonType<BIFace> type = jsonb.type(BIFace.class);
+
+    String asJson = type.toJson(new Foo("a", true, "b", "c"));
+    assertThat(asJson).isEqualTo("{\"one\":\"a\",\"two\":true,\"three\":\"b\",\"four\":\"c\"}");
+  }
+
+  @Test
+  void toJsonView() {
+    JsonType<BIFace> type = jsonb.type(BIFace.class);
+
+    JsonView<BIFace> view0 = type.view("(one)");
+    String asJson = view0.toJson(new Foo("a", true, "b", "c"));
+    assertThat(asJson).isEqualTo("{\"one\":\"a\"}");
+
+    JsonView<BIFace> view1 = type.view("(one,two,four)");
+    assertThat(view1.toJson(new Foo("a", true, "b", "c"))).isEqualTo("{\"one\":\"a\",\"two\":true,\"four\":\"c\"}");
+
+    JsonView<BIFace> view2 = type.view("(two)");
+    assertThat(view2.toJson(new Foo("a", true, "b", "c"))).isEqualTo("{\"two\":true}");
+  }
+
+}

blackbox-test/src/test/java/org/example/customer/iface/CIFaceTest.java

@@ -0,0 +1,40 @@
+package org.example.customer.iface;
+
+import io.avaje.jsonb.JsonType;
+import io.avaje.jsonb.JsonView;
+import io.avaje.jsonb.Jsonb;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class CIFaceTest {
+
+  Jsonb jsonb = Jsonb.builder().build();
+
+  record Foo(String oneToBe, long twoNotHere, String hi) implements CIFace {
+  }
+
+  @Test
+  void toJson() {
+    JsonType<CIFace> type = jsonb.type(CIFace.class);
+
+    String asJson = type.toJson(new Foo("a", 42, "b"));
+    assertThat(asJson).isEqualTo("{\"one-to-be\":\"a\",\"two-not-here\":42,\"hi\":\"b\"}");
+  }
+
+  @Test
+  void toJsonView() {
+    JsonType<CIFace> type = jsonb.type(CIFace.class);
+
+    JsonView<CIFace> view0 = type.view("(one-to-be)");
+    String asJson = view0.toJson(new Foo("a", 42, "b"));
+    assertThat(asJson).isEqualTo("{\"one-to-be\":\"a\"}");
+
+    JsonView<CIFace> view1 = type.view("(one-to-be,two-not-here)");
+    assertThat(view1.toJson(new Foo("a", 42, "b"))).isEqualTo("{\"one-to-be\":\"a\",\"two-not-here\":42}");
+
+    JsonView<CIFace> view2 = type.view("(two-not-here)");
+    assertThat(view2.toJson(new Foo("a", 42, "b"))).isEqualTo("{\"two-not-here\":42}");
+  }
+
+}

jsonb-generator/src/main/java/io/avaje/jsonb/generator/ClassReader.java

@@ -20,13 +20,15 @@ final class ClassReader implements BeanReader {
 
   private final MethodReader constructor;
   private final List<FieldReader> allFields;
+  private final List<MethodProperty> methodProperties;
   private final Set<String> importTypes = new TreeSet<>();
   private final NamingConvention namingConvention;
   private final boolean hasSubTypes;
   private final TypeReader typeReader;
   private final String typeProperty;
   private final boolean nonAccessibleField;
   private final boolean caseInsensitiveKeys;
+  private final boolean readOnlyInterface;
   private FieldReader unmappedField;
   private boolean hasRaw;
   private final boolean isRecord;
@@ -37,6 +39,7 @@ final class ClassReader implements BeanReader {
   private final Map<String, Integer> frequencyMap = new HashMap<>();
   private final Map<String, Boolean> isCommonFieldMap = new HashMap<>();
   private final boolean optional;
+  private final List<TypeSubTypeMeta> subTypes;
 
   ClassReader(TypeElement beanType) {
     this(beanType, null);
@@ -58,7 +61,11 @@ final class ClassReader implements BeanReader {
     this.constructor = typeReader.constructor();
     this.optional = typeReader.hasOptional();
     this.isRecord = isRecord(beanType);
-    typeReader.subTypes().stream().map(TypeSubTypeMeta::type).forEach(importTypes::add);
+    this.subTypes = typeReader.subTypes();
+    this.readOnlyInterface = allFields.isEmpty() && subTypes.isEmpty();
+    this.methodProperties = typeReader.methodProperties();
+
+    subTypes.stream().map(TypeSubTypeMeta::type).forEach(importTypes::add);
 
     final var userTypeField = allFields.stream().filter(f -> f.propertyName().equals(typePropertyKey())).findAny();
 
@@ -132,6 +139,9 @@ public void read() {
         unmappedField = field;
       }
     }
+    for (final MethodProperty methodProperty : methodProperties) {
+      methodProperty.addImports(importTypes);
+    }
   }
 
   private Set<String> importTypes() {
@@ -151,6 +161,9 @@ private Set<String> importTypes() {
     for (final FieldReader allField : allFields) {
       allField.addImports(importTypes);
     }
+    for (final MethodProperty methodProperty : methodProperties) {
+      methodProperty.addImports(importTypes);
+    }
     return importTypes;
   }
 
@@ -194,6 +207,11 @@ public void writeFields(Append writer) {
         allField.writeField(writer);
       }
     }
+    for (final MethodProperty methodProperty : methodProperties) {
+      if (uniqueTypes.add(methodProperty.adapterShortType())) {
+        methodProperty.writeField(writer);
+      }
+    }
     writer.append("  private final PropertyNames names;").eol();
     writer.eol();
   }
@@ -221,12 +239,25 @@ public void writeConstructor(Append writer) {
         allField.writeConstructor(writer);
       }
     }
+    for (MethodProperty methodProperty : methodProperties) {
+      if (uniqueTypes.add(methodProperty.adapterShortType())) {
+        methodProperty.writeConstructor(writer);
+      }
+    }
     writer.append("    this.names = jsonb.properties(");
     if (hasSubTypes) {
       writer.append("\"").append(typeProperty).append("\", ");
     }
-    final StringBuilder builder = new StringBuilder();
+    writer.append(propertyNames());
+    writer.append(");").eol();
+  }
+
+  private String propertyNames() {
+    return readOnlyInterface ? propertyNamesReadOnly() : propertyNamesFields();
+  }
 
+  private String propertyNamesFields() {
+    final StringBuilder builder = new StringBuilder();
     //set to prevent writing same key twice
     final var seen = new HashSet<String>();
     for (int i = 0, size = allFields.size(); i < size; i++) {
@@ -243,8 +274,18 @@ public void writeConstructor(Append writer) {
       }
       builder.append("\"").append(fieldReader.propertyName()).append("\"");
     }
-    writer.append(builder.toString().replace(" , ", ""));
-    writer.append(");").eol();
+    return builder.toString().replace(" , ", "");
+  }
+
+  private String propertyNamesReadOnly() {
+    final StringBuilder builder = new StringBuilder();
+    for (int i = 0; i < methodProperties.size(); i++) {
+      if (i > 0) {
+        builder.append(", ");
+      }
+      builder.append("\"").append(methodProperties.get(i).propertyName()).append("\"");
+    }
+    return builder.toString().replace(" , ", "");
   }
 
   @Override
@@ -271,13 +312,14 @@ private void writeViewBuild(Append writer) {
     writer.append("  @Override").eol();
     writer.append("  public void build(ViewBuilder builder, String name, MethodHandle handle) {").eol();
     writer.append("    builder.beginObject(name, handle);").eol();
-    if (!hasSubTypes) {
-      for (final FieldReader allField : allFields) {
-        if (allField.includeToJson(null)) {
-          allField.writeViewBuilder(writer, shortName);
-        }
+    for (final FieldReader allField : allFields) {
+      if (allField.includeToJson(null)) {
+        allField.writeViewBuilder(writer, shortName);
       }
     }
+    for (final MethodProperty methodProperty : methodProperties) {
+      methodProperty.writeViewBuilder(writer, shortName);
+    }
     writer.append("    builder.endObject();").eol();
     writer.append("  }").eol();
   }
@@ -300,7 +342,6 @@ public void writeToJson(Append writer) {
 
   private void writeToJsonForSubtypes(Append writer, String varName) {
     if (hasSubTypes) {
-      final List<TypeSubTypeMeta> subTypes = typeReader.subTypes();
       for (int i = 0; i < subTypes.size(); i++) {
         final TypeSubTypeMeta subTypeMeta = subTypes.get(i);
         final String subType = subTypeMeta.type();
@@ -330,6 +371,9 @@ private void writeToJsonForType(Append writer, String varName, String prefix, St
         allField.writeToJson(writer, varName, prefix);
       }
     }
+    for (final MethodProperty methodProperty : methodProperties) {
+      methodProperty.writeToJson(writer, varName, prefix);
+    }
   }
 
   @Override
@@ -338,6 +382,12 @@ public void writeFromJson(Append writer) {
     writer.eol();
     writer.append("  @Override").eol();
     writer.append("  public %s fromJson(JsonReader reader) {", shortName, varName).eol();
+    if (readOnlyInterface) {
+      writer.append("    throw new UnsupportedOperationException();").eol();
+      writer.append("  }").eol();
+      return;
+    }
+
     final boolean directLoad = (constructor == null && !hasSubTypes && !optional);
     if (directLoad) {
       // default public constructor
@@ -401,7 +451,7 @@ private void writeJsonBuildResult(Append writer, String varName) {
 
   private void writeFromJsonWithSubTypes(Append writer) {
     final var typeVar = usesTypeProperty ? "_val$" + typePropertyKey() : "type";
-    final var useSwitch = typeReader.subTypes().size() >= 3;
+    final var useSwitch = subTypes.size() >= 3;
 
     if (!useSwitch || !nullSwitch) {
       writer.append("    if (%s == null) {", typeVar).eol();
@@ -422,7 +472,7 @@ private void writeFromJsonWithSubTypes(Append writer) {
     final Map<String, Integer> frequencyMap2 = new HashMap<>();
     final var req = new SubTypeRequest(typeVar, this, useSwitch, useEnum, frequencyMap2, isCommonFieldMap);
 
-    for (final TypeSubTypeMeta subTypeMeta : typeReader.subTypes()) {
+    for (final TypeSubTypeMeta subTypeMeta : subTypes) {
       final var varName = Util.initLower(Util.shortName(subTypeMeta.type()));
       subTypeMeta.writeFromJsonBuild(writer, varName, req);
     }

jsonb-generator/src/main/java/io/avaje/jsonb/generator/FieldProperty.java

@@ -1,6 +1,7 @@
 package io.avaje.jsonb.generator;
 
 import javax.lang.model.type.TypeMirror;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 
@@ -25,6 +26,10 @@ final class FieldProperty {
   private MethodReader getter;
   private MethodReader setter;
 
+  FieldProperty(MethodReader methodReader) {
+    this(methodReader.returnType(), false, false, new ArrayList<>(), false, methodReader.getName());
+  }
+
   FieldProperty(TypeMirror asType, boolean raw, boolean unmapped, List<String> genericTypeParams,
                        boolean publicField, String fieldName) {
     this.raw = raw;