Spring Boot：EnvironmentAware绑定前添加自定义转换器处理GCP秘钥转换

方案一：自定义Binder的ConversionService（适用于必须在早期绑定属性的场景） #

在setEnvironment方法中，为Binder配置包含ByteString转String转换器的自定义ConversionService，绑定属性时就能自动完成类型转换：

@Component
public class PropertiesRegistrar implements BeanDefinitionRegistryPostProcessor, EnvironmentAware {

    private ConfigProperties configProperties;

    @Override
    public void setEnvironment(@NotNull Environment environment) {
        // 创建自定义ConversionService并添加转换器
        DefaultConversionService conversionService = new DefaultConversionService();
        conversionService.addConverter((Converter<ByteString, String>) source -> source.toStringUtf8());

        // 使用自定义ConversionService构建Binder并绑定属性
        configProperties = Binder.get(environment)
                .withConversionService(conversionService)
                .bind("custom-props", ConfigProperties.class)
                .orElseThrow(() -> new InvalidConfigurationException("No config properties found"));
    }

    @Override
    public void postProcessBeanDefinitionRegistry(@NotNull BeanDefinitionRegistry registry) throws BeansException {
        // 这里使用configProperties注册自定义Bean
    }

    @Override
    public void postProcessBeanFactory(@NotNull ConfigurableListableBeanFactory beanFactory) throws BeansException {
        // 无需额外处理
    }
}

原理 #

Binder允许直接指定ConversionService，该操作发生在上下文初始化的极早期，无需依赖ApplicationContext中注册的Converter，因此能解决时机过早导致的转换器无效问题。

方案二：依赖Spring自动绑定的ConfigProperties（更简洁的方案） #

由于ConfigProperties已经标注了@ConfigurationProperties，Spring会自动完成属性绑定（包括GCP秘钥的类型转换），你可以调整Bean注册时机，等到ConfigProperties实例化完成后再执行自定义Bean注册：

@Component
public class PropertiesRegistrar implements SmartInitializingSingleton, ApplicationContextAware {

    @Autowired
    private ConfigProperties configProperties;

    private ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }

    @Override
    public void afterSingletonsInstantiated() {
        BeanDefinitionRegistry registry = (BeanDefinitionRegistry) applicationContext.getAutowireCapableBeanFactory();
        // 在这里使用已完成绑定的configProperties注册自定义Bean
    }
}

原理 #

SmartInitializingSingleton的afterSingletonsInstantiated方法会在所有单例Bean实例化并完成属性填充后执行，此时ConfigProperties已经通过Spring的自动绑定机制完成了ByteString到String的转换，无需手动处理类型转换逻辑。

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