java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Spring Bean作用域、生命周期与自动装配

Spring Bean作用域、生命周期与自动装配深入解析

作者:九转苍翎

本文详细介绍了SpringBoot中Bean的作用域、生命周期以及自动装配的概念,Bean的作用域包括Singleton、Prototype、Request、Session和Application,文章还解析了SpringBoot的自动配置机制和Gitee上的相关资源,感兴趣的朋友跟随小编一起看看吧

SpringBoot版本:3.5.8

1.Bean的作用域

Spring Bean的作用域定义了Bean的作用范围,即Bean在哪些上下文中可用

/**
 * 实体类
 */
public class Dog {
}
/**
 * 配置类
 */
@Configuration
public class DogConfig {
    //单例
    @Bean
    @Scope(ConfigurableBeanFactory.SCOPE_SINGLETON)
    public Dog singleDog(){
        return new Dog();
    }
    //原型
    @Bean
    @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
    public Dog prototypeDog(){
        return new Dog();
    }
    //请求
    @Bean
    @RequestScope
    public Dog requestDog(){
        return new Dog();
    }
    //会话
    @Bean
    @SessionScope
    public Dog sessionDog(){
        return new Dog();
    }
    //应用
    @Bean
    @ApplicationScope
    public Dog applicationDog(){
        return new Dog();
    }
}
/**
 * 启动类
 */
@SpringBootApplication
public class SpringPrincipleApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringPrincipleApplication.class, args);
    }
}
/**
 * 视图层
 */
@RequestMapping("/test")
@RestController
public class TestController {
    private final Dog single;
    private final Dog prototype;
    private final Dog request;
    private final Dog session;
    private final Dog application;
    private final ApplicationContext context;
    public TestController(@Qualifier("singleDog") Dog single, @Qualifier("prototypeDog") Dog prototype,
                          @Qualifier("requestDog") Dog request, @Qualifier("sessionDog") Dog session,
                          @Qualifier("applicationDog") Dog application, ApplicationContext context) {
        this.single = single;
        this.prototype = prototype;
        this.request = request;
        this.session = session;
        this.application = application;
        this.context = context;
    }
    @RequestMapping("/single")
    public String single(){
        Dog singleDog = (Dog)context.getBean("singleDog");
        return "dog: " + this.single.toString() + "
" + "contextDog: " + singleDog;
    }
    @RequestMapping("/prototype")
    public String prototype(){
        Dog prototypeDog = (Dog)context.getBean("prototypeDog");
        return "dog: " + this.prototype.toString() + "
" + "contextDog: " + prototypeDog;
    }
    @RequestMapping("/request")
    public String request(){
        Dog requestDog = (Dog)context.getBean("requestDog");
        return "dog: " + this.request.toString() + "
" + "contextDog: " + requestDog;
    }
    @RequestMapping("/session")
    public String session(){
        Dog sessionDog = (Dog)context.getBean("sessionDog");
        return "dog: " + this.session.toString() + "
" + "contextDog: " + sessionDog;
    }
    @RequestMapping("/application")
    public String application(){
        Dog applicationDog = (Dog)context.getBean("applicationDog");
        return "dog: " + this.application.toString() + "
" + "contextDog: " + applicationDog;
    }
}

Singleton(单例):默认作用域,每个Spring容器中仅存在一个Bean实例

Prototype(原型):每次请求Bean时都会创建一个新的实例

Application(应用):整个Web应用共享一个Bean实例

2. Bean的生命周期

生命周期指的是一个对象从创建到销毁的整个生命过程。Bean的生命周期分为以下5个部分:

2.1 示例

/**
 * 实体类
 */
public class Cat {
}
/**
 * 配置类
 */
@Configuration
public class CatConfig {
    @Bean
    public Cat cat(){
        return new Cat();
    }
}
/**
 * 实现类
 */
