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

Продолжение статьи Spring. Как это работает. Часть 1

Создание бинов через вызов конструктора

Проблема

Необходимо создать бин в IoC контейнере Spring через вызов его конструктора, наиболее распространенного пути создания бинов. Эквивалентом является использование оператора new для создания объекта в Java. 

Решение

Когда мы задаем атрибут class для бина, мы тем самым просим контейнер создать объект бина через вызов конструктора.

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

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

public abstract class Product { private String name; private double price; public Product() { } public Product(String name, double price) { this.name = name; this.price = price; } // Getters and Setters ... public String toString() { return name + " " + price; } }

Затем создаем два подкласса продуктов, скажем Battery и Disc. У каждого из них определены свои свойства.

public class Battery extends Product { private boolean rechargeable; public Battery() { super(); } public Battery(String name, double price) { super(name, price); } // Getters and Setters ... } public class Disc extends Product { private int capacity; public Disc() { super(); } public Disc(String name, double price) { super(name, price); } // Getters and Setters ... }

Для определения продуктов в контейнере создаем файл описания:

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> <bean id="aaa" class="com.apress.springrecipes.shop.Battery"> <property name="name" value="AAA" /> <property name="price" value="2.5" /> <property name="rechargeable" value="true" /> </bean> <bean id="cdrw" class="com.apress.springrecipes.shop.Disc"> <property name="name" value="CD-RW" /> <property name="price" value="1.5" /> <property name="capacity" value="700" /> </bean> </beans>

В случае, когда элемент <constructor-arg> не задан, будет вызван конструктор по умолчанию без аргументов. Затем, для каждого элемента <property> Spring установит значение через сеттеры. Описанная XML конфигурация аналогична такому куску кода:

Product aaa = new Battery(); aaa.setName("AAA"); aaa.setPrice(2.5); aaa.setRechargeable(true); Product cdrw = new Disc(); cdrw.setName("CD-RW"); cdrw.setPrice(1.5); cdrw.setCapacity(700);

В другом случае, если определен один или более элемент <constructor-arg>, Spring вызовет наиболее подходящий конструктор с таким же количеством аргументов

<beans ...> <bean id="aaa" class="com.apress.springrecipes.shop.Battery"> <constructor-arg value="AAA" /> <constructor-arg value="2.5" /> <property name="rechargeable" value="true" /> </bean> <bean id="cdrw" class="com.apress.springrecipes.shop.Disc"> <constructor-arg value="CD-RW" /> <constructor-arg value="1.5" /> <property name="capacity" value="700" /> </bean> </beans>

Приведенная конфигурация идентична такому коду:

Product aaa = new Battery("AAA", 2.5); aaa.setRechargeable(true); Product cdrw = new Disc("CD-RW", 1.5); cdrw.setCapacity(700);

Можете написать класс Main для теста продуктов путем получения их из контейнера:

import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class Main { public static void main(String[] args) throws Exception { ApplicationContext context = new ClassPathXmlApplicationContext( "beans.xml"); Product aaa = (Product) context.getBean("aaa"); Product cdrw = (Product) context.getBean("cdrw"); System.out.println(aaa); System.out.println(cdrw); } }

Разрешение двусмысленности в конструкторах

Проблема

Когда указывается один или более аргументов для конструктора бина, Spring пытается найти подходящий конструктор в бине класса и передать аргументы для создания объекта бина. Однако, если аргументы применимы к более, чем одному конструктору, это может вызвать двусмысленность при выборе подходящего конструктора В этом случае, вызов подходящего конструктора может стать затруднительным действием для Spring. 

Решение

Можно задать атрибуты type и index для элемента <constructor-arg> для того, чтобы помочь контейнеру найти ожидаемый конструктор. 

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

Теперь добавим новый конструктор к классу SequenceGenerator с аргументами prefix  и suffix.

public class SequenceGenerator { ... public SequenceGenerator(String prefix, String suffix) { this.prefix = prefix; this.suffix = suffix; } }

В этом объявлении бина можно задать один или более параметров конструктора через элементы <constructor-arg>. Spring попытается найти подходящий конструктор для этого класса и передать заданные аргументы для создания объекта. 

Тег <constructor-arg> не поддерживает атрибута name. Поиск конструктора происходит в зависимости от порядка аргументов.

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

Для контейнера не составит труда найти подходящий конструктор для двух аргументов, поскольку у нас описан лишь один конструктор, требующий задания двух аргументов. Предположим, что надо добавить еще один конструктор в класс SequenceGenerator  с аргументами prefix и initial.

public class SequenceGenerator { ... public SequenceGenerator(String prefix, String suffix) { this.prefix = prefix; this.suffix = suffix; } public SequenceGenerator(String prefix, int initial) { this.prefix = prefix; this.initial = initial; } }

Для вызова этого конструктора необходимо сделать следующее объявление бина для передачи значений prefix  и value. 

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

Запуск примера даст результат

300A 301A

Причина такого неожиданного результата состоит в том, что был вызван первый конструктор с аргументами prefix и suffix. Это произошло по той причине, что Spring распознал оба аргумента как String и решил использовать первый подходящий конструктор, поскольку никакого приведения типов не требуется. Для задания ожидаемого типа аргументов можно установить его в атрибуте type для тега <constructor-arg>. 

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <constructor-arg type="java.lang.String" value="30" /> <constructor-arg type="int" value="100000" /> <property name="suffix" value="A" /> </bean>

Теперь добавляем еще один конструктор в класс SequenceGenerator с аргументами initial и suffix и меняем объявление бина.

public class SequenceGenerator { ... public SequenceGenerator(String prefix, String suffix) { this.prefix = prefix; this.suffix = suffix; } public SequenceGenerator(String prefix, int initial) { this.prefix = prefix; this.initial = initial; } public SequenceGenerator(int initial, String suffix) { this.initial = initial; this.suffix = suffix; } }

<bean id="sequenceGenerator" class="com.apress.springrecipes.sequence.SequenceGenerator"> <constructor-arg type="int" value="100000" /> <constructor-arg type="java.lang.String" value="A" /> <property name="prefix" value="30" /> </bean>

Запустив приложение, получим

30100000null 30100001null

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