Spring Aware 接口的作用詳解

在使用 Spring 框架進行開發時，有時候需要獲取 Spring 容器中的 bean 實例或者獲取一些環境信息等，在這樣的場景下，就需要使用 Spring Aware 接口。

一、BeanNameAware 接口

BeanNameAware 接口能夠讓 bean 獲取自己在 Spring 容器中的 Bean 名稱。其接口定義如下：

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

實現該接口的 bean 需要實現 setBeanName 方法，獲取到 bean 的名稱：

@Component
public class MyBeanNameAware implements BeanNameAware {
    private String beanName;
    
    @Override
    public void setBeanName(String name) throws BeansException {
        this.beanName = name;
    }
    
    public void printBeanName() {
        System.out.println("Bean Name: " + beanName);
    }
}

使用該 bean 時，可以調用 printBeanName 方法獲取其名稱：

@Autowired
private MyBeanNameAware myBeanNameAware;

@Test
public void testBeanNameAware() {
    myBeanNameAware.printBeanName(); // 輸出 Bean Name: myBeanNameAware
}

二、BeanFactoryAware 接口

BeanFactoryAware 接口讓 bean 獲取自己所在的工廠，其接口定義如下：

public interface BeanFactoryAware {
    void setBeanFactory(BeanFactory beanFactory) throws BeansException;
}

這裡的 BeanFactory 是 Spring 框架中定義的一個接口，其實現類是 DefaultListableBeanFactory。通過實現 BeanFactoryAware 接口，可以拿到 bean 所在的 BeanFactory 對象，進而獲取更多上下文信息。

@Component
public class MyBeanFactoryAware implements BeanFactoryAware {
    private BeanFactory beanFactory;
    
    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        this.beanFactory = beanFactory;
    }
    
    public void printBeanCount() {
        System.out.println("Bean Count: " + beanFactory.getBeanDefinitionCount());
    }
}

使用該 bean 時，可以調用 printBeanCount 方法，獲取 BeanFactory 中 Bean 的個數：

@Autowired
private MyBeanFactoryAware myBeanFactoryAware;

@Test
public void testBeanFactoryAware() {
    myBeanFactoryAware.printBeanCount();
}

三、ApplicationContextAware 接口

ApplicationContextAware 接口讓 bean 獲取應用上下文的信息，其接口定義如下：

public interface ApplicationContextAware {
    void setApplicationContext(ApplicationContext applicationContext) throws BeansException;
}

實現該接口的 bean 可以獲取應用上下文信息，例如獲取其路徑等一系列信息。

@Component
public class MyApplicationContextAware implements ApplicationContextAware {
    private ApplicationContext applicationContext;
    
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
    
    public void printPath() {
        System.out.println("Application Context Path: " + applicationContext.getApplicationName());
    }
}

使用該 bean 時，可以調用 printPath 方法獲取應用上下文的路徑：

@Autowired
private MyApplicationContextAware myApplicationContextAware;

@Test
public void testApplicationContextAware() {
    myApplicationContextAware.printPath();
}

四、EnvironmentAware 接口

EnvironmentAware 接口讓 bean 獲取環境信息，其接口定義如下：

public interface EnvironmentAware {
    void setEnvironment(Environment environment);
}

通過實現該接口，可以獲取前綴、後綴、屬性值等環境信息，下面是一個示例：

@Component
public class MyEnvironmentAware implements EnvironmentAware {
    private Environment environment;
    
    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
    
    public void printPrefix() {
        System.out.println("Prefix: " + environment.getProperty("spring.prefix"));
    }
}

使用該 bean 時，可以調用 printPrefix 方法獲取環境變量中的前綴信息：

@Autowired
private MyEnvironmentAware myEnvironmentAware;

@Test
public void testEnvironmentAware() {
    myEnvironmentAware.printPrefix();
}

五、ResourceLoaderAware 接口

ResourceLoaderAware 接口讓 bean 獲取資源加載器，其接口定義如下：

public interface ResourceLoaderAware {
    void setResourceLoader(ResourceLoader resourceLoader);
}

使用 ResourceLoaderAware 的目的是在 bean 中動態加載類路徑下的資源，例如加載配置文件等。下面是一個如何使用 ResourceLoaderAware 獲取資源的示例：

@Component
public class MyResourceLoaderAware implements ResourceLoaderAware {
    private ResourceLoader resourceLoader;
    
    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }
    
    public void readResource() throws IOException {
        Resource resource = resourceLoader.getResource("classpath:test.txt");
        BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()));
        String line;
        while ((line = reader.readLine()) != null) {
            System.out.println(line);
        }
    }
}

使用該 bean 時，可以調用 readResource 方法獲取類路徑下的 test.txt 文件內容：

@Autowired
private MyResourceLoaderAware myResourceLoaderAware;

@Test
public void testResourceLoaderAware() throws IOException {
    myResourceLoaderAware.readResource();
}