@Component
@Slf4j
public class BeanLifeComponent implements BeanNameAware, BeanPostProcessor, InitializingBean {
    private Cat cat;
    //1.实例化:执行构造方法
    public BeanLifeComponent() {
        log.info("1.实例化:执行构造方法");
    }
    //2.属性赋值:执行setter方法
    @Autowired
    public void setCat(Cat cat) {
        log.info("2.属性赋值:执行setter方法");
        this.cat = cat;
    }
    //3.1 通知方法调用
    @Override
    public void setBeanName(String name) {
        log.info("3.1 通知方法调用,bean name is {}", name);
    }
    //3.2 前置处理
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        log.info("3.3 前置处理,bean:{},beanName:{}", bean, beanName);
        return BeanPostProcessor.super.postProcessBeforeInitialization(bean, beanName);
    }
    //3.3初始化回调
    @Override
    public void afterPropertiesSet() {
        log.info("3.2初始化回调");
    }
    //3.4后置处理
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        log.info("3.4后置处理,bean:{},beanName:{}", bean, beanName);
        return BeanPostProcessor.super.postProcessAfterInitialization(bean, beanName);
    }
    //4.使用Bean
    public void use(){
        log.info("4.使用Bean");
    }
    //5.销毁Bean
    @PreDestroy
    public void preDestroy(){
        log.info("5.销毁Bean");
    }
}
/**
 * 测试类
 */
@SpringBootTest
class SpringPrincipleApplicationTests {
    private final ApplicationContext context;
    @Autowired
    public SpringPrincipleApplicationTests(ApplicationContext context) {
        this.context = context;
    }
    @Test
    public void test(){
        BeanLifeComponent beanLifeComponent = context.getBean(BeanLifeComponent.class);
        beanLifeComponent.use();
    }
}

日志显示的顺序是:

  • invokeInitMethods(初始化回调)
  • applyBeanPostProcessorsBeforeInitialization(前置处理)
  • applyBeanPostProcessorsAfterInitialization(后置处理)

这看起来与我上述介绍的生命周期流程相矛盾,具体解释放在源码解析后

2.2 源码解析

AbstractAutowireCapableBeanFactory 类的作用:主要负责Bean的创建、依赖注入以及初始化等生命周期管理
(该思维导图中的图片看不清楚,原图放在下述流程中)

3.1

3.2

3.3 初始化:initializeBean方法中依次调用了invokeAwareMethodsapplyBeanPostProcessorsBeforeInitializationinvokeInitMethodsapplyBeanPostProcessorsAfterInitialization方法

3.3.1

3.3.2

3.3.3

3.3.4

2.3 日志与源码“冲突”的原因分析

根据源码来看,正确的生命周期流程是:前置处理 → 初始化回调 → 后置处理。与上述我运行输出的日志相矛盾

关键点:BeanPostProcessor本身也是Bean,当Spring初始化一个BeanPostProcessor实现类(BeanLifeComponent类)时,这个过程是递归的

执行流程分析:

上述日志中的情况解释:日志显示的是 一个BeanPostProcessor实现类(BeanLifeComponent类)的初始化过程:

3.SpringBoot自动装配

作用:自动注册Bean到Spring容器,不需要手动配置,通过约定大于配置的方式减少手动配置的复杂性。换言之,SpringBoo的自动配置就是将依赖Jar包中的配置类以及Bean加载到Ioc容器的过程

3.1 SpringBoot加载Bean

在pom.xml文件中引入第三方依赖,实际上就是将第三方代码引入到SpringBoot项目中。SpringBoot项目在启动时能识别这些依赖并自动将它们的配置类以及Bean加载到Ioc容器的过程。下面,我将编写代码作为第三方依赖,深入解析SpringBoot加载Bean的原理

创建目录

编写代码

/**
 * 配置类
 */
@Slf4j
@Component
public class TestConfig {
    public void demo(){
        log.info("demo");
    }
}
/**
 * 测试类
 */
@SpringBootTest
public class SpringPrincipleApplicationTests {
    private final ApplicationContext context;
    @Autowired
    public SpringPrincipleApplicationTests(ApplicationContext context) {
        this.context = context;
    }
    @Test
    public void demo(){
        TestConfig testConfig = context.getBean(TestConfig.class);
        testConfig.demo();
    }
}

运行项目

下面介绍几种解决方法

3.1.1 @ComponentScan

作用:告诉Spring容器去哪里扫描那些被@Component、@Service、@Repository、@Controller等注解标记的类,并将它们自动注册为Bean

@SpringBootApplication
@ComponentScan("com.example.springprincicle.component")
public class SpringPrincipleApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringPrincipleApplication.class, args);
    }
}

3.1.2 @Import

作用:用于将一个或多个配置类、组件类或其他类导入到当前的Spring应用上下文中

用法一:导入单个类

@SpringBootApplication
@Import(TestConfig.class)
public class SpringPrincipleApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringPrincipleApplication.class, args);
    }
}

用法二:ImportSelector接口实现类

