Spring BeanNameAware interface

The BeanNameAware interface in Spring is part of the Spring Framework's mechanism 

for providing beans with their own bean names. 

It is an interface that a bean can implement to be aware of its own name within the Spring container.

BeanNameAware Interface

The BeanNameAware interface has a single method:

public interface BeanNameAware {
    void setBeanName(String name);
}

When a bean implements this interface, Spring will call the setBeanName method with the name of the bean as defined in the Spring configuration.
Usage of BeanNameAware
Implementing the BeanNameAware interface can be useful in scenarios where a bean needs to know its own name for logging, debugging, or any other purpose.
Here is an example to illustrate its use:

import org.springframework.beans.factory.BeanNameAware;
import org.springframework.stereotype.Component;

@Component

public class MyBean implements BeanNameAware {

    private String beanName;

    @Override

    public void setBeanName(String name) {

        this.beanName = name;

        System.out.println("Bean name set to: " + beanName);

    }

    public void printBeanName() {

        System.out.println("The bean name is: " + beanName);

    }

}

In this example:

1. Bean Implementation:

   • The MyBean class implements BeanNameAware and overrides the setBeanName method to capture the bean's name.

2. Component Annotation:

   • The @Component annotation tells Spring to treat this class as a Spring bean and automatically register it in the application context.

3. Bean Name Logging:

   • The setBeanName method captures and prints the bean name when the bean is instantiated.

4. Accessing Bean Name:

   • The printBeanName method can be used to print the bean name whenever required.

 

Configuration and Execution

To see this in action, you can create a simple Spring Boot application:

import org.springframework.boot.CommandLineRunner;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.context.ApplicationContext;

import org.springframework.context.annotation.Bean;

@SpringBootApplication

public class BeanNameAwareExampleApplication {

    public static void main(String[] args) {

        SpringApplication.run(BeanNameAwareExampleApplication.class, args);

    }

    @Bean

    public CommandLineRunner commandLineRunner(ApplicationContext ctx) {

        return args -> {

            MyBean myBean = ctx.getBean(MyBean.class);

            myBean.printBeanName();

        };

    }

}