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

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

Конфигурация XML

Начнем с метода XML. Нам нужен файл XML с описанием конфигурации AOP. Определим специальные теги для правил AOP.

<?xml version="1.0" encoding="UTF-8" ?> 
<aopConfig>
 <aopAspect id="LoggingAspect" >
  <aopPointcut expression="execution[*.*]" >
   <aopBefore ref-class="LoggingAspect" method="startLog"/>
   <aopAfter ref-class="LoggingAspect" method="endLog"/>
  </aopPointcut>
 </aopAspect>
 <aopAspect id="ProfilingAspect" >
  <aopPointcut expression="execution[*.*]" >
   <aopBefore ref-class="ProfilingAspect" method="startProfiling"/>
   <aopAfter ref-class="ProfilingAspect" method="endProfiling"/>
  </aopPointcut>
 </aopAspect>
</aopConfig>

Каждая библиотека AOP имеет свои собственные теги. Мы определяем тег <aopAspect> для каждого типа советов и тег <aopPointcut> для уменьшения количества точек соединения для соответствия определенным критериям. В теге <aopPointcut> используется атрибут для хранения выражения сравнения.

Для советов "До" и "После возврата" определяем еще два тега. Когда метод соответствует критериям точки соединения, он будет вызывать методы класса Aspect с помощью значения атрибута ref-class.

В выше приведенном коде выражение [*.*] означает совет, который будет выполняться для всех методов и контроллеров. Если нужно использовать совет для всех методов удаления, то выражение примет вид [*.delete*]. Если нужно использовать совет для определенных типов контроллера, то выражение примет вид [*Service.*]. Можно определять любую пользовательскую структуру классов и методов.

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

<?php
class AOPCodeigniter
{
    private $CI;

    public function __construct()
        $this->CI = &get_instance();
    }

    public function  applyBeforeAspects() {
        $uriSegments = $this->CI->uri->segment_array();

        $controller = $uriSegments[1];
        $function = $uriSegments[2];

        $doc = new DOMDocument();
        $doc->load("aop.xml");

        $aopAspects = $doc->getElementsByTagName("aopPointcut");

        foreach ($aopAspects as $aspect) {
            $expr = $aspect->getAttribute("expression");
            preg_match('/\[(.*?)\]/s', $expr, $match);
            if (isset($match[1])) {
                $exprComponents = explode(".", $match[1]);
                $controllerExpr = "/^" . str_replace("*", "[a-zA-Z0-9]+", $exprComponents[0]) . "$/";
                $functionExpr = "/^" . str_replace("*", "[a-zA-Z0-9]+", $exprComponents[1]) . "$/";

            	preg_match($controllerExpr, $controller, $controllerMatch);
            	preg_match($functionExpr, $function, $functionMatch);

            	if (count($controllerMatch) > 0 && count($functionMatch) > 0) {
                    $beforeAspects = $aspect->getElementsByTagName("aopBefore");

                    foreach ($beforeAspects as $beforeAspect) {
                        $refClass = $beforeAspect->getAttribute("ref-class");
                        $refMethod = $beforeAspect->getAttribute("method");

                        $classObject = new $refClass();
                        $classObject->$refMethod();
                    }
                }
            }
        }
    }
}

Весь код для совета "До" реализован в классе методе applyBeforeAspects().

Изначально мы получаем сегмент URI с помощью класса CodeIgniter URI. Первый параметр является контроллером, а второй - именем метода для текущего запроса. Затем загружаем конфигурацию AOP с помощью DOMDocument() и получаем срез с помощью тега <aopPointcut>.

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

Затем мы определяем соответствие имени контроллера и метода. Если оба параметра соответствуют регулярному выражению, то нужно применить совет. Так как мы рассматриваем совет "До", то используем тег <aopBefore> в текущей точке. При обработке каждого тега мы применяем совет, вызывая метод, указанный в атрибуте ref-class.

Здесь приведена основа функционала AOP на CodeIgniter. Такой же процесс используется для других типов советов.

Наш класс LoggingAspect иметь следующий вид:

<?php
class LoggingAspect
{
	function startLog() {
		echo "Started Logging";
	}

	function endLog(){
	}
}

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

Конфигурация на основе комментариев

При использовании данного метода нам не нужен файл конфигурации XML.  Вместо этого, все советы располагаются внутри классов аспектов. Определяются комментарии в соответствии с предопределенной структурой, а затем можно манипулировать комментариями с помощью классов Reflection API для применения совета.

<?php
/**
 * 
 * @Aspect
 */
class LoggingAspect
{
    /**
     * @Before:execution[*.*]
     *
     */
    function startLog() {
        echo "Started Logging";
    }

    /**
     * @After:execution[*.*]
     *
     */
    function endLog() {
    }
}

Класс LoggingAspect в данном примере использует комментарий @Aspect. В ходе выполнения библиотека AOP находит классы аспектов и определяет советы, соответствующие определенным точкам.  Советы "До" и "После возврата" определяются с помощью директив @Before и @After с указанием параметров выполнения.

Рассмотрим реализацию функции applyBeforeAspects() при данном подходе:

<?php
public function applyBeforeAspects() {
    $uriSegments = $this->CI->uri->segment_array();

    $controller = $uriSegments[1];
    $function = $uriSegments[2];

    $aspectClasses = array("LoggingAspect");

    foreach ($aspectClasses as $aspectClass) {
        $ref = new ReflectionClass($aspectClass);
        $methods = $ref->getMethods();

        foreach ($methods as $method) {

            $methodName = $method->name;
            $methodClass = $method->class;
            $reflectionMethod = new ReflectionMethod($methodClass, $methodName);
            $refMethodComment = $reflectionMethod->getDocComment();

            preg_match('/\@Before:execution\[(.*?)\]/s', $refMethodComment, $match);

            if (isset($match[1])) {
                $exprComponents = explode(".", $match[1]);

                $controllerExpr = "/^" . str_replace("*", "[a-zA-Z0-9]+", $exprComponents[0]) . "$/";
                $functionExpr = "/^" . str_replace("*", "[a-zA-Z0-9]+", $exprComponents[1]) . "$/";

                preg_match($controllerExpr, $controller, $controllerMatch);
                preg_match($functionExpr, $function, $functionMatch);

                if (count($controllerMatch) > 0 && count($functionMatch) > 0) {
                    $classObject = new $methodClass();
                    $classObject->$methodName();
                }
            }
        }
    }
}

В нашем примере класс аспекта "жестко" встроен в массив для упрощения. В идеале все классы аспектов извлекаются в ходе выполнения библиотекой AOP.

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

Заключение

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