Spring. Как это работает? Часть 3

Продолжение статьи Spring. Как это работает? Часть 2: Создание бинов через вызов конструктора

Определение ссылок на бины / Specifying Bean References

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

Решение

В конфигурационном файле можно задать ссылку на бин для свойства бина или аргумента конструктора с использованием элемента <ref>. Это так же просто, как и задание значений через элемент <value>. Можно также задать объявление бина в свойстве или аргументе конструктора в виде вложенного бина. 

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

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

public interface PrefixGenerator { public String getPrefix(); }

Одна из стратегий генерации префикса заключается в использовании определенного шаблона для формирования текущего системного времени. Создадим класс DatePrefixGenerator, который будет реализовать интерфейс PrefixGenerator.

public class DatePrefixGenerator implements PrefixGenerator { private DateFormat formatter; public void setPattern(String pattern) { this.formatter = new SimpleDateFormat(pattern); } public String getPrefix() { return formatter.format(new Date()); } }

Шаблон генератора будет вставлен через сеттер setPattern(), а затем использован для создания объекта java.text.DateFormat для формирования даты. Поскольку строка шаблона станет бесполезной как только будет создан объект DateFormat, нет необходимости хранить ее в виде приватного поля.

Теперь можно объявить бин типа DatePrefixGenerator с произвольным шаблоном для форматирования даты.

<bean id="datePrefixGenerator" class="com.apress.springrecipes.sequence.DatePrefixGenerator"> <property name="pattern" value="yyyyMMdd" /> </bean>

Определение ссылок на бины для сеттеров

Для применения такого подхода для генерации префиксов, класс SequenceGenerator должен принимать объект типа PrefixGenerator вместо обычного строкового префикса. Можно выбрать инъекцию через сеттеры. Для этого надо удалить свойство prefix, что вызовет ошибки компиляции.

public class SequenceGenerator { ... private PrefixGenerator prefixGenerator; public void setPrefixGenerator(PrefixGenerator prefixGenerator) { this.prefixGenerator = prefixGenerator; } public synchronized String getSequence() { StringBuffer buffer = new StringBuffer(); buffer.append(prefixGenerator.getPrefix()); buffer.append(initial + counter++); buffer.append(suffix); return buffer.toString(); } }

Затем, бин SequenceGenerator может ссылаться на datePrefixGenerator и его свойство prefixGenerator с помощью тега <ref>.

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <property name="initial" value="100000" /> <property name="suffix" value="A" /> <property name="prefixGenerator"> <ref bean="datePrefixGenerator" /> </property> </bean>

Имя бина в элементе <ref> может быть ссылкой на любой бин в контейнере, даже если он не определен в этом же конфигурационном файле. Если вы ссылаетесь на бин из того же файла, необходимо использовать атрибут local.

 <bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> ... <property name="prefixGenerator"> <ref local="datePrefixGenerator" /> </property> </bean>

Есть также возможность объявить ссылку на бин в ref атрибуте элемента <property>.

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> ... <property name="prefixGenerator" ref="datePrefixGenerator" /> </bean>

Но в таком случае будет тяжело валидировать целостность ссылок. 

Определение ссылок на бины через аргументы конструктора

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

public class SequenceGenerator { ... private PrefixGenerator prefixGenerator; public SequenceGenerator(PrefixGenerator prefixGenerator) { this.prefixGenerator = prefixGenerator; } }

В элементе <constructor-arg> можно объявить ссылку на бин через <ref> 

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <constructor-arg> <ref local="datePrefixGenerator" /> </constructor-arg> <property name="initial" value="100000" /> <property name="suffix" value="A" /> </bean>

Ярлык для определения ссылки на бин работает также для <constructor-arg>.

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <constructor-arg ref="datePrefixGenerator" /> ... </bean>

Объявление вложенных бинов

В случаях, когда объект бина используется только для одного определенного свойства, он может быть объявлен в виде вложенного бина. Декларация вложенного бина задается в теге <property> или <constructor-arg> напрямую, без всяких id или name атрибутов. В таком случае, бин будет анонимным, поэтому его больше нигде нельзя будет использовать. 

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <property name="initial" value="100000" /> <property name="suffix" value="A" /> <property name="prefixGenerator"> <bean class="com.apress.springrecipes.sequence.DatePrefixGenerator"> <property name="pattern" value="yyyyMMdd" /> </bean> </property> </bean>

Вложенный бин может также быть объявлен в виде аргумента конструктора

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <constructor-arg> <bean class="com.apress.springrecipes.sequence.DatePrefixGenerator"> <property name="pattern" value="yyyyMMdd" /> </bean> </constructor-arg> <property name="initial" value="100000" /> <property name="suffix" value="A" /> </bean>

Определение типа данных для коллекций

По умолчанию, Spring интерпретирует все элементы коллекции в виде строк. Если мы собираемся использовать типы данных, отличные от строковых, необходимо их давать в объявлении.

Для этого можно либо определить тип данных для каждого элемента коллекции с использованием атрибута type тега <value>, либо определить тип данных для всех элементов в атрибуте value-type тега коллекции.

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

public class SequenceGenerator { ... private List<Object> suffixes; public void setSuffixes(List<Object> suffixes) { this.suffixes = suffixes; } public synchronized String getSequence() { StringBuffer buffer = new StringBuffer(); ... DecimalFormat formatter = new DecimalFormat("0000"); for (Object suffix : suffixes) { buffer.append("-"); buffer.append(formatter.format((Integer) suffix)); } return buffer.toString(); } }

Затем объявим несколько суффиксов для генератора последовательностей в конфигурации бина.

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <property name="prefixGenerator" ref="datePrefixGenerator" /> <property name="initial" value="100000" /> <property name="suffixes"> <list> <value>5</value> <value>10</value> <value>20</value> </list> </property> </bean>

Однако, при запуске приложения мы получим ClassCastException. Это говорит о том, что суффиксы не могут быть приведены к целочисленным значениям, поскольку они объявлены как String. 

По умолчанию, Spring воспринимает все элементы коллекции как String.

Чтобы задать тип элемента, необходимо задать тип атрибута в теге <value>.

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> ... <property name="suffixes"> <list> <value type="int">5</value> <value type="int">10</value> <value type="int">20</value> </list> </property> </bean>

Можно также задать атрибут value-type тега коллекции, чтобы указать тип для всех элементов сразу.

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> ... <property name="suffixes"> <list value-type="int"> <value>5</value> <value>10</value> <value>20</value> </list> </property> </bean>

Создание бинов с помощью FactoryBean

Допустим, необходимо создать бин в контейнере с использованием фабричного бина спринга. Factory Bean - это бин, который хранит фабрику для создания других бинов в контейнере. 

Основные требования к фабричному методу - реализовать интерфейс FactoryBean. Для удобства, Spring предоставляет абстрактный шаблонный класс, AbstractFactoryBean, от которого можно наследоваться. Фабричные бины в своем большинстве, используются для реализации поведения фреймворка. Вот несколько примеров:

• Можно использовать JndiObjectFactoryBean в тех случаях, когда необходимо получить объект через JNDI (например соединение с базой данных)
• Можно использовать ProxyFactoryBean в тех случаях, если необходимо создать прокси для бина при использолвании Spring AOP.
• При создании фабрики соединений Hibernate в контейнере можно использовать LocalSessionFactoryBean.