Spring Boot：如何在DataSource Bean初始化前执行自定义代码？

我刚好处理过类似的场景，既能保留你想要的spring.datasource.*自动配置机制，又能确保DataSource初始化前Cloud SQL实例已经就绪，给你几个按推荐程度排序的实现方式：

方法1：@DependsOn + 自定义初始化Bean（最推荐，最符合Spring规范） #

核心思路很简单：先搞个专门负责Cloud SQL实例预配置的Bean，然后让Spring Boot自动生成的DataSource必须等这个Bean初始化完再创建。Spring的依赖管理会帮你搞定顺序问题。

第一步：写Cloud SQL初始化的Bean #

import com.google.cloud.sql.admin.v1.SqlAdminServiceClient;
import com.google.cloud.sql.admin.v1.SqlInstance;
import org.springframework.stereotype.Component;

@Component
public class CloudSqlInstanceInitializer {

    // 构造方法会在Bean初始化时自动执行
    public CloudSqlInstanceInitializer() {
        // 这里写你的Cloud SQL Admin API逻辑：检查实例是否存在、创建实例、配置数据库/用户等
        try (SqlAdminServiceClient client = SqlAdminServiceClient.create()) {
            String projectId = "你的GCP项目ID";
            String instanceId = "你的SQL实例ID";
            
            // 示例逻辑：先查实例是否存在，不存在就创建
            SqlInstance existingInstance = client.getInstance(projectId, instanceId);
            if (existingInstance == null) {
                // 替换成你实际的实例创建代码
                System.out.println("正在创建Cloud SQL实例...");
                // 比如调用client.insertInstance()方法
            } else {
                // 可以加个状态检查，确保实例是RUNNING状态
                System.out.println("Cloud SQL实例已就绪，跳过初始化");
            }
        } catch (Exception e) {
            // 初始化失败直接抛异常，阻止应用启动，避免后续DataSource连接出错
            throw new RuntimeException("Cloud SQL实例初始化失败", e);
        }
    }
}

第二步：让DataSource依赖这个初始化Bean #

因为DataSource是Spring Boot自动配置的，我们需要通过一个配置类来修改它的依赖关系：

import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;

@Configuration
public class DataSourceDependencyConfig {

    // 重新定义DataSourceProperties的Bean，让它依赖我们的初始化Bean
    // 因为DataSource的创建依赖DataSourceProperties，这样就能保证初始化逻辑先执行
    @Bean
    @DependsOn("cloudSqlInstanceInitializer")
    public DataSourceProperties dataSourceProperties() {
        return new DataSourceProperties();
    }
}

这样Spring容器会严格按照cloudSqlInstanceInitializer → dataSourceProperties → dataSource的顺序初始化，完美满足你的需求。

方法2：监听ApplicationStartingEvent（适合极早执行） #

如果你需要在Spring容器启动的最早期就执行预配置（甚至在Bean定义加载之前），可以监听Spring Boot的ApplicationStartingEvent：

import com.google.cloud.sql.admin.v1.SqlAdminServiceClient;
import org.springframework.boot.context.event.ApplicationStartingEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class CloudSqlPreInitializer implements ApplicationListener<ApplicationStartingEvent> {

    @Override
    public void onApplicationEvent(ApplicationStartingEvent event) {
        // 这里执行你的Cloud SQL预配置逻辑
        try (SqlAdminServiceClient client = SqlAdminServiceClient.create()) {
            // 你的实例配置代码...
            System.out.println("在应用启动最早期执行Cloud SQL预配置");
        } catch (Exception e) {
            throw new RuntimeException("Cloud SQL预配置失败", e);
        }
    }
}

这个事件是Spring Boot启动时第一个触发的事件，此时还没有任何Bean被初始化，适合做全局的预准备工作。不过要注意，此时Spring上下文还没完全建立，不能依赖其他Spring Bean。

方法3：BeanFactoryPostProcessor（高级灵活用法） #

如果你需要更精细地控制Bean的创建顺序，可以直接修改DataSource的Bean定义，添加依赖：

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.stereotype.Component;

@Component
public class DataSourceBeanModifier implements BeanFactoryPostProcessor {

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 获取Spring Boot自动配置的DataSource Bean定义
        BeanDefinition dataSourceBean = beanFactory.getBeanDefinition("dataSource");
        // 让它依赖我们的CloudSqlInstanceInitializer
        dataSourceBean.setDependsOn(new String[]{"cloudSqlInstanceInitializer"});
    }
}

这种方式直接操作Spring的Bean工厂，灵活性很高，但需要你对Spring的Bean生命周期有一定了解，适合有经验的开发者。

几个注意点 #

• 确保你的Cloud SQL Admin API客户端已经正确配置认证：比如在本地用服务账号密钥，在GCP环境中用默认服务账号
• 预配置逻辑要做好异常处理：如果实例创建/检查失败，一定要抛异常阻止应用启动，避免后续DataSource连接失败
• 可以加重试逻辑：Cloud SQL实例创建需要时间，你可以在初始化Bean中轮询实例状态，直到它变成RUNNING状态

内容的提问来源于stack exchange，提问作者jigga