Spring. AOP в действии

Предположим, что вы хорошо проявили себя с предыдущим заданием. И теперь заказчики пришли к вам с новым заданием. В этом задании, менестрель  (поэт-музыкант из средневековья, сопровождавший рыцарей и воспевавших их действия) должен сопровождать каждого рыцаря, воспевая все его поступки и действия в песнях. Хм... менестрель, который поет о рыцаре? Ничего сложного. Создадим класс Minstrel:

package com.springinaction.chapter01.knight; import org.apache.log4j.Logger; public class Minstrel { private static final Logger SONG = Logger.getLogger(Minstrel.class); public void singBefore(Knight knight) { SONG.info("Fa la la; Sir " + knight.getName() + " is so brave!"); } public void singAfter(Knight knight) { SONG.info("Tee-hee-he; Sir " + knight.getName() + " did embark on a quest!"); } }

Для поддержания стиля мышления dependency injection, мы изменяем класс KnightOfTheRoundTable для получения объекта Minstrel:

public class KnightOfTheRoundTable implements Knight { … private Minstrel minstrel; public void setMinstrel(Minstrel minstrel) { this.minstrel = minstrel; } … public HolyGrail embarkOnQuest() throws QuestFailedException { minstrel.singBefore(this); HolyGrail grail = quest.embark(); minstrel.singAfter(this); return grail; } }

Все должно работать. Хотя стоп... есть небольшая проблемка. Каждый рыцарь должен остановиться и сказать менестрелю, чтобы тот пел песню перед тем, как рыцарь сможет продолжить свой квест. Затем, после квеста, рыцарь должен помнить о том, чтобы сказать менестрелю, чтобы тот продолжил петь. Сам факт того, что рыцарь должен помнить о том, чтобы остановиться и сказать менестрелю что делать, отвлекает рыцаря. 

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

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

Создание аспекта

Существует несколько методов реализации аспектов в Spring. Для данного примера будем использовать новое пространство имен AOP, представленное в Spring 2.0.  Для того, чтобы начать, необходимо убедиться, что мы объявили пространство имен в контексте XML:

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/beans <a href="http://www.springframework.org/schema/beans/spring-beans-2.0.xsd" title="http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">http://www.springframework.org/schema/beans/spring-beans-2.0.xsd <a href="http://www.springframework.org/schema/aop" title="http://www.springframework.org/schema/aop">http://www.springframework.org/schema/aop</a> http://www.springframework.org/schema/aop/spring-aop-2.0.xsd"> … </beans>

где ключевые строки: 

http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd">

Используя объявленное пространство имен, мы готовы создавать аспект. Следующий кусок XML объявляет менестрель как бин в контексте спринга, а затем создает аспект, который обслуживает бин рыцаря.

Объявление бина менестреля

<bean id="minstrel" class="com.springinaction.chapter01.knight.Minstrel"></bean>

Создание аспекта менестреля

<aop:config> <aop:aspect ref="minstrel"></aop:aspect></aop:config>

Создание набора точек входа для обертки embarkOnQuest():

<aop:pointcut id="questPointcut" expression="execution(* *.embarkOnQuest(..)) ➥and target(bean)" ></aop:pointcut id="questpointcut" expression="execution(*>

Пение менестреля до:

<aop:before method="singBefore" pointcut-ref="questPointcut" arg-names="bean" ></aop:before method="singbefore" pointcut-ref="questpointcut" arg-names="bean">

Пение менестреля после:

<aop:after-returning method="singAfter" pointcut-ref="questPointcut" arg-names="bean" ></aop:after-returning method="singafter" pointcut-ref="questpointcut" arg-names="bean">

В предыдущем листинге произошло очень многое, поэтому рассмотрим происходящее подробнее:

• Первое - это объявление <bean>, создание бина менестреля в спринге. Это класс Minstrel. У него нет никаких зависимостей, поэтому нет необходимости внедрения его с чем-либо.
• Следущий нюанс - элемент <aop:config>. Этот элемент показывает, что мы планируем сделать что-то с AOP. Большинство элементов конфигурации AOP должны быть помещены в <aop:config>.
• Внутри <aop:config> мы имеем элемент <aop:aspect>. Этот элемент показывает, что мы объявляем аспект.  Функционал аспекта определен в бине, который ссылается атрибутом ref. В таком случае, бин minstrel, который является Minstrel, предоставляет функционал аспекта.
• Аспект сделан из точек входа (это места, в которые будет применена функциональность аспектов) и advice (как применять функционал).  Элемент <aop:pointcut> определяет набор точек входа, которые затрагиваются выполнением метода embarkOnQuest().
• Ну и наконец, рассмотрим AOP advice. Элемент <aop:before> объявляет, что метод singBefore() класса Minstrel должен быть вызван до pointcut., в то время как <aop:after> определяет, что метод singAfter() класса Minstrel должен быть вызван после pointcut. Набор точек входа в обоих случаях - ссылка на questPointcut, который представляет собой выполнение embarkOnQuest().