SpringBoot中Aware接口使用及原理解析
作者:LBruse
Aware接口
在Spring
中存在一个Aware
接口,实现该接口可以让我们的Bean
获取到Spring
容器中特定的资源,但该接口只是个标记接口
,不存在任何方法,因此我们还需要继承Aware
来做特定资源获取的实现。
Spring
中有不少继承于Aware
的接口的实现,比如当前Bean
想要获取环境变量时,可以实现EnvironmentAware
接口,想要获取应用上下文则可以实现ApplicationContextAware
接口。
常用的Aware实现
接口 | 作用 |
---|---|
BeanClassLoaderAware | 获得类加载器 |
BeanNameAware | 获取容器中Bean名称 |
BeanFactoryAware | 获取bean创建工厂 |
EnvironmentAware | 获得环境变量 |
ResourceLoaderAware | 获取资源加载器 |
ApplicationEventPublisherAware | 获取应用事件发布器 |
MessageSourceAware | 获取文本信息 |
ApplicationContextAware | 获取当前应用上下文 |
Aware示例
以下做一个代码示例,实现EnvironmentAware
接口,获取到Environment
并尝试获取并输出自定义的属性。除了Aware
外,还涉及到之前提到的CommandLineRunner 和Property,可以点击回顾。
创建一个AwareCommandLineRunner
,实现EnvironmentAware
接口,并尝试获取并输出redis-host
属性
package geek.springboot.application.runner; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.CommandLineRunner; import org.springframework.context.EnvironmentAware; import org.springframework.core.env.Environment; import org.springframework.stereotype.Component; @Slf4j @Component public class AwareCommandLineRunner implements CommandLineRunner, EnvironmentAware { @Override public void run(String... args) throws Exception { log.info("AwareCommandLineRunner running..."); } @Override public void setEnvironment(Environment environment) { String redisHost = environment.getProperty("redis-host"); log.info("redis-host is {}", redisHost); } }
SpringApplication
启动代码如下
package geek.springboot.application; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import java.util.Properties; @Slf4j @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication application = new SpringApplication(Application.class); // 添加redis-host配置 Properties properties = new Properties(); properties.setProperty("redis-host", "127.0.0.1"); application.setDefaultProperties(properties); application.run(args); } }
启动输出 2023-08-27 19:01:15.198 INFO 56188 --- [ main] g.s.a.runner.AwareCommandLineRunner : redis-host is 127.0.0.1
自定义Aware
新建一个RedisConfig
配置类
package geek.springboot.application.configuration; import lombok.Data; import org.springframework.stereotype.Component; @Data @Component public class RedisConfig { private String ip = "127.0.0.1"; private Integer port = 6379; @Override public String toString() { return "RedisConfig{" + "ip='" + ip + ''' + ", port=" + port + '}'; } }
创建一个RedisAware
接口,Bean
实现该接口即可获取RedisConfig
package geek.springboot.application.aware; import geek.springboot.application.configuration.RedisConfig; import org.springframework.beans.factory.Aware; /** * 自定义Aware * * @author Bruse */ public interface RedisAware extends Aware { void setRedisConfig(RedisConfig config); }
创建一个RedisAwareProcessor
,实现BeanPostProcessor
接口,由它具体负责将RedisConfig
注入实现了RedisAware
接口的Bean
。 为什么要实现BeanPostProcessor
后边的原理分析会提及。
package geek.springboot.application.aware; import geek.springboot.application.configuration.RedisConfig; import org.springframework.beans.BeansException; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.config.BeanPostProcessor; import org.springframework.context.ApplicationContext; import org.springframework.stereotype.Component; /** * 自定义RedisAwareProcessor * * @author Bruse */ @Component public class RedisAwareProcessor implements BeanPostProcessor { @Autowired private ApplicationContext context; @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { // 判断当前Bean是否实现RedisAware if (bean instanceof RedisAware) { // 强转,调用setRedisConfig方法注入RedisConfig ((RedisAware) bean).setRedisConfig(context.getBean(RedisConfig.class)); } return bean; } }
AwareCommandLineRunner
实现RedisAware
接口
package geek.springboot.application.runner; import geek.springboot.application.aware.RedisAware; import geek.springboot.application.configuration.RedisConfig; import lombok.extern.slf4j.Slf4j; import org.springframework.boot.CommandLineRunner; import org.springframework.context.EnvironmentAware; import org.springframework.core.env.Environment; import org.springframework.stereotype.Component; @Slf4j @Component public class AwareCommandLineRunner implements CommandLineRunner, EnvironmentAware, RedisAware { @Override public void run(String... args) throws Exception { log.info("AwareCommandLineRunner running..."); } @Override public void setEnvironment(Environment environment) { String redisHost = environment.getProperty("redis-host"); log.info("redis-host is {}", redisHost); } @Override public void setRedisConfig(RedisConfig config) { log.info("redis config: {}", config.toString()); } }
启动SpringApplication
,输出如下
2023-08-27 19:08:36.641 INFO 79920 --- [ main] g.s.a.runner.AwareCommandLineRunner : redis config: RedisConfig{ip='127.0.0.1', port=6379}
Aware原理
在AwareCommandLineRunner
的setEnvironment
方法打上断点,根据调用栈可以看到是在ApplicationContextAwareProcessor
的invokeAwareInterfaces()
方法中调用setEnvironment()
方法进Environment
注入的
接着再往上查找,可以看到invokeAwareInterfaces()
方法又是在postProcessBeforeInitialization()
中调用的
而ApplicationContextAwareProcessor
正好实现了BeanPostProcessor
接口。这也就是为什么上边自定义Aware
实现时,需要创建一个RedisAwareProcessor
并实现BeanPostProcessor
的原因
再往上查看调用栈的话,可以理清完整的从上到下Aware
调用链路
- 调用
AbstractAutowireCapableBeanFactory
的doCreateBean()
方法 - 调用
AbstractAutowireCapableBeanFactory
的initializeBean()
方法 - 调用
AbstractAutowireCapableBeanFactory
的applyBeanPostProcessorsBeforeInitialization()
方法 - 调用
ApplicationContextAwareProcessor
的postProcessBeforeInitialization()
方法 - 调用
ApplicationContextAwareProcessor
的invokeAwareInterfaces()
方法 - 调用
Aware
接口实现的方法
doCreateBean其实涉及到SpringBoot中Bea初始化的内容,可以看这一篇SpringBoot Bean实例化流程解析_java_脚本之家 (jb51.net)
以上就是SpringBoot中Aware接口使用及原理解析的详细内容,更多关于SpringBoot Aware接口的资料请关注脚本之家其它相关文章!