io microsphere spring beans BeanUtils

BeanUtils

Type: Class | Module: microsphere-spring-context | Package: io.microsphere.spring.beans | Since: 1.0.0

Source: microsphere-spring-context/src/main/java/io/microsphere/spring/beans/BeanUtils.java

Overview

Bean Utilities Class

Declaration

public abstract class BeanUtils implements Utils

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.2.12-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

Method Examples

isBeanPresent

boolean present = isBeanPresent(beanFactory, MyService.class, true);

isBeanPresent

boolean present = isBeanPresent(beanFactory, "com.example.MyService");

isBeanPresent

boolean present = isBeanPresent(beanFactory, "com.example.MyService", true);

isBeanPresent

boolean present = isBeanPresent(beanFactory, "myService", MyService.class);

getBeanNames

String[] beanNames = getBeanNames(beanFactory, MyService.class);

getBeanNames

String[] beanNames = getBeanNames(beanFactory, MyService.class, true);

getBeanNames

String[] beanNames = getBeanNames(beanFactory, MyService.class);

getBeanNames

String[] beanNames = getBeanNames(beanFactory, MyService.class, true);

resolveBeanType

Class<?> beanType = resolveBeanType("com.example.MyService", classLoader);

getOptionalBean

MyService myService = getOptionalBean(beanFactory, MyService.class);

getOptionalBean

MyService myService = BeanUtils.getOptionalBean(beanFactory, MyService.class);

getBeanIfAvailable

MyService myService = getBeanIfAvailable(beanFactory, "myService", MyService.class);

getSortedBeans

List<MyService> myServices = getSortedBeans(beanFactory, MyService.class);

getSortedBeans

List<MyService> myServices = getSortedBeans(beanFactory, MyService.class);

invokeBeanInterfaces

MyBean myBean = new MyBean();
ApplicationContext context = ...; // Obtain or create an ApplicationContext
invokeBeanInterfaces(myBean, context);

invokeBeanInterfaces

MyBean myBean = new MyBean();
ConfigurableApplicationContext context = ...; // Obtain or create a ConfigurableApplicationContext
BeanUtils.invokeBeanInterfaces(myBean, context);

invokeInitializingBean

MyInitializingBean myBean = new MyInitializingBean();
BeanUtils.invokeInitializingBean(myBean);

invokeAwareInterfaces

MyBean myBean = new MyBean();
ConfigurableBeanFactory beanFactory = context.getBeanFactory();
BeanUtils.invokeAwareInterfaces(myBean, beanFactory);

invokeAwareInterfaces

MyBean myBean = new MyBean();
ConfigurableBeanFactory beanFactory = context.getBeanFactory();
BeanUtils.invokeAwareInterfaces(myBean, beanFactory);

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-spring-context</artifactId>
    <version>${microsphere-spring.version}</version>
</dependency>

