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

В предыдущей части серии уроков мы представили аспектно-ориентированное программирование (AOP) и его терминологию. Данный урок даст практические примеры использования AOP и поможет добавить его в приложение на PHP с использованием CodeIgniter.

Практика связанных областей функциональности

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

Журналирование событий

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

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

<?php
function addPost() {
    $log->writeToLog("Вход в addPost");
    // Логика приложения
    $log->writeToLog("выход из addPost");
}

С точки зрения AOP выше приведённая ситуация эквивалентна  советам "До" и "После возврата". Следовательно, совет "Вокруг" лучше подходит в данном случае.

Аутентификация и авторизация

Аутентификация - процесс идентификации пользователя в системе. Часто имя и пароль пользователя используются как основа аутентификации. Авторизация является процедурой предоставления доступа к определенным разделам системы. Аутентификация и авторизация требуется во многих приложениях.

<?php
function addPost() {
    $authentication->validateAuthentication($user);
    $authorization->validateAccess($user);
    // Логика приложения
}

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

Управление транзакциями

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

<?php
function addPost() {
    $tx->beginTransaction();
    try{
        // Логика приложения
        $tx->commit();
    }
    catch (Exception $e) {
        $tx->rollback();
    }
}

Мы совершаем операцию с данными, когда все функции успешно завершились, и выполняем откат, если произошла ошибка. В контексте AOP будут использоваться советы "До", "После возврата" и "После выброса". Советы "До" и "После возврата" являются типовыми для большинства библиотек AOP, а совет "После выброса" встречается в продвинутых вариантах.

Как работает AOP

AOP пока еще не имеет популярности в сообществе разработчиков PHP, но полноценное окружение AOP доступно, например, для JAVA. В контексте AOP есть класс ядра логики приложения и советы. Советы могут использоваться для классов ядра во время компиляции или в ходе выполнения приложения. Библиотека AspectJ использует AOP во время компиляции. Так как PHP является интерпретируемым языком программирования, то AOP будет использоваться в ходе выполнения приложения.

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

Существует два типа комбинирования советов и логики ядра: XML конфигурация и конфигурация на основе аннотаций.

В XML конфигурации все правила AOP для связанных областей функциональности описываются в XML файле.

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

Почему CodeIgniter

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

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

Используем крюки CodeIgniter

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

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

• pre_controller – вызывается непосредственно перед вызовом любого вашего контроллера;
• post_controller – вызывается непосредственно после завершения вашего контроллера.

Установим крюк для вызова пользовательского кода.

<?php
$hook["pre_controller"] = array(
    "class"    => "AOPCodeigniter", 
    "function" => "applyBeforeAspects", 
    "filename" => "AOPCodeigniter.php", 
    "filepath" => "hooks"
);

Поместите выше приведенный код в файл hooks.php в директории config. Затем создайте класс AOPCodeigniter в папке application/hooks. Теперь каждый раз при выполнении запроса, метод класса applyBeforeAspects() будет вызываться перед методом контроллера. Таким образом, мы комбинируем совет "До" с логикой ядра (в библиотеках AOP такие задачи выполняются с помощью класса прокси).

А следующий код реализует совет "После" в такой же манере:

<?php
$hook["post_controller"] = array(
    "class"    => "AOPCodeigniter", 
    "function" => "applyAfterAspects", 
    "filename" => "AOPCodeigniter.php", 
    "filepath" => "hooks"
);

Резюме

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