Зв'язування під час завантаження за допомогою AspectJ до Spring

package foo
import org.springframework.context.support.ClassPathXmlApplicationContext
fun main() {
    val ctx = ClassPathXmlApplicationContext("beans.xml")
    val entitlementCalculationService = ctx.getBean("entitlementCalculationService") as EntitlementCalculationService
    // профільований аспект "оплітає" виконання цього методу
    entitlementCalculationService.calculateEntitlement()
            } 

Нам залишилося зробити лише одне. У вступі до цього розділу говорилося, що за допомогою Spring можна включати механізм LTW вибірково на основі кожного класу завантажувача, і це дійсно так. Однак у цьому прикладі ми використовуємо Java-агент (наданий разом зі Spring) для включення механізму LTW. Ми використовуємо наступну команду для запуску класу Main, показаного раніше:

java-javaagent:C:/projects/foo/lib/global/spring-instrument.jar foo.Main

Прапор -javaagent — це прапор для завдання та активації агентів для інструментування програм, що виконуються на JVM. У складі Spring Framework є такий агент, InstrumentationSavingAgent, упакований у spring-instrument.jar, який був наданий як значення аргументу -javaagent у попередньому прикладі.

Результат виконання програми Main виглядає приблизно так, як показано в наступному прикладі. (Я ввів інструкцію Thread.sleep(..) до реалізації calculateEntitlement(), щоб профілювальник фактично зафіксував якесь значення, крім 0 мілісекунд (01234 мілісекунди не є затримкою, що вводиться АОП). У наступному лістингу показаний результат, який ми отримали під час запуску нашого профілювача:

Calculating entitlement
StopWatch 'ProfilingAspect': running time (millis) = 1234
------ ----- ----------------------------
ms     %     Task name
------ ----- ----------------------------
01234  100%  calculateEntitlement

Оскільки цей механізм LTW здійснюється за допомогою повнофункціонального AspectJ, ми не обмежені лише постачанням порадами бінів Spring. Наступна невелика варіація на тему програми Main дає той самий результат:

package foo;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public final class Main {
    public static void main(String[] args) {
        new ClassPathXmlApplicationContext("beans.xml", Main.class);
        EntitlementCalculationService entitlementCalculationService =
                new StubEntitlementCalculationService();
        // профільований аспект "оплетатиме" виконання цього методу
        entitlementCalculationService.calculateEntitlement();
    }
}

package foo
import org.springframework.context.support.ClassPathXmlApplicationContext
fun main(args: Array<String>) {
    ClassPathXmlApplicationContext("beans.xml")
    val entitlementCalculationService = StubEntitlementCalculationService()
    // профільований аспект "оплетатиме" виконання цього методу
    entitlementCalculationService.calculateEntitlement()
}

Зверни увагу, що в попередній програмі ми завантажуємо контейнер Spring, а потім створюємо новий екземпляр StubEntitlementCalculationService зовсім поза контекстом Spring. Поради, що профільуються, все одно зв'язуються.

Звісно, приклад є спрощеним. Однак, основи підтримки механізму LTW в Spring були представлені в попередньому прикладі, і в іншій частині цього розділу докладно описаний сенс кожного біта конфігурації та застосування.

Аспекти

Аспекти, які ти використовуєш в LTW, повинні бути аспектами AspectJ. Ти можеш писати їх на мові AspectJ, або писати свої аспекти в стилі @AspectJ. Тоді твої аспекти будуть одночасно допустимими аспектами і AspectJ, і Spring AOP. Крім того, скомпільовані класи аспектів повинні бути доступні в шляху класів.

'META-INF/aop.xml'

Інфраструктура AspectJ LTW конфігурується за допомогою одного або декількох файлів META-INF/aop.xml, які знаходяться в шляху класів Java (або безпосередньо, або, що більш типово, в jar-файлах).

Структура та зміст цього файлу докладно описані в частині довідкової документації AspectJ, присвяченої LTW. Оскільки файл aop.xml на 100% написаний на AspectJ, ми не описуватимемо його тут.

Необхідні бібліотеки (JARS)

Для використання підтримки механізму LTW з AspectJ у Spring Framework тобі знадобляться, як мінімум, наступні бібліотеки:

• spring-aop.jar

• aspectjweaver.jar

Якщо ти використовуєш агент для активації інструментування, що надається Spring, тобі також знадобиться:

• spring-instrument.jar

Конфігурування Spring

Ключовим компонентом підтримки механізму LTW у Spring є інтерфейс LoadTimeWeaver (у пакеті org.springframework.instrument.classloading) та численні його реалізації, що поставляються з дистрибутивом Spring. LoadTimeWeaver відповідає за додавання одного або кількох java.lang.instrument.ClassFileTransformers до ClassLoader під час виконання, що відчиняє двері для всіляких цікавих режимів застосування, одним з яких є зв'язування аспектів під час завантаження.

Конфігурування LoadTimeWeaver для конкретного ApplicationContext може зводитися до додавання одного рядка. (Зверни увагу, що тобі майже напевно потрібно буде використовувати ApplicationContext як контейнер Spring — зазвичай BeanFactory недостатньо, оскільки підтримка механізму LTW використовує BeanFactoryPostProcessors).

Щоб активувати підтримку механізму LTW у Spring Framework, необхідно налаштувати LoadTimeWeaver, що зазвичай робиться за допомогою анотації @EnableLoadTimeWeaving, як показано нижче:

@Configuration
@EnableLoadTimeWeaving
public class AppConfig {
}

@Configuration
@EnableLoadTimeWeaving
class AppConfig {
}

Як варіант, якщо ти надаєш перевагу конфігурації на основі XML, використовуй елемент <context:load-time-weaver/>. Зверни увагу, що елемент визначено у просторі імен context. У цьому прикладі показано, як використовувати <context:load-time-weaver/>:

<?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:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd">
    <context:load-time-weaver/>
</beans>

Попередня конфігурація автоматично визначає та реєструє для тебе низку інфраструктурних бінів, специфічних для LTW, таких як LoadTimeWeaver та AspectJWeavingEnabler. За замовчуванням LoadTimeWeaver — це клас DefaultContextLoadTimeWeaver, який намагається доповнити автоматично виявлений LoadTimeWeaver. Точний тип LoadTimeWeaver, який буде "визначений автоматично", залежить від твого середовища виконання. У наступній таблиці наведено різні реалізації LoadTimeWeaver:

Зверни увагу, що в таблиці перераховані лише ті LoadTimeWeaver, які автоматично визначаються під час використання DefaultContextLoadTimeWeaver. Ти можеш точно встановити, яку реалізацію LoadTimeWeaver використовувати.

Щоб вказати конкретний LoadTimeWeaver за допомогою Java-конфігурації, реалізуй інтерфейс LoadTimeWeavingConfigurer та перевизнач метод getLoadTimeWeaver(). У наступному прикладі вказано ReflectiveLoadTimeWeaver:

@Configuration
@EnableLoadTimeWeaving
public class AppConfig implements LoadTimeWeavingConfigurer {
    @Override
    public LoadTimeWeaver getLoadTimeWeaver() {
        return new ReflectiveLoadTimeWeaver();
    }
}

@Configuration
@EnableLoadTimeWeaving
class AppConfig : LoadTimeWeavingConfigurer {
    override fun getLoadTimeWeaver(): LoadTimeWeaver {
        return ReflectiveLoadTimeWeaver()
    }
}

Якщо ти використовуєш конфігурацію на основі XML, то можеш вказати повне ім'я класу як значення атрибуту weaver-class в елементі <context:load-time-weaver/>. Знову ж таки, у наступному прикладі вказано ReflectiveLoadTimeWeaver:

<?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:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd">
    <context:load-time-weaver
            weaver-class="org.springframework.instrument.classloading.ReflectiveLoadTimeWeaver"/>
</beans>

LoadTimeWeaver, який визначено та зареєстровано конфігурацією, може бути пізніше отриманий з контейнера Spring за допомогою загальновідомого імені loadTimeWeaver. Пам'ятай, що LoadTimeWeaver існує лише як механізм для інфраструктури LTW у Spring, який дозволяє додати один або кілька ClassFileTransformers. Фактичний ClassFileTransformer, який виконує LTW, — це клас ClassPreProcessorAgentAdapter (з пакета org.aspectj.weaver.loadtime). Більш детальну інформацію можна знайти в javadoc класу ClassPreProcessorAgentAdapter, оскільки специфіка того, як відбувається зв'язування, виходить за межі цього документа.

Залишилося розглянути останній атрибут конфігурації: атрибут aspectjWeaving (або aspectj-weaving, якщо ти використовуєш XML). Цей атрибут контролює, чи активовано механізм LTW чи ні. Він приймає одне з трьох можливих значень, при цьому значенням за замовчуванням є autodetect, якщо атрибут відсутній. У наступній таблиці наведено три можливі значення:

Конфігурування для конкретного середовища

Цей останній розділ містить усі додаткові параметри та конфігурації, необхідні під час використання підтримки LTW з Spring у таких середовищах, як сервери програм та вебконтейнери.

Tomcat, JBoss, WebSphere, WebLogic

Tomcat, JBoss/WildFly, IBM WebSphere Application Server та Oracle WebLogic Server — всі вони надають загальний ClassLoader для програм, здатних здійснювати локальне інструментування. Рідний LTW із Spring може використовувати ці реалізації ClassLoader для забезпечення зв'язування з AspectJ. Ти можеш просто активувати зв'язування під час завантаження. Зокрема, не потрібно змінювати сценарій запуску JVM, щоб додати -javaagent:path/to/spring-instrument.jar.

Зверни увагу, що у випадку з JBoss може бути потрібно відключити сканування сервера програм, щоб він не завантажував класи до того, як програма фактично запуститься. Швидким обхідним рішенням є додавання до твого артефакту файлу з ім'ям WEB-INF/jboss-scanning.xml з таким вмістом:

<scanning xmlns="urn:jboss:scanning:1.0"/>

Універсальне використання Java

Якщо потрібно провести інструментування класів у середовищах, які не підтримуються конкретними реалізаціями LoadTimeWeaver, загальним рішенням є агент JVM. Для таких випадків у Spring є InstrumentationLoadTimeWeaver, який вимагає наявності специфічного для Spring (але вкрай універсального) агента JVM, spring-instrument.jar, що автоматично визначається загальними налаштуваннями @ EnableLoadTimeWeaving та <context:load-time-weaver/>.

Щоб використовувати його, тобі потрібно запустити віртуальну машину з агентом зі Spring, вказавши наступні параметри для JVM:

-javaagent:/path/to/spring-instrument .jar

Зверни увагу, що для цього потрібно змінити скрипт запуску JVM, що може завадити використовувати його в середовищах сервера програм (залежно від твого сервера та політик експлуатації). Тим не менш, у сценаріях розгортання додатків, таких як автономні програми Spring Boot, за схемою "одна програма на одну JVM" тобі зазвичай доводиться контролювати налаштування JVM цілком у будь-якому випадку.

Додаткові ресурси

Детальнішу інформацію про AspectJ можна знайти на вебсайті AspectJ.

Eclipse AspectJ за авторством Адріана Кольє та ін. (Addison-Wesley, 2005) містить вичерпний вступ та посібник з мови AspectJ.

Рекомендуємо друге видання AspectJ в дії за авторством Рамніваса Ладдада (Manning, 2009). Основну увагу в книзі приділено AspectJ, але багато загальних тем АОП теж досліджено досить глибоко.