Рубрики
Uncategorized

Класс shmop для работы с общей памятью PHP и простой тест на использование (код)

Автор оригинала: David Wong.

Simple SHM-это небольшой уровень абстракции для использования PHP для управления общей памятью, который поддерживает простое управление сегментами памяти объектно-ориентированным способом. При написании небольших приложений, использующих общую память для хранения, эта библиотека помогает создавать очень сжатый код. Для этого есть три способа: чтение, запись и удаление. Простое создание экземпляра объекта из этого класса может управлять открытым сегментом общей памяти.

Объект класса и тестовый код

php
// Class object
namespace Simple\SHM;

class Block
{
    /**
     * Holds the system id for the shared memory block
     *
     * @var int
     * @access protected
     */
    protected $id;

    /**
     * Holds the shared memory block id returned by shmop_open
     *
     * @var int
     * @access protected
     */
    protected $shmid;

    /**
     * Holds the default permission (octal) that will be used in created memory blocks
     *
     * @var int
     * @access protected
     */
    protected $perms = 0644;

    /**
     * Shared memory block instantiation
     *
     * In the constructor we'll check if the block we're going to manipulate
     * already exists or needs to be created. If it exists, let's open it.
     *
     * @access public
     * @param string $id (optional) ID of the shared memory block you want to manipulate
     */
    public function __construct($id = null)
    {
        if($id === null) {
            $this->id = $this->generateID();
        } else {
            $this->id = $id;
        }

        if($this->exists($this->id)) {
            $this->shmid = shmop_open($this->id, "w", 0, 0);
        }
    }

    /**
     * Generates a random ID for a shared memory block
     *
     * @access protected
     * @return int System V IPC key generated from pathname and a project identifier
     */
    protected function generateID()
    {
        $id = ftok(__FILE__, "b");
        return $id;
    }

    /**
     * Checks if a shared memory block with the provided id exists or not
     *
     * In order to check for shared memory existance, we have to open it with
     * reading access. If it doesn't exist, warnings will be cast, therefore we
     * suppress those with the @ operator.
     *
     * @access public
     * @param string $id ID of the shared memory block you want to check
     * @return boolean True if the block exists, false if it doesn't
     */
    public function exists($id)
    {
        $status = @shmop_open($id, "a", 0, 0);
        return $status;
    }

    /**
     * Writes on a shared memory block
     *
     * First we check for the block existance, and if it doesn't, we'll create it. Now, if the
     * block already exists, we need to delete it and create it again with a new byte allocation that
     * matches the size of the data that we want to write there. We mark for deletion,  close the semaphore
     * and create it again.
     *
     * @access public
     * @param string $data The data that you wan't to write into the shared memory block
     */
    public function write($data)
    {
        $size = mb_strlen($data, 'UTF-8');

        if($this->exists($this->id)) {
            shmop_delete($this->shmid);
            shmop_close($this->shmid);
            $this->shmid = shmop_open($this->id, "c", $this->perms, $size);
            shmop_write($this->shmid, $data, 0);
        } else {
            $this->shmid = shmop_open($this->id, "c", $this->perms, $size);
            shmop_write($this->shmid, $data, 0);
        }
    }

    /**
     * Reads from a shared memory block
     *
     * @access public
     * @return string The data read from the shared memory block
     */
    public function read()
    {
        $size = shmop_size($this->shmid);
        $data = shmop_read($this->shmid, 0, $size);

        return $data;
    }

    /**
     * Mark a shared memory block for deletion
     *
     * @access public
     */
    public function delete()
    {
        shmop_delete($this->shmid);
    }

    /**
     * Gets the current shared memory block id
     *
     * @access public
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Gets the current shared memory block permissions
     *
     * @access public
     */
    public function getPermissions()
    {
        return $this->perms;
    }

    /**
     * Sets the default permission (octal) that will be used in created memory blocks
     *
     * @access public
     * @param string $perms Permissions, in octal form
     */
    public function setPermissions($perms)
    {
        $this->perms = $perms;
    }

    /**
     * Closes the shared memory block and stops manipulation
     *
     * @access public
     */
    public function __destruct()
    {
        shmop_close($this->shmid);
    }
}
assertInstanceOf('Simple\SHM\Block', $memory);

        $memory->write('Sample');
        $data = $memory->read();
        $this->assertEquals('Sample', $data);
    }

    public function testIsCreatingNewBlockWithId()
    {
        $memory = new Block(897);
        $this->assertInstanceOf('Simple\SHM\Block', $memory);
        $this->assertEquals(897, $memory->getId());

        $memory->write('Sample 2');
        $data = $memory->read();
        $this->assertEquals('Sample 2', $data);
    }

    public function testIsMarkingBlockForDeletion()
    {
        $memory = new Block(897);
        $memory->delete();
        $data = $memory->read();
        $this->assertEquals('Sample 2', $data);
    }

    public function testIsPersistingNewBlockWithoutId()
    {
        $memory = new Block;
        $this->assertInstanceOf('Simple\SHM\Block', $memory);
        $memory->write('Sample 3');
        unset($memory);

        $memory = new Block;
        $data = $memory->read();
        $this->assertEquals('Sample 3', $data);
    }
}

Дополнительные примечания

write('Sample');
echo $memory->read();
 
?>

Обратите внимание, что в приведенном выше коде для этого класса не передается идентификатор. Если идентификатор не передается, он случайным образом выбирает номер и открывает новый сегмент памяти для этого номера. Мы можем передать число в качестве параметра конструктору, чтобы открыть существующий сегмент памяти, или создать сегмент памяти с определенным идентификатором, следующим образом

write('Sample');
echo $new->read();
 
?>

Волшебный метод _destructor отвечает за вызов shmop_close в сегменте памяти для отмены объекта настройки, чтобы отделить его от сегмента памяти. Мы называем это “Простой SHM 101”. Теперь давайте используем этот метод для более продвинутой цели: использования общей памяти в качестве хранилища. Хранение наборов данных требует сериализации, поскольку массивы или объекты не могут храниться в памяти. Хотя здесь для сериализации используется JSON, достаточно любого другого метода (например, XML или встроенных возможностей сериализации PHP). следующим образом

 'John',
    'password' => '123456',
    'posts' => array('My name is John', 'My name is not John')
);
 
$data = json_encode($results);
 
$memory = new SimpleSHM;
$memory->write($data);
$storedarray = json_decode($memory->read());
 
print_r($storedarray);
 
?>

Мы успешно сериализуем массив в строку JSON, сохраняем его в блоке общей памяти, считываем из него данные, десериализуем строку JSON и отображаем сохраненный массив. Это может показаться простым, но представьте себе возможности этого фрагмента кода. Вы можете использовать его для хранения результатов запросов веб-служб, запросов к базе данных или даже кэша ядра шаблонов. Чтение и запись в память обеспечат более высокую производительность, чем чтение и запись на диск.

Использование этой технологии хранения полезно не только для кэширования, но и для обмена данными между приложениями, если данные хранятся в формате, удобном для чтения с обоих концов. Не стоит недооценивать возможности общей памяти в веб-приложениях. Существует множество различных способов гениальной реализации этого хранилища, единственным ограничением являются творческие способности и навыки разработчиков.