@Slf4j
@Component
public class DemoConfig {
    public void demo(){
        log.info("demo");
    }
}
public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.example.springprincicle.component.TestConfig",
                "com.example.springprincicle.component.DemoConfig"};
    }
}
@SpringBootTest
public class SpringPrincipleApplicationTests {
    private final ApplicationContext context;
    @Autowired
    public SpringPrincipleApplicationTests(ApplicationContext context) {
        this.context = context;
    }
    @Test
    public void demo(){
        TestConfig testConfig = context.getBean(TestConfig.class);
        testConfig.demo();
        DemoConfig demoConfig = context.getBean(DemoConfig.class);
        demoConfig.demo();
    }
}

3.1.3 自定义注解

在使用@Import注解导入Bean时,需要程序员熟悉第三方依赖的所有配置类、组件类或其他类,这对于程序员开发程序十分不友好。所以,应该由依赖的开发者来做这件事

比较常见的方案就是第三方依赖给我们提供一个注解,该注解内部封装@Import注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(MyImportSelector.class)
public @interface EnableTestConfig {
}
@SpringBootApplication
@EnableTestConfig
public class SpringPrincipleApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringPrincipleApplication.class, args);
    }
}

3.2 @SpringBootApplication源码解析

@SpringBootApplication是一个组合注解,包含以下三个核心注解的功能

3.2.1 @ComponentScan

3.2.2 @SpringBootConfiguration

3.2.3 @EnableAutoConfiguration

AutoConfigurationImportSelector类:它实现了 DeferredImportSelector 接口,负责在Spring 应用启动时动态加载自动配置类

    //JDK源码,AutoConfigurationImportSelector类
    @Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
	}
	protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return EMPTY_ENTRY;
		}
		AnnotationAttributes attributes = getAttributes(annotationMetadata);
		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
		configurations = removeDuplicates(configurations);
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		checkExcludedClasses(configurations, exclusions);
		configurations.removeAll(exclusions);
		configurations = getConfigurationClassFilter().filter(configurations);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}
	//JDK源码,AutoConfigurationImportSelector类
    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
		ImportCandidates importCandidates = ImportCandidates.load(this.autoConfigurationAnnotation,
				getBeanClassLoader());//扫描类路径下的 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件
		List<String> configurations = importCandidates.getCandidates();//从 ImportCandidates 对象中获取所有找到的自动配置类名,这些类名是从 .imports 文件中读取的
		Assert.state(!CollectionUtils.isEmpty(configurations),
				"No auto configuration classes found in " + "META-INF/spring/"
						+ this.autoConfigurationAnnotation.getName() + ".imports. If you "
						+ "are using a custom packaging, make sure that file is correct.");
		return configurations;
	}

fireAutoConfigurationImportEvents(List<String> configurations, Set<String> exclusions):体现了Spring Framework/Spring Boot的向后兼容性设计。即使在 Spring Boot 3.x 中引入了新的 .imports 机制,Spring Framework 仍然保留了 spring.factories 的支持

    //JDK源码,AutoConfigurationImportSelector类
    private void fireAutoConfigurationImportEvents(List<String> configurations, Set<String> exclusions) {
		List<AutoConfigurationImportListener> listeners = getAutoConfigurationImportListeners();
		if (!listeners.isEmpty()) {
			AutoConfigurationImportEvent event = new AutoConfigurationImportEvent(this, configurations, exclusions);
			for (AutoConfigurationImportListener listener : listeners) {
				invokeAwareMethods(listener);
				listener.onAutoConfigurationImportEvent(event);
			}
		}
	}
	protected List<AutoConfigurationImportListener> getAutoConfigurationImportListeners() {
		return SpringFactoriesLoader.loadFactories(AutoConfigurationImportListener.class, this.beanClassLoader);
	}
	public static <T> List<T> loadFactories(Class<T> factoryType, @Nullable ClassLoader classLoader) {
		return forDefaultResourceLocation(classLoader).load(factoryType);
	}
	public static SpringFactoriesLoader forDefaultResourceLocation(@Nullable ClassLoader classLoader) {
		return forResourceLocation(FACTORIES_RESOURCE_LOCATION, classLoader);
	}
	public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

4.Gitee

Gitee地址:九转苍翎
本文源码:spring-principle

到此这篇关于拆解Spring Bean作用域、生命周期与自动装配的文章就介绍到这了,更多相关Spring Bean作用域、生命周期与自动装配内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文