Tip: Use the BOM (microsphere-spring-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.spring.beans.BeanUtils;

API Reference

Public Methods

Method	Description
isBeanPresent	Is Bean Present or not?
isBeanPresent	Check if a bean of the specified class is present in the given ListableBeanFactory.
isBeanPresent	Check if a bean with the specified class name is present in the given ListableBeanFactory.
isBeanPresent	Check if a bean with the specified class name is present in the given ListableBeanFactory.
isBeanPresent	Check if a bean with the specified name and class is present in the given BeanFactory.
getBeanNames	Get bean names of the specified type from the given ListableBeanFactory.
getBeanNames	Get Bean Names from ListableBeanFactory by type.
getBeanNames	Get bean names of the specified type from the given ConfigurableListableBeanFactory.
getBeanNames	Get bean names of the specified type from the given ConfigurableListableBeanFactory.
resolveBeanType	Resolve the bean type from the given class name using the specified ClassLoader.
getOptionalBean	Retrieve an optional bean of the specified type from the given ListableBeanFactory.
getOptionalBean	Retrieve an optional bean of the specified type from the given ListableBeanFactory.
getBeanIfAvailable	Retrieve the bean with the specified name and type from the given BeanFactory if it exists.
getSortedBeans	Retrieve a list of beans of the specified type from the given BeanFactory, sorted based on their order.
getSortedBeans	Retrieve all beans of the specified type from the given ListableBeanFactory, sorted based on their order.
invokeBeanInterfaces	Invokes the standard Spring bean lifecycle interfaces in a specific order for the given bean and application context.
invokeBeanInterfaces	Invokes the standard Spring bean lifecycle interfaces in a specific order for the given bean and application context.
invokeInitializingBean	Invoke the InitializingBean#afterPropertiesSet() method if the given bean implements the interface.
invokeAwareInterfaces	Invokes the Spring Aware interfaces implemented by the given bean if applicable.
invokeAwareInterfaces	Invokes the Spring Aware interfaces implemented by the given bean if applicable.

Method Details

isBeanPresent

public static boolean isBeanPresent(@Nonnull ListableBeanFactory beanFactory, @Nonnull Class<?> beanClass,
                                        boolean includingAncestors)

Check if a bean of the specified class is present in the given ListableBeanFactory.

This method checks whether there is at least one bean of the specified type in the bean factory. If the parameter includingAncestors is set to true, it will also check ancestor bean factories.

Example Usage

`boolean present = isBeanPresent(beanFactory, MyService.class, true);
`

Behavior

- If the bean class is null or not resolvable, an empty array will be returned.
- If no beans are found and logging is enabled at trace level, a log message will be recorded.

isBeanPresent

public static boolean isBeanPresent(@Nonnull ListableBeanFactory beanFactory, @Nonnull String beanClassName)

Check if a bean with the specified class name is present in the given ListableBeanFactory.

This method checks whether there is at least one bean with the specified class name in the bean factory. The check includes only the current bean factory and does not search in ancestor factories.

Example Usage

`boolean present = isBeanPresent(beanFactory, "com.example.MyService");
`

Behavior

- The method resolves the class using the bean factory's class loader (if available).
- If the class cannot be resolved or no bean is found, it returns false.

isBeanPresent

public static boolean isBeanPresent(@Nonnull ListableBeanFactory beanFactory, @Nonnull String beanClassName,
                                        boolean includingAncestors)

Check if a bean with the specified class name is present in the given ListableBeanFactory.

This method checks whether there is at least one bean with the specified class name in the bean factory. If the parameter includingAncestors is set to true, it will also check ancestor bean factories.

Example Usage

`boolean present = isBeanPresent(beanFactory, "com.example.MyService", true);
`

Behavior

- The method resolves the class using the bean factory's class loader (if available).
- If the class cannot be resolved or no bean is found, it returns false.
- If logging is enabled at trace level and no bean is found, a log message will be recorded.

isBeanPresent

public static boolean isBeanPresent(@Nonnull BeanFactory beanFactory, @Nonnull String beanName,
                                        @Nonnull Class<?> beanClass)

Check if a bean with the specified name and class is present in the given BeanFactory.

This method verifies whether a bean exists in the bean factory by both its name and type. It ensures that the bean is present and matches the expected class type.

Example Usage

`boolean present = isBeanPresent(beanFactory, "myService", MyService.class);
`

Behavior

- Returns false if either the bean factory, bean name, or bean class is null.
- If logging is enabled at trace level, a message will be logged when the bean is not found.

getBeanNames

public static String[] getBeanNames(@Nonnull ListableBeanFactory beanFactory, @Nonnull Class<?> beanClass)

Get bean names of the specified type from the given ListableBeanFactory.

This method retrieves the names of all beans that match the specified class type. The search is limited to the current bean factory and does not include ancestor factories.

Example Usage

`String[] beanNames = getBeanNames(beanFactory, MyService.class);
`

Behavior

- Returns an empty array if no beans of the specified type are found.
- If logging is enabled at trace level, a message will be logged when no beans are found.

getBeanNames

public static String[] getBeanNames(@Nonnull ListableBeanFactory beanFactory, @Nonnull Class<?> beanClass,
                                        @Nonnull boolean includingAncestors)

Get Bean Names from ListableBeanFactory by type.

This method retrieves the names of all beans that match the specified class type. If the parameter includingAncestors is set to true, it will also check ancestor bean factories.

Example Usage

`String[] beanNames = getBeanNames(beanFactory, MyService.class, true);
`

Behavior

- If no beans are found and logging is enabled at trace level, a log message will be recorded.
- Returns an empty array if no beans of the specified type are found.

getBeanNames

public static String[] getBeanNames(@Nonnull ConfigurableListableBeanFactory beanFactory, @Nonnull Class<?> beanClass)

Get bean names of the specified type from the given ConfigurableListableBeanFactory.

This method retrieves the names of all beans that match the specified class type. The search is limited to the current bean factory and does not include ancestor factories.

Example Usage

`String[] beanNames = getBeanNames(beanFactory, MyService.class);
`

Behavior

- Returns an empty array if no beans of the specified type are found.
- If logging is enabled at trace level, a message will be logged when no beans are found.

getBeanNames

public static String[] getBeanNames(@Nonnull ConfigurableListableBeanFactory beanFactory, @Nonnull Class<?> beanClass,
                                        boolean includingAncestors)

Get bean names of the specified type from the given ConfigurableListableBeanFactory.

This method retrieves the names of all beans that match the specified class type. If the parameter includingAncestors is set to true, it will also check ancestor bean factories.

Example Usage

`String[] beanNames = getBeanNames(beanFactory, MyService.class, true);
`

Behavior

- If no beans are found and logging is enabled at trace level, a log message will be recorded.
- Returns an empty array if no beans of the specified type are found.

resolveBeanType

public static Class<?> resolveBeanType(@Nullable String beanClassName, @Nullable ClassLoader classLoader)

Resolve the bean type from the given class name using the specified ClassLoader.

This method attempts to load the class with the provided name using the given ClassLoader. If the class cannot be found, it returns null. Otherwise, it returns the resolved class. Additionally, if the provided class name is null or empty, the method will return null.

Example Usage

`Class beanType = resolveBeanType("com.example.MyService", classLoader);
`

Behavior

- If the class name is null or empty, it returns null.
- If the class cannot be loaded, it logs a warning and returns null.
- Otherwise, it returns the resolved class.

getOptionalBean

public static <T> T getOptionalBean(@Nonnull ListableBeanFactory beanFactory, @Nonnull Class<T> beanClass,
                                        boolean includingAncestors)

Retrieve an optional bean of the specified type from the given ListableBeanFactory.

This method attempts to find and return a single bean of the specified class. If no beans are found, it returns null. If multiple beans are found, it throws a NoUniqueBeanDefinitionException.

Example Usage

`MyService myService = getOptionalBean(beanFactory, MyService.class);
`

Behavior

- If no beans of the specified type are found, returns `null`.
- If multiple beans are found, throws a `NoUniqueBeanDefinitionException`.
- If logging is enabled at trace level, logs a message when no bean is found.
- If logging is enabled at error level, logs any exception thrown during bean retrieval.

getOptionalBean

public static <T> T getOptionalBean(@Nonnull ListableBeanFactory beanFactory, @Nonnull Class<T> beanClass)

Retrieve an optional bean of the specified type from the given ListableBeanFactory.

This method attempts to find and return a single bean of the specified class. If no beans are found, it returns null. If multiple beans are found, it throws a NoUniqueBeanDefinitionException.

Example Usage

`MyService myService = BeanUtils.getOptionalBean(beanFactory, MyService.class);
`

Behavior

- If no beans of the specified type are found, returns `null`.
- If multiple beans are found, throws a `NoUniqueBeanDefinitionException`.
- If logging is enabled at trace level, logs a message when no bean is found.
- If logging is enabled at error level, logs any exception thrown during bean retrieval.

getBeanIfAvailable

public static <T> T getBeanIfAvailable(@Nonnull BeanFactory beanFactory, @Nonnull String beanName,
                                           @Nonnull Class<T> beanType)

Retrieve the bean with the specified name and type from the given BeanFactory if it exists.

This method checks whether a bean with the specified name and type exists in the bean factory. If it does, the bean is returned; otherwise, null is returned.

Example Usage

`MyService myService = getBeanIfAvailable(beanFactory, "myService", MyService.class);
`

Behavior

- If the bean is not present, returns `null`.
- If logging is enabled at trace level, logs a message when the bean is not found.

getSortedBeans

public static <T> List<T> getSortedBeans(@Nonnull BeanFactory beanFactory, @Nonnull Class<T> type)

Retrieve a list of beans of the specified type from the given BeanFactory, sorted based on their order.

If the provided BeanFactory is an instance of ListableBeanFactory, it delegates to #getSortedBeans(ListableBeanFactory, Class) for retrieving and sorting the beans. Otherwise, it returns an empty list.

Example Usage

`List myServices = getSortedBeans(beanFactory, MyService.class);
`

Behavior

- Returns an unmodifiable list of beans sorted by their order.
- If no beans are found, returns an empty list.

getSortedBeans

public static <T> List<T> getSortedBeans(@Nonnull ListableBeanFactory beanFactory, @Nonnull Class<T> type)

Retrieve all beans of the specified type from the given ListableBeanFactory, sorted based on their order.

This method retrieves a map of bean names to bean instances matching the specified type and converts it into a list. The list is then sorted using AnnotationAwareOrderComparator based on the beans' order.

Example Usage

`List myServices = getSortedBeans(beanFactory, MyService.class);
`

Behavior

- Returns an unmodifiable list of beans sorted by their order.
- If no beans are found, returns an empty list.

invokeBeanInterfaces

public static void invokeBeanInterfaces(@Nullable Object bean, @Nullable ApplicationContext context)

Invokes the standard Spring bean lifecycle interfaces in a specific order for the given bean and application context.

This method delegates to #invokeBeanInterfaces(Object, ConfigurableApplicationContext) after converting the provided ApplicationContext into a ConfigurableApplicationContext, allowing further processing if needed.

Invoke Spring Bean interfaces in order:

- `BeanNameAware`
- `BeanClassLoaderAware`
- `BeanFactoryAware`
- `EnvironmentAware`
- `EmbeddedValueResolverAware`
- `ResourceLoaderAware`
- `ApplicationEventPublisherAware`
- `MessageSourceAware`
- `ApplicationStartupAware` (Spring Framework 5.3+)
- `ApplicationContextAware`
- `InitializingBean`

Example Usage

`MyBean myBean = new MyBean();
ApplicationContext context = ...; // Obtain or create an ApplicationContext
invokeBeanInterfaces(myBean, context);
`

Behavior

- If the provided bean implements any of the supported lifecycle interfaces, their respective methods will be invoked.
- The order of invocation follows the standard Spring lifecycle contract.

invokeBeanInterfaces

public static void invokeBeanInterfaces(@Nullable Object bean, @Nullable ConfigurableApplicationContext context)

Invokes the standard Spring bean lifecycle interfaces in a specific order for the given bean and application context.

This method ensures that all relevant lifecycle callbacks are executed in the correct sequence, starting with the Aware interface methods followed by the InitializingBean#afterPropertiesSet() method.

Example Usage

`MyBean myBean = new MyBean();
ConfigurableApplicationContext context = ...; // Obtain or create a ConfigurableApplicationContext
BeanUtils.invokeBeanInterfaces(myBean, context);
`

Lifecycle Invocation Order

- `BeanNameAware`
- `BeanClassLoaderAware`
- `BeanFactoryAware`
- `EnvironmentAware`
- `EmbeddedValueResolverAware`
- `ResourceLoaderAware`
- `ApplicationEventPublisherAware`
- `MessageSourceAware`
- `ApplicationStartupAware` (Spring Framework 5.3+)
- `ApplicationContextAware`
- `InitializingBean`

invokeInitializingBean

public static void invokeInitializingBean(@Nullable Object bean)

Invoke the InitializingBean#afterPropertiesSet() method if the given bean implements the interface.

This method is typically used to trigger post-processing logic after all bean properties have been set.

Example Usage

`MyInitializingBean myBean = new MyInitializingBean();
BeanUtils.invokeInitializingBean(myBean);
`

Behavior

- If the provided bean does not implement `InitializingBean`, this method has no effect.
- If an exception occurs during execution of `InitializingBean#afterPropertiesSet()`, it will be propagated.

invokeAwareInterfaces

public static void invokeAwareInterfaces(@Nullable Object bean, @Nullable BeanFactory beanFactory)

Invokes the Spring Aware interfaces implemented by the given bean if applicable.

This method supports a standard lifecycle invocation order for common Spring Aware interfaces:

- `BeanNameAware`
- `BeanClassLoaderAware`
- `BeanFactoryAware`

If the provided BeanFactory is also an instance of ApplicationContext, additional context-specific Aware interfaces will be invoked in sequence:

- `EnvironmentAware`
- `EmbeddedValueResolverAware`
- `ResourceLoaderAware`
- `ApplicationEventPublisherAware`
- `MessageSourceAware`
- `ApplicationStartupAware` (Spring Framework 5.3+)
- `ApplicationContextAware`

Example Usage

`MyBean myBean = new MyBean();
ConfigurableBeanFactory beanFactory = context.getBeanFactory();
BeanUtils.invokeAwareInterfaces(myBean, beanFactory);
`

Behavior

- No action is taken if the bean is null.
- Only relevant Aware interfaces are invoked based on the bean's implementation.

invokeAwareInterfaces

public static void invokeAwareInterfaces(@Nullable Object bean, @Nullable ConfigurableBeanFactory beanFactory)

Invokes the Spring Aware interfaces implemented by the given bean if applicable.

This method ensures that all relevant lifecycle callbacks are executed in the correct sequence, starting with the basic BeanNameAware, BeanClassLoaderAware, and BeanFactoryAware interfaces. If the provided bean factory is also an application context, additional context-specific aware interfaces will be invoked, including: Invoke the Aware interfaces in order :

- `BeanNameAware`
- `BeanClassLoaderAware`
- `BeanFactoryAware`

if the argument beanFactory is an instance of ApplicationContext, the more Aware interfaces will be involved :

- `EnvironmentAware`
- `EmbeddedValueResolverAware`
- `ResourceLoaderAware`
- `ApplicationEventPublisherAware`
- `MessageSourceAware`
- `ApplicationStartupAware` (Spring Framework 5.3+)
- `ApplicationContextAware`

Example Usage

`MyBean myBean = new MyBean();
ConfigurableBeanFactory beanFactory = context.getBeanFactory();
BeanUtils.invokeAwareInterfaces(myBean, beanFactory);
`

Behavior

- No action is taken if the bean is null.
- If the bean implements any of the supported interfaces, their respective methods will be invoked.
- If the bean factory is a context, more specific aware interfaces will be processed.

---

This documentation was auto-generated from the source code of microsphere-spring.