[Из песочницы] Слабые ссылки в PHP 715.01.2016 12:33

Но это будет только после PHP 7.0.2, а нам нужно чтобы и на более ранних версиях PHP 7 работало глобально и надежно.

Не очень красивым, но весьма рабочим способом является… подмена функции spl_object_hash () собственной реализацией:

function_table['spl_object_hash'];

$custom_hash_function = function (object $obj) {
    $hash = null;

    if (weak\refcounted($obj)) {
        $referent = execute_referent_object_metadata($obj);
        $obj->handlers = $referent->original_handlers;
        $hash = $spl_hash_function($obj);
        $obj->handlers = $referent->custom_handlers;
    }

    if (null == $hash) {
        $hash = $spl_hash_function($obj);
    }

    return $hash;
};

$EG->function_table['spl_object_hash'] = $custom_hash_function;

Автором данного метода подмены является Etienne Kneuss, автор изначальной реализации слабых ссылок в PHP 5 в виде расширения php-weakref. К сожалению, я не дождался буквально пару часов до того, как он также реализовал поддержку PHP 7. Тем не менее, два рабочих расширения лучше чем ни одного, да и на данный момент у нас довольно сильно различается функциональность и концепция.

Механизм уведомления об уничтожении объекта

При создании слабой ссылки нам довольно важен механизм уведомления о том, что объект на который мы ссылаемся был уничтожен. Концептуально данную проблему можно решить путем опрашивания самой слабой ссылки, путем сохранения слабой ссылки в некий массив, как это делается в реализации WeakReference в Java; и, что собственно представляет гастрономический интерес, вызов пользовательской функции, как это делается в реализации weakref.ref в языке Python.

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

В итоге наш деструктор-обертку можно представить в виде мета-кода:

run_original_dtor_obj($object);

foreach($weak_references as $weak_ref_object_handle => $weak_reference) {
    if (is_array($weak_reference->notifier)) {
        $weak_reference->notifier[] = $weak_reference;
    } elseif (is_callable($weak_reference->notifier) && $no_exception_thrown) {
        $weak_reference->notifier($weak_reference);
    }

    unset($weak_references[$weak_ref_object_handle]);
}

Сам же класс слабой ссылки имеет следующий вид:

namespace Weak;

class Reference
{
    /**
     * @param object                  $referent Объект на который ссылаемся
     * @param callable | array | null $notify   Механизм для уведомления об уничтожении отслеживаемого объекта 
     *
     * Если уведомитель это пользовательская функция, то она будет вызвана с данным объектом слабой ссылки.
     * Следует обратить внимание что в тот момент объекта на который мы ссылаемся уже будет уничтожен и недоступен.
     * Пользовательская функция не будет вызвана если деструктор отслеживаемого объекта или предыдущая
     * пользовательская функция-уведомитель бросили исключение.
     *
     * Если уведомитель это массив, то данный объект слабой ссылки будет добавлен его конец, причем,
     * вне зависимости от того, было ли брошено исключение деструктором отслеживаемого объекта либо
     * пользовательской функцией-уведомителем или нет.
     */
    public function __construct(object $referent, $notify = null)
    {
    }

    /**
     * Получить объект на который ссылаемся. Если объект был удален то вернется null.
     *
     * @return object | null
     */
    public function get()
    {
    }

    /**
     * Проверить статус объекта на который мы ссылаемся: не уничтожен ли он еще.
     *
     * @return bool
     */
    public function valid() : bool
    {
    }

    /**
     * Получить уведомитель
     *
     * @param callable | array | null $notify Механизм уведомления. Если задан, заменит существующий.
     *
     * @return callable | array | null Текущий уведомитель или предыдущий, если функция была вызвана с новым уведомителем
     */
    public function notifier($notify = null)
    {
    }
}

Для получения дополнительной информации по значениям и объектам данное расширение предоставляет ряд функций, которые дополняют функциональность класса слабой ссылки и позволяют ни в чем себе не отказывать создавать различные решения уже на пользовательском уровне.

namespace Weak;

/**
 * Проверить, является ли значение переданного аргумента ссылочным или нет.
 *
 * @param mixed $value
 *
 * @return bool
 */
function refcounted(mixed $value) : bool {}

/**
 * Возвращает количество ссылок на значение переданного аргумента. Если значение не ссылочное то вернет 0.
 *
 * Данная функция не учитывает ссылку которая образуется вследствие передачи значения как аргумента функции, поэтому
 * вызов вида weak\refcount(new stdClass()) вернет 0, так как помимо переданного аргумента больше на это значение никто
 * не ссылается.
 *
 * @param mixed $value
 *
 * @return int
 */
function refcount(mixed $value) : int {}

/**
 * Проверить, есть ли слабые ссылки на данный объект или нет.
 *
 * @param object $value
 *
 * @return bool
 */
function weakrefcounted(object $value) : bool {}

/**
 * Получить количество слабых ссылок на объект. Если таковых нет то вернется 0.
 *
 * @param object $value
 *
 * @return int
 */
function weakrefcount(object $value) : int {}

/**
 * Получить массив слабых ссылок на объект. Если таковых нет то вернется пустой массив.
 *
 * @param object $value
 *
 * @return mixed
 */
function weakrefs(object $value) : array {}

/**
 * Получить значение дескриптора объекта.
 *
 * @param object $value
 *
 * @return int
 */
function object_handle(object $value) : int {}

Данное расширение предоставляющее описанную выше функциональность стало результатом работы над другим расширением — интеграции v8 JavaScript движка в PHP (не v8js, более простое и мощное, на данный момент исходный код публично не доступен).

При написании слоя абстракции по переводу php объектов в js объекты, возникла необходимость однозначно сопоставлять и, что самое главное, чистить таблицу соответствий php объектов и js представлений. Типовой проблемой стало то, что в разных местах возникает ситуация когда в js возвращается один и тот же php объект для которого уже имеется js представление, и для того чтобы внутри js представления тоже были идентичными, нужно хранить таблицу соответствий.

Первоначально составлялась таблица соответствия id php объекта и непосредственно js представления, но по мере работы складывалась ситуация когда образовывался переизбыток осиротевших js представлений: соответствующие им php объекты удалялись сборщиком мусора, так как на них никто не ссылался. Механизм уведомления который реализован вместе со слабыми ссылками позволят полностью решить данную проблему.

Для людей же не страдающих описанными выше симптомами и ведущими здоровый ночной образ жизни данное расширение может быть полезным для следующего:

• реализации кеширования объектов в рантайме.
• связывания данных с объектом, например, добавления свойств и методов в ситуациях когда наследование и/или композиция не очень подходят (привет, Java).
• удаление соответствующих event listenter’ов после того как будет удален объект.

Предлагаю в комментариях поделится возможными способами применения слабых ссылок в PHP.

Для собственных нужд была создана реализация WeakMap структуры данных на базе SplObjectStorage — Weak\SplObjectStorage

Расширение доступно по ссылке github.com/pinepain/php-weak и распространяется по лицензии MIT. Для работы требуется PHP 7.

© Habrahabr.ru