Class ControllerAdviceBean
- All Implemented Interfaces:
Ordered
@ControllerAdvice
Spring-managed bean without necessarily requiring it to be instantiated.
The findAnnotatedBeans(ApplicationContext)
method can be used to
discover such beans. However, a ControllerAdviceBean
may be created
from any object, including ones without an @ControllerAdvice
annotation.
- Since:
- 3.2
- Author:
- Rossen Stoyanchev, Brian Clozel, Juergen Hoeller, Sam Brannen
-
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
ConstructorDescriptionControllerAdviceBean
(Object bean) Create aControllerAdviceBean
using the given bean instance.ControllerAdviceBean
(String beanName, BeanFactory beanFactory) Create aControllerAdviceBean
using the given bean name andBeanFactory
.ControllerAdviceBean
(String beanName, BeanFactory beanFactory, ControllerAdvice controllerAdvice) Create aControllerAdviceBean
using the given bean name,BeanFactory
, and@ControllerAdvice
annotation. -
Method Summary
Modifier and TypeMethodDescriptionboolean
static List<ControllerAdviceBean>
findAnnotatedBeans
(ApplicationContext context) Find beans annotated with@ControllerAdvice
in the givenApplicationContext
and wrap them asControllerAdviceBean
instances.Class<?>
Return the type of the contained bean.int
getOrder()
Get the order value for the contained bean.int
hashCode()
boolean
isApplicableToBeanType
(Class<?> beanType) Check whether the given bean type should be advised by thisControllerAdviceBean
.Get the bean instance for thisControllerAdviceBean
, if necessary resolving the bean name through theBeanFactory
.toString()
-
Constructor Details
-
ControllerAdviceBean
Create aControllerAdviceBean
using the given bean instance.- Parameters:
bean
- the bean instance
-
ControllerAdviceBean
Create aControllerAdviceBean
using the given bean name andBeanFactory
.- Parameters:
beanName
- the name of the beanbeanFactory
- aBeanFactory
to retrieve the bean type initially and later to resolve the actual bean
-
ControllerAdviceBean
public ControllerAdviceBean(String beanName, BeanFactory beanFactory, @Nullable ControllerAdvice controllerAdvice) Create aControllerAdviceBean
using the given bean name,BeanFactory
, and@ControllerAdvice
annotation.- Parameters:
beanName
- the name of the beanbeanFactory
- aBeanFactory
to retrieve the bean type initially and later to resolve the actual beancontrollerAdvice
- the@ControllerAdvice
annotation for the bean, ornull
if not yet retrieved- Since:
- 5.2
-
-
Method Details
-
getOrder
public int getOrder()Get the order value for the contained bean.As of Spring Framework 5.3, the order value is lazily retrieved using the following algorithm and cached. Note, however, that a
@ControllerAdvice
bean that is configured as a scoped bean — for example, as a request-scoped or session-scoped bean — will not be eagerly resolved. Consequently,Ordered
is not honored for scoped@ControllerAdvice
beans.- If the resolved bean implements
Ordered
, use the value returned byOrdered.getOrder()
. - If the factory method
is known, use the value returned by
OrderUtils.getOrder(AnnotatedElement)
. - If the bean type is known, use the value returned
by
OrderUtils.getOrder(Class, int)
withOrdered.LOWEST_PRECEDENCE
used as the default order value. - Otherwise use
Ordered.LOWEST_PRECEDENCE
as the default, fallback order value.
- If the resolved bean implements
-
getBeanType
Return the type of the contained bean.If the bean type is a CGLIB-generated class, the original user-defined class is returned.
-
resolveBean
Get the bean instance for thisControllerAdviceBean
, if necessary resolving the bean name through theBeanFactory
.Once the bean instance has been resolved it will be cached if it is a singleton, thereby avoiding repeated lookups in the
BeanFactory
. -
isApplicableToBeanType
Check whether the given bean type should be advised by thisControllerAdviceBean
.- Parameters:
beanType
- the type of the bean to check- Since:
- 4.0
- See Also:
-
equals
-
hashCode
public int hashCode() -
toString
-
findAnnotatedBeans
Find beans annotated with@ControllerAdvice
in the givenApplicationContext
and wrap them asControllerAdviceBean
instances.Note that the
ControllerAdviceBean
instances in the returned list are sorted usingOrderComparator.sort(List)
.- See Also:
-