Merge pull request msgpack#293 from msgpack/issue_292

xerial · xerial · commit 5e989d93a86f · 2015-11-16T23:12:07.000-08:00
Avoid to flush an extra buffer when the string isn't too large in Mes…
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePack.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePack.java
@@ -50,6 +50,7 @@ public static class Config
         private final int stringEncoderBufferSize;
         private final int stringDecoderBufferSize;
         private final int packerBufferSize;
+        private final int packerSmallStringOptimizationThreshold; // This parameter is subject to change
         private final int packerRawDataCopyingThreshold;
 
         public Config(
@@ -61,6 +62,7 @@ public Config(
                 int stringEncoderBufferSize,
                 int stringDecoderBufferSize,
                 int packerBufferSize,
+                int packerSmallStringOptimizationThreshold,
                 int packerRawDataCopyingThreshold)
         {
             checkArgument(packerBufferSize > 0, "packer buffer size must be larger than 0: " + packerBufferSize);
@@ -75,6 +77,7 @@ public Config(
             this.stringEncoderBufferSize = stringEncoderBufferSize;
             this.stringDecoderBufferSize = stringDecoderBufferSize;
             this.packerBufferSize = packerBufferSize;
+            this.packerSmallStringOptimizationThreshold = packerSmallStringOptimizationThreshold;
             this.packerRawDataCopyingThreshold = packerRawDataCopyingThreshold;
         }
 
@@ -133,6 +136,11 @@ public int getPackerBufferSize()
             return packerBufferSize;
         }
 
+        public int getPackerSmallStringOptimizationThreshold()
+        {
+            return packerSmallStringOptimizationThreshold;
+        }
+
         public int getPackerRawDataCopyingThreshold()
         {
             return packerRawDataCopyingThreshold;
@@ -154,6 +162,7 @@ public static class ConfigBuilder
         private int stringEncoderBufferSize = 8192;
         private int stringDecoderBufferSize = 8192;
         private int packerBufferSize = 8192;
+        private int packerSmallStringOptimizationThreshold = 512; // This parameter is subject to change
         private int packerRawDataCopyingThreshold = 512;
 
         public Config build()
@@ -167,6 +176,7 @@ public Config build()
                     stringEncoderBufferSize,
                     stringDecoderBufferSize,
                     packerBufferSize,
+                    packerSmallStringOptimizationThreshold,
                     packerRawDataCopyingThreshold
             );
         }
@@ -219,6 +229,12 @@ public ConfigBuilder packerBufferSize(int size)
             return this;
         }
 
+        public ConfigBuilder packerSmallStringOptimizationThreshold(int threshold)
+        {
+            this.packerSmallStringOptimizationThreshold = threshold;
+            return this;
+        }
+
         public ConfigBuilder packerRawDataCopyingThreshold(int threshold)
         {
             this.packerRawDataCopyingThreshold = threshold;
diff --git a/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java b/msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java
@@ -442,6 +442,14 @@ public MessagePacker packDouble(double v)
         return this;
     }
 
+    private void packSmallString(String s)
+            throws IOException
+    {
+        byte[] bytes = s.getBytes(MessagePack.UTF8);
+        packRawStringHeader(bytes.length);
+        writePayload(bytes);
+    }
+
     /**
      * Pack the input String in UTF-8 encoding
      *
@@ -457,6 +465,12 @@ public MessagePacker packString(String s)
             return this;
         }
 
+        if (s.length() < config.getPackerSmallStringOptimizationThreshold()) {
+            // Write the length and payload of small string to the buffer so that it avoids an extra flush of buffer
+            packSmallString(s);
+            return this;
+        }
+
         CharBuffer in = CharBuffer.wrap(s);
         prepareEncoder();
 
diff --git a/msgpack-core/src/test/scala/org/msgpack/core/MessagePackerTest.scala b/msgpack-core/src/test/scala/org/msgpack/core/MessagePackerTest.scala
@@ -235,6 +235,32 @@ class MessagePackerTest
       up1.hasNext shouldBe false
       up1.close
     }
+
+    "pack a lot of String within expected time" in {
+      val count = 20000
+
+      def measureDuration(outputStream: java.io.OutputStream) = {
+        val packer = MessagePack.newDefaultPacker(outputStream)
+        var i = 0
+        while (i < count) {
+          packer.packString("0123456789ABCDEF")
+          i +=  1
+        }
+        packer.close
+      }
+
+      val t = time("packString into OutputStream", repeat = 10) {
+        block("byte-array-output-stream") {
+          measureDuration(new ByteArrayOutputStream())
+        }
+
+        block("file-output-stream") {
+          val (_, fileOutput) = createTempFileWithOutputStream
+          measureDuration(fileOutput)
+        }
+      }
+      t("file-output-stream").averageWithoutMinMax shouldBe < (t("byte-array-output-stream").averageWithoutMinMax * 4)
+    }
   }
 
   "compute totalWrittenBytes" in {
