Add BufferRecyclerProvider configuration (#1083)

Author: cowtowncoder

src/main/java/com/fasterxml/jackson/core/JsonFactory.java

@@ -20,6 +20,7 @@
 import com.fasterxml.jackson.core.sym.ByteQuadsCanonicalizer;
 import com.fasterxml.jackson.core.sym.CharsToNameCanonicalizer;
 import com.fasterxml.jackson.core.util.BufferRecycler;
+import com.fasterxml.jackson.core.util.BufferRecyclerProvider;
 import com.fasterxml.jackson.core.util.BufferRecyclers;
 import com.fasterxml.jackson.core.util.JacksonFeature;
 import com.fasterxml.jackson.core.util.JsonGeneratorDecorator;
@@ -260,6 +261,11 @@ public static int collectDefaults() {
     /**********************************************************
      */
 
+    /**
+     * @since 2.16
+     */
+    protected BufferRecyclerProvider _bufferRecyclerProvider;
+
     /**
      * Object that implements conversion functionality between
      * Java objects and JSON content. For base JsonFactory implementation
@@ -364,6 +370,7 @@ public static int collectDefaults() {
     public JsonFactory() { this((ObjectCodec) null); }
 
     public JsonFactory(ObjectCodec oc) {
+        _bufferRecyclerProvider = BufferRecyclers.defaultProvider();
         _objectCodec = oc;
         _quoteChar = DEFAULT_QUOTE_CHAR;
         _streamReadConstraints = StreamReadConstraints.defaults();
@@ -382,6 +389,7 @@ public JsonFactory(ObjectCodec oc) {
      */
     protected JsonFactory(JsonFactory src, ObjectCodec codec)
     {
+        _bufferRecyclerProvider = src._bufferRecyclerProvider;
         _objectCodec = codec;
 
         // General
@@ -410,6 +418,7 @@ protected JsonFactory(JsonFactory src, ObjectCodec codec)
      * @since 2.10
      */
     public JsonFactory(JsonFactoryBuilder b) {
+        _bufferRecyclerProvider = b._bufferRecyclerProvider;
         _objectCodec = null;
 
         // General
@@ -439,6 +448,7 @@ public JsonFactory(JsonFactoryBuilder b) {
      * @param bogus Argument only needed to separate constructor signature; ignored
      */
     protected JsonFactory(TSFBuilder<?,?> b, boolean bogus) {
+        _bufferRecyclerProvider = b._bufferRecyclerProvider;
         _objectCodec = null;
 
         _factoryFeatures = b._factoryFeatures;
@@ -1131,6 +1141,11 @@ public String getRootValueSeparator() {
     /**********************************************************
      */
 
+    public JsonFactory setBufferRecyclerProvider(BufferRecyclerProvider p) {
+        _bufferRecyclerProvider = Objects.requireNonNull(p);
+        return this;
+    }
+
     /**
      * Method for associating a {@link ObjectCodec} (typically
      * a <code>com.fasterxml.jackson.databind.ObjectMapper</code>)
@@ -2126,10 +2141,10 @@ public BufferRecycler _getBufferRecycler()
         // 23-Apr-2015, tatu: Let's allow disabling of buffer recycling
         //   scheme, for cases where it is considered harmful (possibly
         //   on Android, for example)
-        if (Feature.USE_THREAD_LOCAL_FOR_BUFFER_RECYCLING.enabledIn(_factoryFeatures)) {
-            return BufferRecyclers.getBufferRecycler();
+        if (!Feature.USE_THREAD_LOCAL_FOR_BUFFER_RECYCLING.enabledIn(_factoryFeatures)) {
+            return new BufferRecycler();
         }
-        return new BufferRecycler();
+        return _bufferRecyclerProvider.acquireBufferRecycler(this);
     }
 
     /**

src/main/java/com/fasterxml/jackson/core/TSFBuilder.java

@@ -8,6 +8,8 @@
 import com.fasterxml.jackson.core.io.OutputDecorator;
 import com.fasterxml.jackson.core.json.JsonReadFeature;
 import com.fasterxml.jackson.core.json.JsonWriteFeature;
+import com.fasterxml.jackson.core.util.BufferRecyclerProvider;
+import com.fasterxml.jackson.core.util.BufferRecyclers;
 import com.fasterxml.jackson.core.util.JsonGeneratorDecorator;
 
 /**
@@ -70,6 +72,11 @@ public abstract class TSFBuilder<F extends JsonFactory,
     /**********************************************************************
      */
 
+    /**
+     * @since 2.16
+     */
+    protected BufferRecyclerProvider _bufferRecyclerProvider;
+
     /**
      * Optional helper object that may decorate input sources, to do
      * additional processing on input during parsing.
@@ -108,7 +115,7 @@ public abstract class TSFBuilder<F extends JsonFactory,
      */
     protected List<JsonGeneratorDecorator> _generatorDecorators;
 
-
+    /*
     /**********************************************************************
     /* Construction
     /**********************************************************************
@@ -135,6 +142,8 @@ protected TSFBuilder(JsonFactory base)
     protected TSFBuilder(int factoryFeatures,
             int parserFeatures, int generatorFeatures)
     {
+        _bufferRecyclerProvider = BufferRecyclers.defaultProvider();
+
         _factoryFeatures = factoryFeatures;
         _streamReadFeatures = parserFeatures;
         _streamWriteFeatures = generatorFeatures;
@@ -161,6 +170,10 @@ protected static <T> List<T> _copy(List<T> src) {
     public int streamReadFeatures() { return _streamReadFeatures; }
     public int streamWriteFeatures() { return _streamWriteFeatures; }
 
+    public BufferRecyclerProvider bufferRecyclerProvider() {
+        return _bufferRecyclerProvider;
+    }
+
     public InputDecorator inputDecorator() { return _inputDecorator; }
     public OutputDecorator outputDecorator() { return _outputDecorator; }
 
@@ -300,6 +313,20 @@ public B configure(JsonWriteFeature f, boolean state) {
         return _failNonJSON(f);
     }
 
+    // // // Other configuration, helper objects
+
+    /**
+     * @param p BufferRecyclerProvider to use for buffer allocation
+     *
+     * @return this builder (for call chaining)
+     *
+     * @since 2.16
+     */
+    public B bufferRecyclerProvider(BufferRecyclerProvider p) {
+        _bufferRecyclerProvider = Objects.requireNonNull(p);
+        return _this();
+    }
+
     // // // Other configuration, decorators
 
     public B inputDecorator(InputDecorator dec) {

src/main/java/com/fasterxml/jackson/core/base/ParserBase.java

@@ -6,7 +6,6 @@
 import java.util.Arrays;
 
 import com.fasterxml.jackson.core.*;
-import com.fasterxml.jackson.core.exc.StreamConstraintsException;
 import com.fasterxml.jackson.core.io.IOContext;
 import com.fasterxml.jackson.core.io.ContentReference;
 import com.fasterxml.jackson.core.io.NumberInput;

src/main/java/com/fasterxml/jackson/core/json/UTF8DataInputJsonParser.java

@@ -1,7 +1,6 @@
 package com.fasterxml.jackson.core.json;
 
 import java.io.*;
-import java.util.Arrays;
 
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.base.ParserBase;

src/main/java/com/fasterxml/jackson/core/util/BufferRecyclerProvider.java

@@ -0,0 +1,15 @@
+package com.fasterxml.jackson.core.util;
+
+import com.fasterxml.jackson.core.TokenStreamFactory;
+
+/**
+ * Provider for {@link BufferRecycler}s to allow pluggable and optional
+ * recycling of underlying input/output buffers.
+ *
+ * @since 2.16
+ */
+public interface BufferRecyclerProvider
+    extends java.io.Serializable
+{
+    public abstract BufferRecycler acquireBufferRecycler(TokenStreamFactory forFactory);
+}

src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java

@@ -2,6 +2,7 @@
 
 import java.lang.ref.SoftReference;
 
+import com.fasterxml.jackson.core.TokenStreamFactory;
 import com.fasterxml.jackson.core.io.JsonStringEncoder;
 
 /**
@@ -61,7 +62,11 @@ public class BufferRecyclers
      * Main accessor to call for accessing possibly recycled {@link BufferRecycler} instance.
      *
      * @return {@link BufferRecycler} to use
+     *
+     * @deprecated Since 2.16 should use {@link BufferRecyclerProvider} abstraction instead
+     *   of calling static methods of this class
      */
+    @Deprecated // since 2.16
     public static BufferRecycler getBufferRecycler()
     {
         SoftReference<BufferRecycler> ref = _recyclerRef.get();
@@ -180,4 +185,33 @@ public static void quoteAsJsonText(CharSequence input, StringBuilder output) {
     public static byte[] quoteAsJsonUTF8(String rawText) {
         return JsonStringEncoder.getInstance().quoteAsUTF8(rawText);
     }
+
+    /*
+    /**********************************************************************
+    /* Default BufferRecyclerProvider implementations
+    /**********************************************************************
+     */
+
+    public static BufferRecyclerProvider defaultProvider() {
+        return ThreadLocalBufferRecyclerProvider.INSTANCE;
+    }
+
+    /**
+     * Default {@link BufferRecyclerProvider} implementation that uses
+     * {@link ThreadLocal} for recycling instances.
+     *
+     * @since 2.16
+     */
+    public static class ThreadLocalBufferRecyclerProvider
+        implements BufferRecyclerProvider
+    {
+        private static final long serialVersionUID = 1L;
+
+        public final static ThreadLocalBufferRecyclerProvider INSTANCE = new ThreadLocalBufferRecyclerProvider();
+
+        @Override
+        public BufferRecycler acquireBufferRecycler(TokenStreamFactory forFactory) {
+            return getBufferRecycler();
+        }
+    }
 }