Spring Beans¶
Одно из ключевых понятий в спринге — это Bean. По сути, это просто объект какого-то класса. Эти объекты создаются с помощью метаданных конфигурации, которые предоставляются контейнеру.
@Bean public EventLogger consoleLogger() return new ConsoleEventLogger(); >
A bean is an object that is instantiated, assembled, and otherwise managed by a Spring IoC container.
Otherwise, a bean is simply one of many objects in your application. Beans, and the dependencies among them, are reflected in the configuration metadata used by a container.
BeanDefinition¶
В самом контейнере определения bean-компонентов представлены в виде объектов BeanDefinition, которые содержат некоторые метаданные. Эти метаданные преобразуются в набор свойств, которые составляют каждый BeanDefinition:
Имя класса с указанием пакета: обычно это фактический класс реализации определяемого компонента.
Каждый Bean имеет один или несколько идентификаторов. These identifiers must be unique within the container that hosts the bean.
A bean usually has only one identifier. However, if it requires more than one, the extra ones can be considered aliases.
When you create a bean definition, you create a recipe for creating actual instances of the class defined by that bean definition.
Определяет отношение между BeanDefinition и конкретными инстансами Bean-ов (например при указании аргументов конструктора или пропертей (см. следующий пункт)).
The Spring Framework supports six scopes, four of which are available only if you use a web-aware ApplicationContext:
singleton
(Default) Scopes a single bean definition to a single object instance for each Spring IoC container.
prototype
Scopes a single bean definition to any number of object instances.
request
Scopes a single bean definition to the lifecycle of a single HTTP request.
session
Scopes a single bean definition to the lifecycle of an HTTP Session.
application
Scopes a single bean definition to the lifecycle of a ServletContext.
websocket
Scopes a single bean definition to the lifecycle of a WebSocket.
Ссылки на другие bean-компоненты, коллекции, примитивные значения, которые необходимы для работы. These references are also called collaborators or dependencies.
The Spring container can autowire relationships between collaborating beans.
Можно указать autowiring для bean-компонента и, таким образом, можно выбирать, какой именно bean использовать. Описываются следующие autowiring modes:
no
(Default) No autowiring
byName
Autowiring by property name. Spring looks for a bean with the same name as the property that needs to be autowired.
byType
Lets a property be autowired if exactly one bean of the property type exists in the container.
constructor
Аналогичен byType, но применяется к аргументам конструктора.
public class Application private ApplicationUser applicationUser; public void setApplicationUser(ApplicationUser applicationUser) this.applicationUser = applicationUser; > >
id="application" class="com.websystique.spring.domain.Application" autowire="byName"/> id="applicationUser" class="com.websystique.spring.domain.ApplicationUser" > name="name" value="superUser"/> By default, ApplicationContext implementations eagerly create and configure all singleton beans as part of the initialization process. A lazy-initialized bean tells the IoC container to create a bean instance when it is first requested, rather than at startup.
When a lazy-initialized bean is a dependency of a singleton bean that is not lazy-initialized.
The container calls afterPropertiesSet() (Initialization method) for the former and destroy() (Destruction method) for the latter to let the bean perform certain actions upon initialization and destruction of your beans.
The Lifecycle interface defines the essential methods for any object that has its own lifecycle requirements (such as starting and stopping some background process)
Annotation-based Bean configuration¶
Аннотации поддерживаются характерными ним BeanPostProcessor. CommonAnnotationBeanPostProcessor позволяет использовать конфигурацию с помощью аннотаций, независимо от выбранного BeanDefinitionReader (например через xml)
Помечает метод в конфигурации или в компоненте (~), как определение бина. Метод впредь будет возвращать конкретное запроксированное представление бина в контексте.
Для данной аннотации присутствуют следующие поля:
Указывает, какое имя будет иметь бин.
Указывает, какой Autowiring mode будет у данного бина (см BeanDefinition).
Указывает, какой метод будет обрабатывать событие инициализации этого бина в контексте (см @PostConstruct ).
Указывает, какой метод будет обрабатывать событие “уничтожения” этого объекта в контексте (см @PreDestroy ).
Аннотированный класс описывает внутренние свойства BeanDefinition. Имя бина может быть задано параметром в @Component(«name») .
Сама же декларация бина происходит с помощью аннотации @Bean или с помощью @ComponentScan .
Данная аннотация является базовой для многих других аннотаций в Spring:
(Сервис-слой приложения) Аннотация, объявляющая, что этот класс представляет собой сервис – компонент сервис-слоя.
Сервис является подтипом класса @Component . Использование данной аннотации позволит искать бины-сервисы автоматически.
(Слой представления) Аннотация для маркировки java класса, как класса контроллера. Данный класс представляет собой компонент, похожий на обычный сервлет (HttpServlet) (работающий с объектами HttpServletRequest и HttpServletResponse), но с расширенными возможностями от Spring Framework.
(Доменный слой) Аннотация показывает, что класс функционирует как репозиторий и требует наличия прозрачной трансляции исключений. Преимуществом трансляции исключений является то, что слой сервиса будет иметь дело с общей иерархией исключений от Spring (DataAccessException) вне зависимости от используемых технологий доступа к данным в слое данных.
Аннотация аккумулирует поведение двух аннотаций @Controller и @ResponseBody (показывает что данный метод может возвращать кастомный объект в виде xml, json…).
Помечает метод в компоненте, что он является post-construct , и вызовется в соответствии с Bean Lifecycle: ( afterPropertiesSet() ).
Помечает метод в компоненте, что он является pre-destroy , и вызовется в соответствии с Bean Lifecycle: ( destroy() ).
Beans on which the current bean depends. Any beans specified are guaranteed to be created by the container before this bean.
Указывается как с @Bean , так и с @Component .
Специфицирует Scope бина.
Указывается как с @Bean , так и с @Component .
Аннотированное поле автоматически связывается (позднее связывание при инициализации бина) с конкретным бином в контейнере (по имени/по типу).
Так же можно аннотировать сетер или конструктор — тогда связываться будут параметры сетера или конструктора, при их вызове при инициализации бина.
Indicates that a particular bean should be given preference when multiple beans are candidates to be autowired to a single-valued dependency.
Указывается как с @Bean , так и с @Component .
Специфицирует имя бина для связывания. Может быть также указан с конкретными аргументами конструктора или сеттера.
Дефолтный Qualifier (т.е. Autowired без Qualifier ) — это имя поля.
Инжекшн в спринге вначале отбирает по типам все подходящие бины, далее проверяет по Qualifier и под конец Primary .
Инжекшн нужно указывать для интерфесов, а не для классов, так как создаются динамические прокси (Proxy) (до Spring 5, после используется только cglib, создающий прокси как объект-наследник) для искомых классов, а сохраняют они при этом интерфейсы а не классы (динамические прокси), по которым будут искаться бины.
Помечает бин, что он инициализируется, только при первом обращении (Lazy initialization mode).
Аннотируется с @Bean или с @Component , как и на конфигурации, при этом если помечен компонент — это значит, что сам компонент является Lazy, в противоположность конфигурации — все бины в ней становятся Lazy (см. Annotation-based Configuration ).
Со Spring 4.3 можно поставить с анотацией @Autowired , для пометки того, что инжекшн будет ленивым, т.е. например, это позволит создавать в синглтонах ленивые (по первому вызову) зависимости.
Вычисляет указанное spring-expression и присваивает в аннотированное поле / параметр (функции / конструктора)
Аннотация для создания профилей конфигурации проекта. Может применяться как к бинам так и к конфигурационным классам.
Помечает класс, использующий aspectj.
@Component @DependsOn(" . ") public class ComponentExample extends SuperComponentExample @Autowired ComponentExample ( @Value("string example") String param, @Qualifier("dependentBean") MyBean bean ) super(fileName); . > @Bean @Lazy @Primary public MyBean bean1() return new MyBean(); > @Bean @Scope("singleton") public MyBean bean2() return new MyBean(); > @Bean @Scope("prototype") public MyBean bean3() assert(bean2() == bean2()) // ибо singleton return new MyBean(); > @PreDestroy public void destroy() . > >
@Bean
@Bean – это аннотация уровня метода и прямой аналог элемента на XML. Аннотация поддерживает некоторые атрибуты, предлагаемые , такие как:
Вы можете использовать аннотацию @Bean в классе с аннотацией @Configuration или в классе с аннотацией @Component .
Объявление бина
Чтобы объявить бин, можно аннотировать метод с помощью @Bean . Этот метод используется для регистрации определения бина в ApplicationContext того типа, который задан в качестве возвращаемого значения метода. По умолчанию имя бина совпадает с именем метода. В следующем примере показано объявление метода с аннотацией @Bean :
@Configuration public class AppConfig < @Bean public TransferServiceImpl transferService() < return new TransferServiceImpl(); >>@Configuration class AppConfig
Предшествующая конфигурация в точности эквивалентна следующей на основе XML в Spring:
Оба объявления делают бин с именем transferService доступным в ApplicationContext , привязанном к экземпляру объекта типа TransferServiceImpl , как показано на следующем текстовом изображении:
transferService -> com.acme.TransferServiceImpl
Также можно использовать методы по умолчанию для определения бинов. Это позволяет создавать конфигурации бинов путем реализации интерфейсов с определениями бинов в методах по умолчанию.
public interface BaseConfig < @Bean default TransferServiceImpl transferService() < return new TransferServiceImpl(); >> @Configuration public class AppConfig implements BaseConfig
Можно также объявить свой метод, аннотированный @Bean , с помощью возвращаемого типа интерфейса (или базового класса), как показано в следующем примере:
@Configuration public class AppConfig < @Bean public TransferService transferService() < return new TransferServiceImpl(); >>@Configuration class AppConfig < @Bean fun transferService(): TransferService < return TransferServiceImpl() >>Однако это ограничивает видимость для прогнозирования расширенного типа указанным типом интерфейса (TransferService ). Затем, когда полный тип (TransferServiceImpl ) единожды распознается контейнером, создается экземпляр затронутого бина-одиночки. Экземпляры бинов-одиночек без отложенной инициализации создаются в соответствии с порядком их объявления, поэтому вы можете заметить разные результаты согласования по типам в зависимости от того, когда другой компонент пытается выполнить согласование по необъявленному типу (например, @Autowired TransferServiceImpl , который разрешается только после создания экземпляра бина transferService ).
Если вы постоянно ссылаетесь на свои типы по объявленному интерфейсу службы, то ваши возвращаемые типы, помеченные аннотацией @Bean , могут без проблем следовать этому проектному решению. Однако для компонентов, реализующих несколько интерфейсов, или для компонентов, на которые потенциально можно ссылаться по их типу реализации, безопаснее объявить максимально конкретный возвращаемый тип (по крайней мере, настолько конкретный, насколько этого требуют точки внедрения, ссылающиеся на ваш бин).
Зависимости бинов
Метод, аннотированный @Bean , может иметь произвольное количество параметров, которые описывают зависимости, необходимые для создания этого бина. Например, если нашему TransferService требуется AccountRepository , мы можем осуществить эту зависимость с помощью параметра метода, как показано в следующем примере:
@Configuration public class AppConfig < @Bean public TransferService transferService(AccountRepository accountRepository) < return new TransferServiceImpl(accountRepository); >>