Moshi.Builder.addLast() (#1233)

This is mostly useful for KotlinJsonAdapterFactory.
2025-10-20 00:19:21 +08:00 · 2020-09-21 09:36:55 -04:00
parent 517ea36fe5
commit 0a78ed4cb1
5 changed files with 374 additions and 52 deletions
--- a/moshi/src/main/java/com/squareup/moshi/Moshi.java
+++ b/moshi/src/main/java/com/squareup/moshi/Moshi.java
@@ -55,6 +55,7 @@ public final class Moshi {
  }

  private final List<JsonAdapter.Factory> factories;
+  private final int lastOffset;
  private final ThreadLocal<LookupChain> lookupChainThreadLocal = new ThreadLocal<>();
  private final Map<Object, JsonAdapter<?>> adapterCache = new LinkedHashMap<>();

@@ -64,6 +65,7 @@ public final class Moshi {
    factories.addAll(builder.factories);
    factories.addAll(BUILT_IN_FACTORIES);
    this.factories = Collections.unmodifiableList(factories);
+    this.lastOffset = builder.lastOffset;
  }

  /** Returns a JSON adapter for {@code type}, creating it if necessary. */
@@ -181,10 +183,14 @@ public final class Moshi {
  /** Returns a new builder containing all custom factories used by the current instance. */
  @CheckReturnValue
  public Moshi.Builder newBuilder() {
-    int fullSize = factories.size();
-    int tailSize = BUILT_IN_FACTORIES.size();
-    List<JsonAdapter.Factory> customFactories = factories.subList(0, fullSize - tailSize);
-    return new Builder().addAll(customFactories);
+    Builder result = new Builder();
+    for (int i = 0, limit = lastOffset; i < limit; i++) {
+      result.add(factories.get(i));
+    }
+    for (int i = lastOffset, limit = factories.size() - BUILT_IN_FACTORIES.size(); i < limit; i++) {
+      result.addLast(factories.get(i));
+    }
+    return result;
  }

  /** Returns an opaque object that's equal if the type and annotations are equal. */
@@ -195,55 +201,20 @@ public final class Moshi {

  public static final class Builder {
    final List<JsonAdapter.Factory> factories = new ArrayList<>();
+    int lastOffset = 0;

-    public <T> Builder add(final Type type, final JsonAdapter<T> jsonAdapter) {
-      if (type == null) throw new IllegalArgumentException("type == null");
-      if (jsonAdapter == null) throw new IllegalArgumentException("jsonAdapter == null");
-
-      return add(
-          new JsonAdapter.Factory() {
-            @Override
-            public @Nullable JsonAdapter<?> create(
-                Type targetType, Set<? extends Annotation> annotations, Moshi moshi) {
-              return annotations.isEmpty() && Util.typesMatch(type, targetType)
-                  ? jsonAdapter
-                  : null;
-            }
-          });
+    public <T> Builder add(Type type, JsonAdapter<T> jsonAdapter) {
+      return add(newAdapterFactory(type, jsonAdapter));
    }

    public <T> Builder add(
-        final Type type,
-        final Class<? extends Annotation> annotation,
-        final JsonAdapter<T> jsonAdapter) {
-      if (type == null) throw new IllegalArgumentException("type == null");
-      if (annotation == null) throw new IllegalArgumentException("annotation == null");
-      if (jsonAdapter == null) throw new IllegalArgumentException("jsonAdapter == null");
-      if (!annotation.isAnnotationPresent(JsonQualifier.class)) {
-        throw new IllegalArgumentException(annotation + " does not have @JsonQualifier");
-      }
-      if (annotation.getDeclaredMethods().length > 0) {
-        throw new IllegalArgumentException("Use JsonAdapter.Factory for annotations with elements");
-      }
-
-      return add(
-          new JsonAdapter.Factory() {
-            @Override
-            public @Nullable JsonAdapter<?> create(
-                Type targetType, Set<? extends Annotation> annotations, Moshi moshi) {
-              if (Util.typesMatch(type, targetType)
-                  && annotations.size() == 1
-                  && Util.isAnnotationPresent(annotations, annotation)) {
-                return jsonAdapter;
-              }
-              return null;
-            }
-          });
+        Type type, Class<? extends Annotation> annotation, JsonAdapter<T> jsonAdapter) {
+      return add(newAdapterFactory(type, annotation, jsonAdapter));
    }

    public Builder add(JsonAdapter.Factory factory) {
      if (factory == null) throw new IllegalArgumentException("factory == null");
-      factories.add(factory);
+      factories.add(lastOffset++, factory);
      return this;
    }

@@ -252,17 +223,74 @@ public final class Moshi {
      return add(AdapterMethodsFactory.get(adapter));
    }

-    Builder addAll(List<JsonAdapter.Factory> factories) {
-      this.factories.addAll(factories);
+    public <T> Builder addLast(Type type, JsonAdapter<T> jsonAdapter) {
+      return addLast(newAdapterFactory(type, jsonAdapter));
+    }
+
+    public <T> Builder addLast(
+        Type type, Class<? extends Annotation> annotation, JsonAdapter<T> jsonAdapter) {
+      return addLast(newAdapterFactory(type, annotation, jsonAdapter));
+    }
+
+    public Builder addLast(JsonAdapter.Factory factory) {
+      if (factory == null) throw new IllegalArgumentException("factory == null");
+      factories.add(factory);
      return this;
    }

+    public Builder addLast(Object adapter) {
+      if (adapter == null) throw new IllegalArgumentException("adapter == null");
+      return addLast(AdapterMethodsFactory.get(adapter));
+    }
+
    @CheckReturnValue
    public Moshi build() {
      return new Moshi(this);
    }
  }

+  static <T> JsonAdapter.Factory newAdapterFactory(
+      final Type type, final JsonAdapter<T> jsonAdapter) {
+    if (type == null) throw new IllegalArgumentException("type == null");
+    if (jsonAdapter == null) throw new IllegalArgumentException("jsonAdapter == null");
+
+    return new JsonAdapter.Factory() {
+      @Override
+      public @Nullable JsonAdapter<?> create(
+          Type targetType, Set<? extends Annotation> annotations, Moshi moshi) {
+        return annotations.isEmpty() && Util.typesMatch(type, targetType) ? jsonAdapter : null;
+      }
+    };
+  }
+
+  static <T> JsonAdapter.Factory newAdapterFactory(
+      final Type type,
+      final Class<? extends Annotation> annotation,
+      final JsonAdapter<T> jsonAdapter) {
+    if (type == null) throw new IllegalArgumentException("type == null");
+    if (annotation == null) throw new IllegalArgumentException("annotation == null");
+    if (jsonAdapter == null) throw new IllegalArgumentException("jsonAdapter == null");
+    if (!annotation.isAnnotationPresent(JsonQualifier.class)) {
+      throw new IllegalArgumentException(annotation + " does not have @JsonQualifier");
+    }
+    if (annotation.getDeclaredMethods().length > 0) {
+      throw new IllegalArgumentException("Use JsonAdapter.Factory for annotations with elements");
+    }
+
+    return new JsonAdapter.Factory() {
+      @Override
+      public @Nullable JsonAdapter<?> create(
+          Type targetType, Set<? extends Annotation> annotations, Moshi moshi) {
+        if (Util.typesMatch(type, targetType)
+            && annotations.size() == 1
+            && Util.isAnnotationPresent(annotations, annotation)) {
+          return jsonAdapter;
+        }
+        return null;
+      }
+    };
+  }
+
  /**
   * A possibly-reentrant chain of lookups for JSON adapters.
   *
--- a/moshi/src/test/java/com/squareup/moshi/MoshiTest.java
+++ b/moshi/src/test/java/com/squareup/moshi/MoshiTest.java
@@ -1269,6 +1269,68 @@ public final class MoshiTest {
    assertThat(adapter.fromJson(json)).isEqualTo(new Pizza(5, true));
  }

+  @Test
+  public void precedence() throws Exception {
+    Moshi moshi =
+        new Moshi.Builder()
+            .add(new AppendingAdapterFactory(" a"))
+            .addLast(new AppendingAdapterFactory(" y"))
+            .add(new AppendingAdapterFactory(" b"))
+            .addLast(new AppendingAdapterFactory(" z"))
+            .build();
+    JsonAdapter<String> adapter = moshi.adapter(String.class).lenient();
+    assertThat(adapter.toJson("hello")).isEqualTo("\"hello a b y z\"");
+  }
+
+  @Test
+  public void precedenceWithNewBuilder() throws Exception {
+    Moshi moshi1 =
+        new Moshi.Builder()
+            .add(new AppendingAdapterFactory(" a"))
+            .addLast(new AppendingAdapterFactory(" w"))
+            .add(new AppendingAdapterFactory(" b"))
+            .addLast(new AppendingAdapterFactory(" x"))
+            .build();
+    Moshi moshi2 =
+        moshi1
+            .newBuilder()
+            .add(new AppendingAdapterFactory(" c"))
+            .addLast(new AppendingAdapterFactory(" y"))
+            .add(new AppendingAdapterFactory(" d"))
+            .addLast(new AppendingAdapterFactory(" z"))
+            .build();
+
+    JsonAdapter<String> adapter = moshi2.adapter(String.class).lenient();
+    assertThat(adapter.toJson("hello")).isEqualTo("\"hello a b c d w x y z\"");
+  }
+
+  /** Adds a suffix to a string before emitting it. */
+  static final class AppendingAdapterFactory implements JsonAdapter.Factory {
+    private final String suffix;
+
+    AppendingAdapterFactory(String suffix) {
+      this.suffix = suffix;
+    }
+
+    @Override
+    public JsonAdapter<?> create(Type type, Set<? extends Annotation> annotations, Moshi moshi) {
+      if (type != String.class) return null;
+
+      final JsonAdapter<String> delegate = moshi.nextAdapter(this, type, annotations);
+      return new JsonAdapter<String>() {
+        @Override
+        public String fromJson(JsonReader reader) throws IOException {
+          throw new AssertionError();
+        }
+
+        @Override
+        public void toJson(JsonWriter writer, String value) throws IOException {
+          delegate.toJson(writer, value + suffix);
+        }
+      };
+    }
+  }
+
  static class Pizza {
    final int diameter;
    final boolean extraCheese;