Merge pull request #118 from barryvdh/optimized

Codec to store UUID in an optimized way for InnoDB
2026-06-14 15:56:48 +03:00 · 2016-08-02 13:53:14 -04:00
parent 60d6bab90d 9112b2bd95
commit 2e674a1713
2 changed files with 182 additions and 0 deletions
@@ -0,0 +1,67 @@
+<?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
+ * @link https://benramsey.com/projects/ramsey-uuid/ Documentation
+ * @link https://packagist.org/packages/ramsey/uuid Packagist
+ * @link https://github.com/ramsey/uuid GitHub
+ */
+namespace Ramsey\Uuid\Codec;
+
+use InvalidArgumentException;
+use Ramsey\Uuid\UuidInterface;
+
+/**
+ * OrderedTimeCodec optimizes the bytes to increment UUIDs when time goes by, to improve database INSERTs.
+ * The string value will be unchanged from StringCodec. Only works for UUID type 1.
+ */
+class OrderedTimeCodec extends StringCodec
+{
+
+    /**
+     * Encodes a UuidInterface as an optimized binary representation of a UUID
+     *
+     * @param UuidInterface $uuid
+     * @return string Binary string representation of a UUID
+     */
+    public function encodeBinary(UuidInterface $uuid)
+    {
+        $fields = $uuid->getFieldsHex();
+
+        $optimized = [
+            $fields['time_hi_and_version'],
+            $fields['time_mid'],
+            $fields['time_low'],
+            $fields['clock_seq_hi_and_reserved'],
+            $fields['clock_seq_low'],
+            $fields['node'],
+        ];
+
+        return hex2bin(implode('', $optimized));
+    }
+
+    /**
+     * Decodes an optimized binary representation of a UUID into a UuidInterface object instance
+     *
+     * @param string $bytes
+     * @return UuidInterface
+     */
+    public function decodeBytes($bytes)
+    {
+        if (strlen($bytes) !== 16) {
+            throw new InvalidArgumentException('$bytes string should contain 16 characters.');
+        }
+
+        $hex = unpack('H*', $bytes)[1];
+
+        // Rearrange the fields to their original order
+        $hex = substr($hex, 8, 4) . substr($hex, 12, 4) . substr($hex, 4, 4) . substr($hex, 0, 4) . substr($hex, 16);
+
+        return $this->decode($hex);
+    }
+}
@@ -0,0 +1,115 @@
+<?php
+
+namespace Ramsey\Uuid\Test\Codec;
+
+use Ramsey\Uuid\Builder\UuidBuilderInterface;
+use Ramsey\Uuid\Codec\OrderedTimeCodec;
+use Ramsey\Uuid\Test\TestCase;
+use Ramsey\Uuid\UuidInterface;
+
+/**
+ * Class OrderedTimeCodecTest
+ * @package Ramsey\Uuid\Test\Codec
+ * @covers Ramsey\Uuid\Codec\OrderedTimeCodec
+ */
+class OrderedTimeCodecTest extends TestCase
+{
+
+    /** @var UuidBuilderInterface */
+    private $builder;
+    /** @var UuidInterface */
+    private $uuid;
+    /** @var array */
+    private $fields;
+    /** @var string */
+    private $uuidString = '58e0a7d7-eebc-11d8-9669-0800200c9a66';
+    /** @var string */
+    private $optimizedHex = '11d8eebc58e0a7d796690800200c9a66';
+
+    public function setUp()
+    {
+        parent::setUp();
+        $this->builder = $this->getMock('Ramsey\Uuid\Builder\UuidBuilderInterface');
+        $this->uuid = $this->getMock('Ramsey\Uuid\UuidInterface');
+        $this->fields = ['time_low' => '58e0a7d7',
+            'time_mid' => 'eebc',
+            'time_hi_and_version' => '11d8',
+            'clock_seq_hi_and_reserved' => '96',
+            'clock_seq_low' => '69',
+            'node' => '0800200c9a66'];
+    }
+
+    public function tearDown()
+    {
+        parent::tearDown();
+        $this->builder = null;
+        $this->uuid = null;
+        $this->fields = null;
+    }
+
+    public function testEncodeUsesFieldsArray()
+    {
+        $this->uuid->expects($this->once())
+            ->method('getFieldsHex')
+            ->willReturn($this->fields);
+        $codec = new OrderedTimeCodec($this->builder);
+        $codec->encode($this->uuid);
+    }
+
+    public function testEncodeReturnsFormattedString()
+    {
+        $this->uuid->method('getFieldsHex')
+            ->willReturn($this->fields);
+        $codec = new OrderedTimeCodec($this->builder);
+        $result = $codec->encode($this->uuid);
+        $this->assertEquals($this->uuidString, $result);
+    }
+
+    public function testEncodeBinaryUsesFieldsHex()
+    {
+        $this->uuid->expects($this->once())
+            ->method('getFieldsHex')
+            ->willReturn($this->fields);
+        $codec = new OrderedTimeCodec($this->builder);
+        $codec->encodeBinary($this->uuid);
+    }
+
+    public function testEncodeBinaryReturnsBinaryString()
+    {
+        $expected = hex2bin($this->optimizedHex);
+        $this->uuid->method('getFieldsHex')
+            ->willReturn($this->fields);
+        $codec = new OrderedTimeCodec($this->builder);
+        $result = $codec->encodeBinary($this->uuid);
+        $this->assertEquals($expected, $result);
+    }
+
+    public function testDecodeBytesThrowsExceptionWhenBytesStringNotSixteenCharacters()
+    {
+        $string = '61';
+        $bytes = pack('H*', $string);
+        $codec = new OrderedTimeCodec($this->builder);
+        $this->setExpectedException('InvalidArgumentException', '$bytes string should contain 16 characters.');
+        $codec->decodeBytes($bytes);
+    }
+
+    public function testDecodeReturnsUuidFromBuilder()
+    {
+        $string = 'uuid:58e0a7d7-eebc-11d8-9669-0800200c9a66';
+        $this->builder->method('build')
+            ->willReturn($this->uuid);
+        $codec = new OrderedTimeCodec($this->builder);
+        $result = $codec->decode($string);
+        $this->assertEquals($this->uuid, $result);
+    }
+
+    public function testDecodeBytesRearrangesFields()
+    {
+        $bytes = pack('H*', $this->optimizedHex);
+        $codec = new OrderedTimeCodec($this->builder);
+        $this->builder->method('build')->with($this->anything(), $this->equalTo($this->fields))
+            ->willReturn($this->uuid);
+        $result = $codec->decodeBytes($bytes);
+        $this->assertEquals($this->uuid, $result);
+    }
+}