Merge branch 'avaje:main' into main

Author: mechite

README.md

@@ -4,7 +4,7 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/avaje/avaje-jsonb/blob/master/LICENSE)
 [![Discord](https://img.shields.io/discord/1074074312421683250?color=%237289da&label=discord)](https://discord.gg/Qcqf9R27BR)
 
-# [Avaje-JsonB](https://avaje.io/jsonb/)
+# [avaje-jsonb](https://avaje.io/jsonb/)
 
 Fast, reflection-free Json binding via apt source code generation. A light (~200kb + generated code) source code generation style alternative to Jackson's ObjectMapper or Gson. (code generation vs reflection)
 
@@ -31,7 +31,6 @@ Built-in support for reading and writing Java’s core data types:
  * Enums
  * Other miscellaneous types (UUID, URL, URI)
 
-
 # Quick Start
 
 ## Step 1 - Add dependencies
@@ -41,18 +40,10 @@ Built-in support for reading and writing Java’s core data types:
   <artifactId>avaje-jsonb</artifactId>
   <version>${avaje-jsonb-version}</version>
 </dependency>
-<!-- if using spring web, add the below to use jsonb for http messaging -->
-<dependency>
-  <groupId>io.avaje</groupId>
-  <artifactId>avaje-jsonb-spring-starter</artifactId>
-  <version>${avaje-jsonb-version}</version>
-</dependency>
 ```
 
 And add avaje-jsonb-generator as an annotation processor.
 ```xml
-
-<!-- Annotation processors -->
 <dependency>
   <groupId>io.avaje</groupId>
   <artifactId>avaje-jsonb-generator</artifactId>
@@ -102,7 +93,7 @@ JsonType<Customer> customerType = jsonb.type(Customer.class);
 Customer customer = ...;
 
 // serialize to json
-String asJson =  customerType.toJson(customer);
+String asJson = customerType.toJson(customer);
 
 // deserialize from json
 Customer customer = customerType.fromJson(asJson);
@@ -122,14 +113,14 @@ JsonType<Customer> customerType = jsonb.type(Customer.class);
 
 // only including the id and name
 JsonView<Customer> idAndNameView = customerType.view("(id, name)");
-String asJson =  idAndNameView.toJson(customer);
+String asJson = idAndNameView.toJson(customer);
 
 
 JsonView<Customer> myView =
   customerType.view("(id, name, billingAddress(*), contacts(lastName, email))");
 
 // serialise to json the above specified properties only
-String asJson =  myView.toJson(customer);
+String asJson = myView.toJson(customer);
 ```
 
 ### Generated Code
@@ -230,8 +221,8 @@ public final class AddressJsonAdapter implements JsonAdapter<Address>, ViewBuild
 
 #### Changes from Moshi
 - Generates Java source code (rather than Kotlin)
-- uses custom parser inspired by dsl-json (with option of using jackson-core `JsonParser` and `JsonGenerator` as parsers)
-- Has no fallback to reflection - jsonb is code generation or bust.`
+- Uses custom parser inspired by `dsl-json` (with option of using `jackson-core`'s `JsonParser` and `JsonGenerator` as parsers)
+- Has no fallback to reflection - jsonb is code generation or bust.
 - JsonReader - Make JsonReader an interface, default implementation using `Jsonb JsonReadAdapter`
 - JsonWriter - Make JsonWriter an interface, default implementation using `Jsonb JsonWriteAdapter`
 - JsonAdapter -> Make JsonAdapter an interface.
@@ -243,11 +234,37 @@ public final class AddressJsonAdapter implements JsonAdapter<Address>, ViewBuild
 - Add fromObject() as a "covert from object" feature like Jackson ObjectMapper
 - Add naming convention support
 - Add `@Json.Import` to generate adapters for types that we can't put the annotation on (types we might not 'own')
+- Add support for generating adapters (for `@Json.Import`ed types) with annotations from Jackson, GSON and Jakarta
 - Add Mixin feature similar to Jackson Mixins
 - Add Types.listOf(), Types.setOf(), Types.mapOf() helper methods
 - Adds more common Java types with default built-in support - java.time types, java.util.UUID
 - Adds support for json views
 
+## Optional extensions
+
+### Optional support for Jackson, GSON and Jakarta annotations
+When using `@Json.Import` for types we "don't own", we provide basic support for annotations from other popular libraries.\
+Simply add either `jackson-annotations`, `gson` or `jakarta.json.bind-api`, and use `@Json.Import` to generate an adapter.
+
+| Avaje Jsonb      | Jackson         | Gson                           | Jakarta JSON-B        |
+|------------------|-----------------|--------------------------------|-----------------------|
+| `@Json.Alias`    | `@JsonAlias`    | `@SerializedName(alternate=…)` | —                     |
+| `@Json.Creator`  | `@JsonCreator`  | —                              | `@JsonbCreator`       |
+| `@Json.Ignore`   | `@JsonIgnore`   | `@Expose(serialize = false)`   | `@JsonbTransient`     |
+| `@Json.Property` | `@JsonProperty` | `@SerializedName`              | `@JsonbProperty`      |
+| `@Json.Raw`      | `@JsonRawValue` | —                              | —                     |
+| `@Json.Value`    | —               | —                              | —                     |
+
+### Optional support for Spring Web
+When using Spring Web, you can use the following dependency to use avaje-jsonb for HTTP serialization:
+```xml
+<dependency>
+  <groupId>io.avaje</groupId>
+  <artifactId>avaje-jsonb-spring-starter</artifactId>
+  <version>${avaje-jsonb-version}</version>
+</dependency>
+```
+
 ## Related works
 - [moshi](https://github.com/square/moshi), [reddit - why use moshi over gson](https://www.reddit.com/r/androiddev/comments/684flw/why_use_moshi_over_gson/)
 - [dsl-json](https://github.com/ngs-doo/dsl-json)

jsonb-generator/pom.xml

@@ -23,7 +23,6 @@
   </licenses>
 
   <dependencies>
-
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-jsonb</artifactId>
@@ -32,14 +31,6 @@
       <scope>provided</scope>
     </dependency>
 
-    <dependency>
-      <groupId>com.fasterxml.jackson.core</groupId>
-      <artifactId>jackson-annotations</artifactId>
-      <version>2.20</version>
-      <optional>true</optional>
-      <scope>provided</scope>
-    </dependency>
-
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-prisms</artifactId>
@@ -54,6 +45,29 @@
       <version>${spi.version}</version>
     </dependency>
 
+    <!-- optional support for other annotations -->
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-annotations</artifactId>
+      <version>2.20</version>
+      <optional>true</optional>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>2.13.2</version>
+      <optional>true</optional>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>jakarta.json.bind</groupId>
+      <artifactId>jakarta.json.bind-api</artifactId>
+      <version>3.0.1</version>
+      <optional>true</optional>
+      <scope>provided</scope>
+    </dependency>
+
     <!-- test dependencies -->
     <dependency>
       <groupId>io.avaje</groupId>

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

@@ -1,27 +1,35 @@
 package io.avaje.jsonb.generator;
 
-import java.util.List;
-import java.util.Optional;
-
-import javax.lang.model.element.Element;
-
 import com.fasterxml.jackson.annotation.JsonAlias;
-
+import com.google.gson.annotations.SerializedName;
 import io.avaje.jsonb.Json.Alias;
 import io.avaje.prism.GeneratePrism;
 
-@GeneratePrism(value = Alias.class, name = "AvajeAliasPrism", superInterfaces = AliasPrism.class)
+import javax.lang.model.element.Element;
+import java.util.List;
+import java.util.Optional;
+
 @GeneratePrism(
-    value = JsonAlias.class,
-    name = "JacksonAliasPrism",
-    superInterfaces = AliasPrism.class)
+  value = Alias.class,
+  name = "AvajeAliasPrism",
+  superInterfaces = AliasPrism.class)
+@GeneratePrism(
+  value = JsonAlias.class,
+  name = "JacksonAliasPrism",
+  superInterfaces = AliasPrism.class)
+@GeneratePrism(
+  value = SerializedName.class,
+  name = "GsonAliasPrism")
 public interface AliasPrism {
 
-
   static Optional<AliasPrism> getOptionalOn(Element element) {
     return Optional.<AliasPrism>empty()
         .or(() -> AvajeAliasPrism.getOptionalOn(element))
-        .or(() -> JacksonAliasPrism.getOptionalOn(element));
+        .or(() -> JacksonAliasPrism.getOptionalOn(element))
+        .or(() -> GsonAliasPrism.getOptionalOn(element)
+                    .map(GsonAliasPrism::alternate)
+                    .map(aliases -> (AliasPrism) () -> aliases)
+                    .filter(prism -> !prism.value().isEmpty()));
   }
 
   List<String> value();

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

@@ -6,6 +6,7 @@
 
 import io.avaje.jsonb.Json.Creator;
 import io.avaje.prism.GeneratePrism;
+import jakarta.json.bind.annotation.JsonbCreator;
 
 @GeneratePrism(
     value = Creator.class,
@@ -15,9 +16,15 @@
     value = JsonCreator.class,
     name = "JacksonCreatorPrism",
     superInterfaces = CreatorPrism.class)
+@GeneratePrism(
+    value = JsonbCreator.class,
+    name = "JakartaCreatorPrism",
+    superInterfaces = CreatorPrism.class)
 public interface CreatorPrism {
 
   static boolean isPresent(Element element) {
-    return AvajeCreatorPrism.isPresent(element) || JacksonCreatorPrism.isPresent(element);
+    return AvajeCreatorPrism.isPresent(element)
+      || JacksonCreatorPrism.isPresent(element)
+      || JakartaCreatorPrism.isPresent(element);
   }
 }

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

@@ -6,14 +6,27 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 
+import com.google.gson.annotations.Expose;
 import io.avaje.jsonb.Json.Ignore;
 import io.avaje.prism.GeneratePrism;
+import jakarta.json.bind.annotation.JsonbTransient;
 
-@GeneratePrism(value = Ignore.class, name = "AvajeIgnorePrism", superInterfaces = IgnorePrism.class)
 @GeneratePrism(
-    value = JsonIgnore.class,
-    name = "JacksonIgnorePrism",
-    superInterfaces = IgnorePrism.class)
+  value = Ignore.class,
+  name = "AvajeIgnorePrism",
+  superInterfaces = IgnorePrism.class)
+@GeneratePrism(
+  value = JsonIgnore.class,
+  name = "JacksonIgnorePrism",
+  superInterfaces = IgnorePrism.class)
+@GeneratePrism(
+  value = Expose.class,
+  name = "GsonIgnorePrism",
+  superInterfaces = IgnorePrism.class)
+@GeneratePrism(
+  value = JsonbTransient.class,
+  name = "JakartaIgnorePrism",
+  superInterfaces = IgnorePrism.class)
 public interface IgnorePrism {
 
   static IgnorePrism getInstanceOn(Element element) {
@@ -23,7 +36,9 @@ static IgnorePrism getInstanceOn(Element element) {
   static Optional<IgnorePrism> getOptionalOn(Element element) {
     return Optional.<IgnorePrism>empty()
         .or(() -> AvajeIgnorePrism.getOptionalOn(element))
-        .or(() -> JacksonIgnorePrism.getOptionalOn(element));
+        .or(() -> JacksonIgnorePrism.getOptionalOn(element))
+        .or(() -> GsonIgnorePrism.getOptionalOn(element))
+        .or(() -> JakartaIgnorePrism.getOptionalOn(element));
   }
 
   default Boolean serialize() {

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

@@ -4,12 +4,10 @@
 import static io.avaje.jsonb.generator.APContext.logError;
 import static io.avaje.jsonb.generator.APContext.logNote;
 import static io.avaje.jsonb.generator.APContext.typeElement;
-import static io.avaje.jsonb.generator.Constants.JSON;
-import static io.avaje.jsonb.generator.Constants.JSON_IMPORT;
-import static io.avaje.jsonb.generator.Constants.JSON_IMPORT_LIST;
-import static io.avaje.jsonb.generator.Constants.JSON_MIXIN;
+import static io.avaje.jsonb.generator.Constants.*;
 import static io.avaje.jsonb.generator.ProcessingContext.addImportedPrism;
 import static io.avaje.jsonb.generator.ProcessingContext.createMetaInfWriterFor;
+import static io.avaje.jsonb.generator.ValuePrism.*;
 import static java.util.stream.Collectors.joining;
 
 import java.io.IOException;
@@ -116,6 +114,7 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
     }
     APContext.setProjectModuleElement(annotations, round);
     readModule();
+
     getElements(round, ValuePrism.PRISM_TYPE).ifPresent(this::writeValueAdapters);
     getElements(round, JSON).ifPresent(this::writeAdapters);
     getElements(round, JSON_MIXIN).ifPresent(this::writeAdaptersForMixInTypes);

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

@@ -10,13 +10,10 @@
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.net.URI;
-import java.nio.file.Paths;
 import java.util.*;
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
-import javax.lang.model.type.TypeMirror;
 import javax.tools.FileObject;
 import javax.tools.StandardLocation;
 

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

@@ -1,27 +1,43 @@
 package io.avaje.jsonb.generator;
 
-import java.util.Optional;
-
-import javax.lang.model.element.Element;
-
 import com.fasterxml.jackson.annotation.JsonProperty;
-
+import com.google.gson.annotations.SerializedName;
 import io.avaje.jsonb.Json.Property;
 import io.avaje.prism.GeneratePrism;
+import jakarta.json.bind.annotation.JsonbProperty;
 
+import javax.lang.model.element.Element;
+import java.util.Optional;
+
+@GeneratePrism(
+  value = Property.class,
+  name = "AvajePropertyPrism",
+  superInterfaces = PropertyPrism.class)
 @GeneratePrism(
-    value = Property.class,
-    name = "AvajePropertyPrism",
-    superInterfaces = PropertyPrism.class)
+  value = JsonProperty.class,
+  name = "JacksonPropertyPrism",
+  superInterfaces = PropertyPrism.class)
 @GeneratePrism(
-    value = JsonProperty.class,
-    name = "JacksonPropertyPrism",
-    superInterfaces = PropertyPrism.class)
+  value = SerializedName.class,
+  name = "GsonPropertyPrism",
+  superInterfaces = PropertyPrism.class)
+@GeneratePrism(
+  value = JsonbProperty.class,
+  name = "JakartaPropertyPrism",
+  superInterfaces = PropertyPrism.class)
 public interface PropertyPrism {
 
   static boolean isPresent(Element element) {
-
-    return AvajePropertyPrism.isPresent(element) || JacksonPropertyPrism.isPresent(element);
+    return AvajePropertyPrism.isPresent(element)
+      || (JacksonPropertyPrism.isPresent(element) && JacksonPropertyPrism.getOptionalOn(element)
+            .map(JacksonPropertyPrism::value)
+            .map(String::isEmpty)
+            .isEmpty())
+      || GsonPropertyPrism.isPresent(element)
+      || (JakartaPropertyPrism.isPresent(element) && JakartaPropertyPrism.getOptionalOn(element)
+            .map(JakartaPropertyPrism::value)
+            .map(String::isEmpty)
+            .isEmpty());
   }
 
   static PropertyPrism getInstanceOn(Element element) {
@@ -31,7 +47,9 @@ static PropertyPrism getInstanceOn(Element element) {
   static Optional<PropertyPrism> getOptionalOn(Element element) {
     return Optional.<PropertyPrism>empty()
         .or(() -> AvajePropertyPrism.getOptionalOn(element))
-        .or(() -> JacksonPropertyPrism.getOptionalOn(element));
+        .or(() -> JacksonPropertyPrism.getOptionalOn(element))
+        .or(() -> GsonPropertyPrism.getOptionalOn(element))
+        .or(() -> JakartaPropertyPrism.getOptionalOn(element));
   }
 
   String value();