《Spring6》第19节：Bean的生命周期接口之EnvironmentAware介绍

前面10几个小节的内容，已经将Spring中的依赖注入、自动装配、Bean标签相关属性都已经介绍完了，这里我们就继续学习Spring生命周期相关的内容。在之前的文章里面，虽然也有提到生命周期这个概念，但是都是简单的一笔带过，并没有深入的介绍，从这篇文章开始，我将专门来介绍一下Bean的生命周期中涉及到的几个常见接口。

在Spring的生命周期里面，提供了很多个以Aware结尾的接口，这些接口的作用是为了让程序开发人员可以自定义扩展一些Bean功能。需要注意的是，这些Aware接口是在Bean对象属性赋值完成之后才会被调用，Spring中具体提供了哪些Aware接口，可以查看下面的文档地址：

Aware接口文档地址：【https://docs.spring.io/spring-framework/docs/6.0.0-M3/reference/html/core.html#aware-list】

前2个小节内容介绍了BeanPostProcessor后置处理器接口，以及多个处理器接口之间的执行顺序问题，不了解的小伙伴可以看下我之前的文章，或者查看官方文档：

BeanPostProcessor官方教程文档：【https://docs.spring.io/spring-framework/docs/6.0.0-M3/reference/html/core.html#beans-factory-extension-bpp】

1.1、EnvironmentAware介绍

EnvironmentAware也是Bean生命周期中的一个回调接口，通过这个EnvironmentAware接口可以获取到当前应用程序的运行环境信息，该接口中只有一个setEnvironment()方法。

在Bean对象初始化之前，Spring会调用setEnvironment()方法，将当前应用程序的运行环境对象Environment赋值到Bean对象里面，这样我们就可以在Bean对象中，获取到Environment对象，调用相应的方法完成业务逻辑处理即可。

Environment是一个接口，继承自PropertyResolver接口，通过接口名称就可以看出，PropertyResolver接口的作用是解析属性的，该接口中提供了获取运行环境属性的相关方法，常见方法如下所示：

• containsProperty(String key)：当前运行环境中，是否包含指定key名称属性。
• getProperty(String key)：当前运行环境中，获取指定key名称的属性值。
• resolvePlaceholders(String text)：当前运行环境中，根据${}表达式，获取表达式对应的属性值。
• getActiveProfiles()：获取当前运行环境中，被激活的Profiles环境信息，Profiles可以使用"spring.profiles.active"属性配置。
• getDefaultProfiles()：获取当前运行环境中，默认的Profiles环境信息。
• acceptsProfiles(Profiles profiles)：验证当前运行环境是否满足Profiles属性配置。

1.2、案例代码

下面就通过具体的代码，来看看如何使用EnvironmentAware接口，这里我也使用到了前几个小节学习的相关接口，目的是为了看下Aware相关接口之间的先后执行顺序。

• 创建AService测试类，并且实现EnvironmentAware接口。

package com.spring.study;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.*;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;

/**
 * @author ZhuYouBin
 * @version 1.0.0
 * @date 2024/9/2 14:58
 * @description
 */
public class AService implements InitializingBean, DisposableBean, BeanNameAware,
        BeanFactoryAware, ApplicationContextAware, EnvironmentAware {
    public AService() {
        System.out.println("AService 实例化");
    }

    private String name;
    /**
     * 暂时保存起来，这样后续的类可以直接使用
     */
    private static ApplicationContext applicationContext;

    public void setName(String name) {
        this.name = name;
        System.out.println("AService name 属性赋值");
    }

    /**
     * init-method 定义的方法
     */
    public void initMethod() {
        System.out.println("AService 调用 init-method 属性定义的 initMethod() 初始化方法");
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("AService 调用 InitializingBean.afterPropertiesSet() 初始化方法");
    }

    @Override
    public void destroy() throws Exception {
        System.out.println("AService 调用 DisposableBean.destroy() 销毁方法");
    }

    public void destroyMethod() {
        System.out.println("AService 调用 destroy-method 属性定义的 destroyMethod() 销毁方法");
    }

    @Override
    public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
        System.out.println("AService 调用 setBeanFactory() 方法");
    }

    @Override
    public void setBeanName(String name) {
        System.out.println("AService 调用 setBeanName() 方法, beanName = " + name);
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        System.out.println("AService 调用 setApplicationContext() 方法");
        AService.applicationContext = applicationContext;
    }

    @Override
    public void setEnvironment(Environment environment) {
        System.out.println("AService 调用 setEnvironment() 方法");
    }
}

• 添加XML配置信息。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
 https://www.springframework.org/schema/beans/spring-beans.xsd">
  <!--
    定义bean
  -->
  <bean id="aService" class="com.spring.study.AService" 
        init-method="initMethod" destroy-method="destroyMethod">
    <property name="name" value="ADemo"/>
  </bean>
</beans>

• 执行案例代码，结果如下。

查看控制台输出日志，可以看见每一个方法的先后执行顺序，这也是Bean的生命周期中会涉及到的一些方法回调顺序，如下所示：

0. 实例化。
1. 属性赋值。
2. 执行BeanNameAware接口。
3. 执行BeanFactoryAware接口。
4. 执行EnvironmentAware接口。
5. 执行ApplicationConextAware接口。
6. 按照优先级，依次执行BeanPostProcessor的postProcessBeforeInitialization()前置方法。
7. 执行InitializingBean接口。
8. 调用init-method初始化方法。
9. 按照优先级，依次执行BeanPostProcessor的postProcessAfterInitialization()后置方法。
10. 执行DisposableBean接口。
11. 调用destroy-method销毁方法。

1.3、源代码获取

源代码地址：

https://gitcode.com/knowledge-base/spring-study/tree/spring6-chapter-19

到此，Spring生命周期中EnvironmentAware接口就介绍完了，这个接口可以熟悉一下，日后在开发过程中，如果遇到要获取当前应用程序运行环境信息的需求，可以考虑这个接口是否能够实现。

今天就到这里，未完待续~~