Аспектно-ориентированное программирование в CodeIgniter. Часть 1 из 3

Вы уже слышали о аспектно-ориентированном программировании  (AOP)? Данная концепция широко используется при разработке больших систем. Но при применении PHP  она редко встречается. Цикл из 3 статей представляет AOP для PHP разработчиков.

В первой части описывается концепция AOP. Во второй части показано практическое использование на примере создания структуры правил AOP. А третья часть представляет интегрирование функционала AOP с помощью CodeIgniter.

Что такое AOP?

При разработке приложений часто встречается функционал, который нужно использовать в нескольких точках кода и никак не связанный с бизнес логикой приложения. Проверка регистрации пользователя перед выполнением операций является хорошим примером таких функций. Подобные задачи называются связанной областью функциональности (cross-cutting concerns).

Wikipedia приводит такое определение связанной области функциональности:

В информационных технологиях связная область функциональности является такими аспектами программы, которые влияют на другие части. Такой функционал не может быть выделен в чистом виде из системы ни в сфере дизайна, ни в реализации. В результате получается либо рассеивание (повторение кода), либо запутывание (существенное взаимное влияние между подсистемами), либо оба варианта сразу.

Рассмотрим как может выглядеть связанная область функциональности в коде.

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

<?php
class BlogPost extends CI_Controller
{
    public function createPost() {
        if (!Authentication::checkAuthentication()) {
            // Перенаправленные на регистрацию 
        }
        else {
            // Операция
            Messages::notifyAdmin();
        }
    }

    public function approvePost() {
        if (!Authentication::checkAuthentication()) {
            // Перенаправленные на регистрацию 

        }
        else {
            // Операция
        }
    }

    public function editPost() {
        if (!Authentication::checkAuthentication()) {
            // Перенаправленные на регистрацию 

        }
        else {
            // Операция
        }
    }

    public function viewPost() {
        // ...
    }
}

Посмотрите на приведенный код. Функция checkAuthentication() вызывается внутри каждого метода, который должен выполняться для зарегистрированного пользователя.  Метод notifyAdmin() вызывается для информирования администратора о создании новой записи. Класс BlogPost должен отвечать только за управление записями. Аутентификация и уведомления должны выполняться отдельно. Нарушается принцип единственной обязанности.

Принцип единственной обязанности гласит, что каждый класс должен иметь единственную обязанность, и она должна быть полностью инкапсулированна классом. Все его сервисы  должны четко соответствовать обязанности.

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

Терминология AOP

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

• Аспект
• Совет
• Точка соединения
• Срез

Что такое "аспект" объяснялось выше. Рассмотрим другие термины.

Совет

Функционал аспекта называется "совет". Как и следует из названия, "совет" определяет, что и когда делать в определенных ситуациях. В предыдущем примере проверка аутентификации (что) является советом, и она должна проводиться перед выполнением кода (когда) внутри определенных методов.

Точка соединения

Точка соединения является местом в приложении, где можно создавать совет. Посмотрим на наш пример. Вы можете обнаружить несколько мест, которые не связаны напрямую с логикой приложения. В методе createPost(), например, связанная область функциональности проявляется перед выполнением любой логики с проверкой аутентификации и при отправке сообщения администратору. Вот две возможные точки соединения.

Точки соединения можно определять где угодно в коде приложения, но применение совета доступно только в определенных точках в соответствии с библиотекой AOP (мы рассмотрим их позже).

Срез

Срез определяет соответствие совета определенным точкам соединения. Хотя в нашем примере имеется только пара точек соединения, в реальном приложении их может быть тысячи и применение совета не нужно во всех. В таких случаях мы можем определить набор точек соединения, который называется срезом, и использовать совет только для выбранных элементов.

Допустим, что мы хотим использовать совет в createPost(), approvePost(), и editPost(), но не в viewPost(). Нужно установить соответствие данных 3 методов и применить совет. Позже в уроке мы создадим файл XML с детальным описанием совета, который будет содержать регулярное выражение для определения среза.

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

Типы советов AOP

Есть несколько способов для "советования" нашего кода. Ранее упоминалось, что доступность советов зависит от типа используемой библиотеки AOP. Но несколько вариантов советов вы должны знать:

• Совет "До"
• Совет "После возврата"
• Совет "После выброса"
• Совет "Вокруг"

Совет "До"

Совет "До" выполняется перед определенной точкой в вашем коде, обычно, вызовом метода.

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

<?php
class PathController
{
    function controlPaths($className, $funcName) {
        Authentication::checkAuthentication();
        $classObj = new $className();
        $classObj->$funcName();
    }
}

Здесь создается простой класс для демонстрации.  Предположим, метод controlPaths() действует как глобальная точка входа для приложения, и каждый вызов метода проходит через него. В выше приведенном коде  мы применяем совет checkAuthentication() перед выполнением нужного метода. Здесь демонстрируется совет "До".

Совет "После возврата"

Данный совет выполняется как только определенный функционал полностью завершится и вернется в точку вызова. Рассмотрим следующий код:

<?php
class PathController
{
    function controlPaths($className, $funcName) {
        $classObj = new $className();
        $classObj->$funcName();
        Database::closeConnection();
    }
}

Здесь, как только метод завершается, мы чистим базу данных.

Совет "После выброса"

Если функция выбрасывает исключение в ходе выполнения процесса, выполняется совет "После выброса". Здесь используется данный тип совета для сообщения об ошибке:

<?php
class PathController
{
    function controlPaths($className, $funcName) {
        try {
            $classObj = new $className();
            $classObj->$funcName();
        }
        catch (Exception $e) {
            Error::reportError();
        }
    }
}

Совет "Вокруг"

Четвертый тип совета, который является комбинацией совета "До" и совета "После возврата".

<?php
class PathController
{
    function controlPaths($className, $funcName) {
        Logger::startLog();
        $classObj = new $className();
        $classObj->$funcName();
        Logger::endLog();
    }
}

Резюме

В данной статье представлена концепция AOP, ее сущность и терминология. В следующих уроках серии мы рассмотрим, где нужно использовать AOP и как ее встраивать в  CodeIgniter.