Use Jackson instead of Gson

caseyscarborough · caseyscarborough · commit 4485214a7b2b · 2023-08-14T17:06:58.000-04:00
diff --git a/build.gradle b/build.gradle
@@ -13,7 +13,8 @@ repositories {
 
 dependencies {
     implementation 'org.slf4j:slf4j-api:2.0.7'
-    implementation 'com.google.code.gson:gson:2.9.1'
+    implementation 'com.fasterxml.jackson.core:jackson-core:2.15.2'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.15.2'
     implementation 'com.squareup.okhttp3:okhttp:4.11.0'
     testImplementation platform('org.junit:junit-bom:5.9.1')
     testImplementation 'org.junit.jupiter:junit-jupiter'
diff --git a/src/main/java/ankiconnect/AnkiConnect.java b/src/main/java/ankiconnect/AnkiConnect.java
@@ -1,13 +1,7 @@
 package ankiconnect;
 
-import ankiconnect.exception.AnkiConnectException;
-import ankiconnect.gson.GsonFactory;
-import ankiconnect.model.AnkiConnectRequest;
-import ankiconnect.model.AnkiConnectResponse;
-import ankiconnect.model.Card;
-import com.google.gson.Gson;
-import com.google.gson.JsonSyntaxException;
-import com.google.gson.reflect.TypeToken;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import lombok.extern.slf4j.Slf4j;
 import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
@@ -30,7 +24,7 @@ public class AnkiConnect {
     private final Integer bindPort;
     private final String apiKey;
     private final OkHttpClient client;
-    private final Gson gson;
+    private final ObjectMapper mapper;
 
     public AnkiConnect(String bindAddress, Integer bindPort) {
         this(bindAddress, bindPort, null);
@@ -41,48 +35,51 @@ public AnkiConnect(String bindAddress, Integer bindPort, String apiKey) {
         this.bindPort = bindPort;
         this.apiKey = apiKey;
         this.client = new OkHttpClient.Builder().readTimeout(60, TimeUnit.SECONDS).build();
-        this.gson = new GsonFactory().getInstance();
+        this.mapper = new ObjectMapper();
     }
 
     public List<Long> findCards(String query) {
         log.info("Finding cards in Anki with query: {}", query);
         Map<String, String> params = new HashMap<>();
         params.put("query", query);
-        return request("findCards", params, new TypeToken<AnkiConnectResponse<List<Long>>>() {});
+        return request("findCards", params, new TypeReference<AnkiConnectResponse<List<Long>>>() {});
     }
 
     public List<Card> cardsInfo(List<Long> ids) {
         log.info("Finding card info from Anki for ids: {}", ids);
         Map<String, List<Long>> params = new HashMap<>();
         params.put("cards", ids);
-        return request("cardsInfo", params, new TypeToken<AnkiConnectResponse<List<Card>>>() {});
+        return request("cardsInfo", params, new TypeReference<AnkiConnectResponse<List<Card>>>() {});
     }
 
-    private <P, R> R request(String action, Map<String, P> params, TypeToken<AnkiConnectResponse<R>> token) {
+    private <P, R> R request(String action, Map<String, P> params, TypeReference<AnkiConnectResponse<R>> token) {
         AnkiConnectRequest<P> body = new AnkiConnectRequest<>();
         body.setAction(action);
         body.setKey(apiKey);
         body.setVersion(VERSION);
         body.setParams(params);
 
-        Request request = new Request.Builder()
-            .url("http://" + bindAddress + ":" + bindPort)
-            .post(RequestBody.create(gson.toJson(body), MediaType.parse("application/json")))
-            .build();
-
-        try (Response response = client.newCall(request).execute()) {
+        Response response = null;
+        try {
+            Request request = new Request.Builder()
+                .url("http://" + bindAddress + ":" + bindPort)
+                .post(RequestBody.create(mapper.writeValueAsString(body), MediaType.parse("application/json")))
+                .build();
+            response = client.newCall(request).execute();
             if (response.body() == null) {
                 throw new AnkiConnectException("Response body was null");
             }
-            AnkiConnectResponse<R> output = gson.fromJson(response.body().string(), token.getType());
+            AnkiConnectResponse<R> output = mapper.readValue(response.body().string(), token);
             if (output.getError() != null) {
                 throw new AnkiConnectException("An error was returning from the AnkiConnect API: " + output.getError());
             }
             return output.getResult();
-        } catch (JsonSyntaxException e) {
-            throw new AnkiConnectException("The JSON body was not in the expected format", e);
         } catch (IOException e) {
             throw new AnkiConnectException("Could not make request to the AnkiConnect API", e);
+        } finally {
+            if (response != null) {
+                response.close();
+            }
         }
     }
 }
diff --git a/src/main/java/ankiconnect/AnkiConnectException.java b/src/main/java/ankiconnect/AnkiConnectException.java
@@ -1,4 +1,4 @@
-package ankiconnect.exception;
+package ankiconnect;
 
 public class AnkiConnectException extends RuntimeException {
 
diff --git a/src/main/java/ankiconnect/AnkiConnectRequest.java b/src/main/java/ankiconnect/AnkiConnectRequest.java
@@ -1,4 +1,4 @@
-package ankiconnect.model;
+package ankiconnect;
 
 import lombok.Getter;
 import lombok.Setter;
@@ -7,7 +7,7 @@
 
 @Getter
 @Setter
-public class AnkiConnectRequest<T> {
+class AnkiConnectRequest<T> {
 
     private String action;
     private int version;
diff --git a/src/main/java/ankiconnect/AnkiConnectResponse.java b/src/main/java/ankiconnect/AnkiConnectResponse.java
@@ -1,11 +1,11 @@
-package ankiconnect.model;
+package ankiconnect;
 
 import lombok.Getter;
 import lombok.Setter;
 
 @Getter
 @Setter
-public class AnkiConnectResponse<T> {
+class AnkiConnectResponse<T> {
     private T result;
     private String error;
 }
diff --git a/src/main/java/ankiconnect/Card.java b/src/main/java/ankiconnect/Card.java
@@ -1,6 +1,7 @@
-package ankiconnect.model;
+package ankiconnect;
 
-import com.google.gson.annotations.SerializedName;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import lombok.Getter;
 import lombok.Setter;
 
@@ -9,12 +10,11 @@
 @Getter
 @Setter
 public class Card {
-    private String modelName;
-    private String deckName;
-
-    @SerializedName("note")
+    @JsonProperty("note")
     private long noteId;
     private long cardId;
+    private String modelName;
+    private String deckName;
     private String question;
     private String answer;
     private String css;
@@ -27,7 +27,9 @@ public class Card {
     private int interval;
     private int factor;
     private int fieldOrder;
+    private Map<String, CardField> fields;
+    @JsonDeserialize(using = CardTypeDeserializer.class)
     private CardType type;
+    @JsonDeserialize(using = CardQueueDeserializer.class)
     private CardQueue queue;
-    private Map<String, CardField> fields;
 }
diff --git a/src/main/java/ankiconnect/CardField.java b/src/main/java/ankiconnect/CardField.java
@@ -0,0 +1,15 @@
+package ankiconnect;
+
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+public class CardField {
+    private String value;
+    private int order;
+
+    public String toString() {
+        return value;
+    }
+}
diff --git a/src/main/java/ankiconnect/CardQueue.java b/src/main/java/ankiconnect/CardQueue.java
@@ -1,4 +1,4 @@
-package ankiconnect.model;
+package ankiconnect;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
diff --git a/src/main/java/ankiconnect/CardQueueDeserializer.java b/src/main/java/ankiconnect/CardQueueDeserializer.java
@@ -0,0 +1,20 @@
+package ankiconnect;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+
+import java.io.IOException;
+import java.util.Arrays;
+
+class CardQueueDeserializer extends JsonDeserializer<CardQueue> {
+
+    @Override
+    public CardQueue deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
+        final int index = p.getIntValue();
+        return Arrays.stream(CardQueue.values())
+            .filter(queue -> queue.getIndex() == index)
+            .findFirst()
+            .orElse(null);
+    }
+}
diff --git a/src/main/java/ankiconnect/CardType.java b/src/main/java/ankiconnect/CardType.java
@@ -1,4 +1,4 @@
-package ankiconnect.model;
+package ankiconnect;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
diff --git a/src/main/java/ankiconnect/CardTypeDeserializer.java b/src/main/java/ankiconnect/CardTypeDeserializer.java
@@ -0,0 +1,17 @@
+package ankiconnect;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+
+import java.io.IOException;
+import java.util.Arrays;
+
+class CardTypeDeserializer extends JsonDeserializer<CardType> {
+
+    @Override
+    public CardType deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
+        final int index = p.getIntValue();
+        return Arrays.stream(CardType.values()).filter(type -> type.getIndex() == index).findFirst().orElse(null);
+    }
+}
diff --git a/src/main/java/ankiconnect/gson/CardQueueDeserializer.java b/src/main/java/ankiconnect/gson/CardQueueDeserializer.java
diff --git a/src/main/java/ankiconnect/gson/CardTypeDeserializer.java b/src/main/java/ankiconnect/gson/CardTypeDeserializer.java
diff --git a/src/main/java/ankiconnect/gson/GsonFactory.java b/src/main/java/ankiconnect/gson/GsonFactory.java
diff --git a/src/main/java/ankiconnect/model/CardField.java b/src/main/java/ankiconnect/model/CardField.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package ankiconnect.exception;`
	`1`	`+package ankiconnect;`
`2`	`2`
`3`	`3`	`public class AnkiConnectException extends RuntimeException {`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package ankiconnect.model;`
	`1`	`+package ankiconnect;`
`2`	`2`
`3`	`3`	`import lombok.Getter;`
`4`	`4`	`import lombok.RequiredArgsConstructor;`