Package org.springframework.beans.factory.aot

Interface BeanRegistrationAotProcessor

All Known Implementing Classes:
AutowiredAnnotationBeanPostProcessor, CommonAnnotationBeanPostProcessor, ConfigurationClassPostProcessor, InitDestroyAnnotationBeanPostProcessor, PersistenceAnnotationBeanPostProcessor
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface BeanRegistrationAotProcessor
AOT processor that makes bean registration contributions by processing RegisteredBean instances.

BeanRegistrationAotProcessor implementations may be registered in a "META-INF/spring/aot.factories" resource or as a bean.

Using this interface on a registered bean will cause the bean and all of its dependencies to be initialized during AOT processing. We generally recommend that this interface is only used with infrastructure beans such as BeanPostProcessor which have limited dependencies and are already initialized early in the bean factory lifecycle. If such a bean is registered using a factory method, make sure to make it static so that its enclosing class does not have to be initialized.

An AOT processor replaces its usual runtime behavior by an optimized arrangement, usually in generated code. For that reason, a component that implements this interface is not contributed by default. If a component that implements this interface still needs to be invoked at runtime, isBeanExcludedFromAotProcessing() can be overridden.

Since:
6.0
Author:
Phillip Webb, Stephane Nicoll
See Also:

  • Field Details

    • IGNORE_REGISTRATION_ATTRIBUTE

      static final String IGNORE_REGISTRATION_ATTRIBUTE
      The name of an attribute that can be set on a BeanDefinition to signal that its registration should not be processed.
      Since:
      6.2
      See Also:

  • Method Details

    • processAheadOfTime

      @Nullable BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean)
      Process the given RegisteredBean instance ahead-of-time and return a contribution or null.

      Processors are free to use any techniques they like to analyze the given instance. Most typically use reflection to find fields or methods to use in the contribution. Contributions typically generate source code or resource files that can be used when the AOT optimized application runs.

      If the given instance isn't relevant to the processor, it should return a null contribution.

      Parameters:
      registeredBean - the registered bean to process
      Returns:
      a BeanRegistrationAotContribution or null

    • isBeanExcludedFromAotProcessing

      default boolean isBeanExcludedFromAotProcessing()
      Return if the bean instance associated with this processor should be excluded from AOT processing itself. By default, this method returns true to automatically exclude the bean, if the definition should be written then this method may be overridden to return true.
      Returns:
      if the bean should be excluded from AOT processing
      See Also: