Spring扩展接口(1):ApplicationContextInitializer

spring,扩展,接口,applicationcontextinitializer · 浏览次数 : 69

小编点评

## Spring扩展接口及各个扩展点的使用场景 **Spring扩展接口** `ApplicationContextInitializer` 用于在应用程序上下文(`ApplicationContext`) 创建之前对其进行自定义初始化。通过实现该接口,您可以可以在应用程序上下文启动之前执行一些额外的配置或准备工作。 **使用场景:** 1. **动态加载配置:**通过实现 `ApplicationContextInitializer`,您可以可以在应用程序上下文创建之前加载一些动态的配置,例如从外部配置文件中读取配置信息并注入到Spring的环境中。 2. **额外的初始化逻辑:**如果您有一些需要在应用程序上下文启动之前执行的初始化逻辑,例如初始化数据库连接池或启动一些后台任务,您可以通过实现 `ApplicationContextInitializer` 来实现这些逻辑。 **实现步骤:** 1. 实现 `ApplicationContextInitializer` 接口。 2. 实现 `initialize` 方法,接受一个 `ConfigurableApplicationContext` 参数。 3. 创建并添加一个 `MapPropertySource` 对象,并将自定义属性源添加到应用程序上下文的属性源列表中。 **示例:** ```java @Override public void initialize(ConfigurableApplicationContext applicationContext) { MutablePropertySources propertySources = applicationContext.getEnvironment().getPropertySources(); Map customProperties = new HashMap<>(); customProperties.put("custom.property", "custom value"); MapPropertySource customPropertySource = new MapPropertySource("customPropertySource", customProperties); propertySources.addFirst(customPropertySource); } ``` **生效方式:** 1. 在 `SpringApplication` 中添加 `CustomApplicationContextInitializer`。 2. 在 `application.properties` 文件中配置 `context.initializer.classes`。 **总结:** 通过使用 Spring扩展接口,您可以动态加载配置、执行额外的初始化逻辑以及配置应用程序上下文。这种方法可以方便地扩展 Spring 应用程序,并确保它们在运行之前已经完成必要的配置。

正文

在此系列文章中,我总结了Spring扩展接口,以及各个扩展点的使用场景。并整理出一个bean在spring中从被加载到初始化到销毁的所有可扩展点的顺序调用图。这样,我们也可以看到bean是如何一步步加载到spring容器中的。


ApplicationContextInitializer

org.springframework.context.ApplicationContextInitializer

ApplicationContextInitializer是Spring框架中的一个扩展接口,用于在应用程序上下文(ApplicationContext)创建之前对其进行自定义初始化。通过实现该接口,您可以在应用程序上下文启动之前执行一些额外的配置或准备工作。

实现ApplicationContextInitializer接口需要实现其唯一的方法initialize,该方法接受一个泛型参数C extends ConfigurableApplicationContext,表示正在创建的应用程序上下文。在该方法中,您可以对应用程序上下文进行各种自定义操作,例如添加属性源、注册Bean定义、设置环境变量等。

1、应用场景:

  • 动态加载配置:通过实现ApplicationContextInitializer,您可以在应用程序上下文创建之前加载一些动态的配置,例如从外部配置文件中读取配置信息并注入到Spring的环境中。
  • 执行额外的初始化逻辑:如果您有一些需要在应用程序上下文启动之前执行的初始化逻辑,例如初始化数据库连接池或启动一些后台任务,您可以通过实现ApplicationContextInitializer来实现这些逻辑。

下面是一个示例,展示了如何实现一个ApplicationContextInitializer来添加一个自定义的属性源:

import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.MutablePropertySources;
import java.util.HashMap;
import java.util.Map;

public class CustomApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        MutablePropertySources propertySources = applicationContext.getEnvironment().getPropertySources();
        
        // 创建自定义的属性源
        Map<String, Object> customProperties = new HashMap<>();
        customProperties.put("custom.property", "custom value");
        MapPropertySource customPropertySource = new MapPropertySource("customPropertySource", customProperties);
        
        // 将自定义属性源添加到应用程序上下文的属性源列表中
        propertySources.addFirst(customPropertySource);
    }
}

2、生效方式

由于这时候spring容器还没被初始化,所以想要自己的扩展的生效,有以下三种方式:

  • 在启动类中加入springApplication.addInitializers(new TestApplicationContextInitializer())
