Интеграция Spring & Quartz с пользовательскими аннотациями, способ SPANN

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

В masetta мы попытались использовать проект Polyforms, чтобы использовать аннотации для реализации методов DAO (которые обычно состоят из некоторого стандартного кода вокруг запроса JPA). Вскоре мы обнаружили, что он не был настолько конфигурируемым и расширяемым, как нам нужно, имел проблемы с обработкой именованных параметров запроса и проблемы порядка инициализации (потому что Polyforms использует аспекты для реализации абстрактных методов). Кроме того, мы использовали пользовательские аннотации и обрабатывали их «вручную», но их становилось слишком много…

То, что мы придумали, это spann . Spann — это расширение с открытым исходным кодом для среды Spring, которая позволяет выполнять расширенную настройку компонентов Spring с использованием аннотаций. Чтобы взглянуть на одну из возможностей spann, я буду опираться на наш предыдущий пост и реализовывать аналогичные функции. Вместо кодирования я буду использовать spann. Как вы увидите, реализация очень короткая.

обзор

В коде используется собственная реализация планирования Quartz от Spring (как объяснено в ссылках на Spring). Метод SpringInvokingJobDetailFactoryBean используется Spring для создания компонента JobDetail, который делегирует выполнение задания методу другого компонента. В качестве триггера я использую весеннюю реализацию CronTrigger .

Для создания и настройки bean- компонентов JobDetail и CronTrigger я буду создавать аннотации на уровне методов, используя аннотацию spanB @BeanConfig .

Код

Пример кода может быть извлечен как проект maven из магистрали spann, используя

svn co http://spann.googlecode.com/svn/trunk/spann-quartz-example

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

1. Создайте аннотацию для настройки MethodInvokingJobDetailFactoryBean

Аннотация @BeanConfig создает и настраивает MethodInvokingJobDetailFactoryBean с использованием атрибутов аннотации QuartzJob ( имя , группа и одновременность ).

Сконфигурированный компонент «присоединяется» к аннотированному методу с ролью « quartzJob ». Это будет использовано позже для внедрения компонента JobDetail в триггер. «Присоединение» — это внутренняя концепция spann. Он позволяет ссылаться на bean-компоненты путем указания артефакта (например, класса или метода) и семантической роли (здесь «quartzJob») вместо имени. Это позволяет составлять аннотации , самую мощную функцию spann, которая также демонстрируется здесь.

Атрибут wire устанавливает свойства targetObject и targetMethod со значениями, заполненными из метаданных текущего артефакта (в данном случае MethodMetadata ), ScanContext и Annotation с использованием заданных фабрик.

2. Создайте cron триггер Аннотация

Я снова использую аннотацию @BeanConfig , на этот раз создавая и конфигурируя CronTriggerBean .

Явный атрибут указывает, как обрабатывать значения атрибута аннотации по умолчанию. Когда явное значение true, значения атрибутов по умолчанию игнорируются. Например, свойства timeZone , misfireInstructionName и triggerListenerNames элемента CronTriggerBean будут установлены, только если установлено соответствующее значение атрибута аннотации; значение по умолчанию будет игнорироваться.

Используя атрибут links, для свойства jobDetail устанавливается bean-компонент, созданный на шаге 1: spann будет искать bean-компонент, прикрепленный к аннотированному методу с ролью ‘ quartzJob ‘.

Обратите внимание, что типом атрибута аннотации timeZone является String , а типом свойства timeZone объекта CronTriggerBean является TimeZone . Spring обрабатывает значение напрямую, прозрачно преобразуя его в TimeZone с помощью средства SpringE PropertyEditor . Вы даже можете использовать синтаксис $ {…} Spring для подстановки выражений.

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

3. Настройка spann и Spring’s SchedulerFactoryBean

Наше applicationContext.xml очень короткое:

Если вы знаете Spring, здесь не должно быть никакого волшебства: я настраиваю сканирование компонентов Spring, сканирование spann и SchedulerFactoryBean , как описано в справочнике spring, только здесь я позволяю Spring автоматически связывать все триггерные бины с соответствующим свойством, следовательно, autowire = ‘byType’ .

4. Использование аннотаций

Боб настраивается с помощью аннотации @Component пружины . Это обычный Spring bean-компонент, и любые Spring- или аспектные аннотации ( @Autowired , @Resource , @Transactional ) будут обрабатываться Spring.

По умолчанию spann обрабатывает только аннотации уровня класса; @VisitMethods инструктирует spann также посещать методы этого класса и обрабатывать их аннотации, если они есть.

Использование новых аннотаций не вызывает затруднений : каждый запланированный метод должен быть аннотирован как @QuartzJob (для создания делегирующего JobDetail ), так и аннотацией @Cron или @Interval (здесь не показано, но доступно в svn) для создания триггера. ,

Это также демонстрирует композицию аннотации spann, которая позволяет аннотациям быть гранулированными и подключаемыми: @QuartzJob может использоваться с любой аннотацией, которая конфигурирует компонент Trigger , в то время как @Cron и @Interval могут использоваться с любой аннотацией, которая конфигурирует компонент JobDetail .

Резюме

Spann — это расширение с открытым исходным кодом для среды Spring, которое позволяет выполнять расширенную настройку bean-компонентов с использованием аннотаций. Код демонстрирует использование аннотации spann @BeanConfig для создания запланированных заданий Quartz с использованием аннотаций.

В примере используется высокоуровневый API spann , а именно аннотация @BeanConfig , реализованная в самом проекте spann. Высокоуровневый API Spann включает другие аннотации, которые позволяют заменять методы (для реализации абстрактных методов во время выполнения, внутренне используя cglib), создание синтетических адаптеров и всестороннюю поддержку JPA-запросов.

Интеграция Spann с Spring очень тесная: он создает «простые старые bean-компоненты Spring », как те, которые определены в XML или аннотацией @Component . Это позволяет вам использовать все функции bean-компонентов Spring: бины могут быть получены через ApplicationContext в Spring , имеют нормальный жизненный цикл bean-компонента, могут быть постобработаны (например, для замены выражений), автоматически подключены, перехвачены с использованием аспектов, управляются с помощью JMX и т. Д. на. Вам не нужны хаки и обходные пути, и вам не нужно переопределять, копировать и корректировать существующий Spring-код. Кроме того, у вас меньше шаблонный код и меньше шаблонная конфигурация.

Как бы ни были гибки @BeanConfig и другие аннотации spann, существуют варианты использования, которые они не охватывают. Но низкоуровневый API Spann позволяет создавать новые аннотации с нуля, предоставляя разработчикам полный контроль над созданием и настройкой определений bean-компонентов. Вы даже можете использовать spann для обработки метаданных любого другого класса, реализовав свой собственный MetadataVisitor , опционально игнорируя аннотации все вместе.

Справка: интеграция Spring & Quartz с пользовательскими аннотациями — путь SPANN от нашего партнера по W4G Рона Питермана .

Статьи по Теме :

• Учебник по интеграции Spring, Quartz и JavaMail
• Обмен конфигурации Spring Bean во время выполнения
• Образец приложения Spring MVC3 Hibernate CRUD
• Представление POJO как MBean JMX с Spring
• Список учебных пособий по Java и Android