refactor: improve string encoding performance of non-lazy UUIDs

Author: ramsey

src/Codec/GuidStringCodec.php

@@ -18,6 +18,7 @@
 use Ramsey\Uuid\UuidInterface;
 
 use function bin2hex;
+use function sprintf;
 use function substr;
 
 /**
@@ -29,6 +30,26 @@
  */
 class GuidStringCodec extends StringCodec
 {
+    public function encode(UuidInterface $uuid): string
+    {
+        $hex = bin2hex($uuid->getFields()->getBytes());
+
+        /** @var non-empty-string */
+        return sprintf(
+            '%02s%02s%02s%02s-%02s%02s-%02s%02s-%04s-%012s',
+            substr($hex, 6, 2),
+            substr($hex, 4, 2),
+            substr($hex, 2, 2),
+            substr($hex, 0, 2),
+            substr($hex, 10, 2),
+            substr($hex, 8, 2),
+            substr($hex, 14, 2),
+            substr($hex, 12, 2),
+            substr($hex, 16, 4),
+            substr($hex, 20),
+        );
+    }
+
     public function decode(string $encodedUuid): UuidInterface
     {
         $bytes = $this->getBytes($encodedUuid);

src/Codec/StringCodec.php

@@ -17,12 +17,13 @@
 use Ramsey\Uuid\Builder\UuidBuilderInterface;
 use Ramsey\Uuid\Exception\InvalidArgumentException;
 use Ramsey\Uuid\Exception\InvalidUuidStringException;
-use Ramsey\Uuid\Rfc4122\FieldsInterface;
 use Ramsey\Uuid\Uuid;
 use Ramsey\Uuid\UuidInterface;
 
+use function bin2hex;
 use function hex2bin;
 use function implode;
+use function sprintf;
 use function str_replace;
 use function strlen;
 use function substr;
@@ -47,19 +48,17 @@ public function __construct(private UuidBuilderInterface $builder)
 
     public function encode(UuidInterface $uuid): string
     {
-        /** @var FieldsInterface $fields */
-        $fields = $uuid->getFields();
-
-        return $fields->getTimeLow()->toString()
-            . '-'
-            . $fields->getTimeMid()->toString()
-            . '-'
-            . $fields->getTimeHiAndVersion()->toString()
-            . '-'
-            . $fields->getClockSeqHiAndReserved()->toString()
-            . $fields->getClockSeqLow()->toString()
-            . '-'
-            . $fields->getNode()->toString();
+        $hex = bin2hex($uuid->getFields()->getBytes());
+
+        /** @var non-empty-string */
+        return sprintf(
+            '%08s-%04s-%04s-%04s-%012s',
+            substr($hex, 0, 8),
+            substr($hex, 8, 4),
+            substr($hex, 12, 4),
+            substr($hex, 16, 4),
+            substr($hex, 20),
+        );
     }
 
     /**

tests/benchmark/GuidConversionBench.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * This file is part of the ramsey/uuid library
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+
+declare(strict_types=1);
+
+namespace Ramsey\Uuid\Benchmark;
+
+use Ramsey\Uuid\FeatureSet;
+use Ramsey\Uuid\Guid\Guid;
+use Ramsey\Uuid\UuidFactory;
+use Ramsey\Uuid\UuidInterface;
+
+final class GuidConversionBench
+{
+    private const UUID_BYTES = [
+        "\x1e\x94\x42\x33\x98\x10\x41\x38\x96\x22\x56\xe1\xf9\x0c\x56\xed",
+    ];
+
+    private UuidInterface $uuid;
+
+    public function __construct()
+    {
+        $factory = new UuidFactory(new FeatureSet(useGuids: true));
+
+        $this->uuid = $factory->fromBytes(self::UUID_BYTES[0]);
+
+        assert($this->uuid instanceof Guid);
+    }
+
+    public function benchStringConversionOfGuid(): void
+    {
+        $this->uuid->toString();
+    }
+}

tests/benchmark/NonLazyUuidConversionBench.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * This file is part of the ramsey/uuid library
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+
+declare(strict_types=1);
+
+namespace Ramsey\Uuid\Benchmark;
+
+use Ramsey\Uuid\UuidFactory;
+use Ramsey\Uuid\UuidInterface;
+
+final class NonLazyUuidConversionBench
+{
+    private const UUID_BYTES = [
+        "\x1e\x94\x42\x33\x98\x10\x41\x38\x96\x22\x56\xe1\xf9\x0c\x56\xed",
+    ];
+
+    private UuidInterface $uuid;
+
+    public function __construct()
+    {
+        $factory = new UuidFactory();
+
+        $this->uuid = $factory->fromBytes(self::UUID_BYTES[0]);
+    }
+
+    public function benchStringConversionOfUuid(): void
+    {
+        $this->uuid->toString();
+    }
+}