@SpringBootApplication
public class SandySpringExApplication {

    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(SandySpringExApplication.class);
        application.addInitializers(new CustomApplicationContextInitializer()); // 直接在SpringApplication中添加
        application.run(args);
    }
}
  • 配置文件配置context.initializer.classes=com.example.demo.TestApplicationContextInitializer
# application.properties文件
context.initializer.classes = com.example.demo.CustomApplicationContextInitializer
  • Spring SPI扩展,在spring.factories中加入org.springframework.context.ApplicationContextInitializer=com.example.demo.CustomApplicationContextInitializer

在resources/META-INF添加spring.factories:

org.springframework.context.ApplicationContextInitializer = com.sandy.springex.applicationcontextinitializer.CustomApplicationContextInitializer

与Spring扩展接口(1):ApplicationContextInitializer相似的内容:

Spring扩展接口(1):ApplicationContextInitializer

在此系列文章中,我总结了Spring扩展接口,以及各个扩展点的使用场景。并整理出一个bean在spring中从被加载到初始化到销毁的所有可扩展点的顺序调用图。这样,我们也可以看到bean是如何一步步加载到spring容器中的。 ApplicationContextInitializer org.sp

Spring扩展接口(2):BeanDefinitionRegistryPostProcessor

在此系列文章中,我总结了Spring几乎所有的扩展接口,以及各个扩展点的使用场景。并整理出一个bean在spring中从被加载到最终初始化的所有可扩展点的顺序调用图。这样,我们也可以看到bean是如何一步步加载到spring容器中的。 BeanDefinitionRegistryPostProces

【Spring】BeanPostProcessor后置处理器

BeanPostProcessor后置处理器是Spring提供的一个扩展点,可以在Bean初始化前后做一些事情,注意这里是bean的初始化,不是实例化,BeanPostProcessor是一个接口,里面提供了两个方法,分别为postProcessBeforeInitialization(初始化之前)

Spring缓存是如何实现的?如何扩展使其支持过期删除功能?

我们希望将这些rpc结果数据缓存起来,并在一定时间后自动删除,以实现在一定时间后获取到最新数据。类似Redis的过期时间。本文是我的调研步骤和开发过程。

Bean生命周期的扩展点:Bean Post Processor

摘要:在本篇文章中,我们将深入探讨Spring框架中的重要组件——BeanPostProcessor。首先,我们将了解其设计理念和目标,然后通过实际的例子学习如何基础使用它,如何通过BeanPostProcessor改变Bean的初始化结果以及如何利用它修改Bean的属性。 本文分享自华为云社区《S

Eureka Server 实现在线扩容

Eureka Server 实现在线扩容 作者:Grey 原文地址: 博客园:Eureka Server 实现在线扩容 CSDN:Eureka Server 实现在线扩容 需求 Eureka 是 Spring Cloud Netflix 套件中的服务注册中心组件,作为微服务的核心组件,需要支持在线扩

上周热点回顾(6.3-6.9)

热点随笔: · C#开源实用的工具类库,集成超过1000多种扩展方法 (追逐时光者)· RabbitMQ 进阶使用之延迟队列 → 订单在30分钟之内未支付则自动取消 (青石路)· .Net 中间件 - 新开源代码生成器 -ReZero (阿妮亚)· C#.Net筑基-String字符串超全总结 [深

spring-关于组件的注入及获取流程

一、组件注入的基本流程: 容器初始化: Spring应用启动时,会读取配置(如XML配置、注解配置等),并根据这些配置创建Bean定义(BeanDefinition)。 根据Bean定义,Spring容器实例化Bean,并管理它们之间的依赖关系。 依赖解析与注入: 当一个Bean依赖于另一个Bean

Spring的三种依赖注入的方式

1、什么是依赖注入 依赖注入(Dependency Injection,简称DI),是IOC的一种别称,用来减少对象间的依赖关系。 提起依赖注入,就少不了IOC。 IOC(Inversion of Control,控制反转)是一种设计思想,它将原本在程序中手动创建对象的控制权,交由Spring框架来

使用 Spring 实现控制反转和依赖注入

使用 Spring 实现控制反转和依赖注入 概述 在本文中,我们将介绍IoC(控制反转)和DI(依赖注入)的概念,以及如何在Spring框架中实现它们。 什么是控制反转? 控制反转是软件工程中的一个原则,它将对象或程序的某些部分的控制权转移给容器或框架。我们最常在面向对象编程的上下文中使用它。 与传