Spring Boot使用spring-vault-core时如何禁用Hashicorp Vault

以下是针对spring-vault-core场景的禁用方案，无需引入Spring Cloud Vault相关依赖：

方案1：条件化加载Vault配置（推荐） #

通过Spring Boot原生条件注解控制Vault相关配置和Bean是否初始化，灵活适配不同环境。

步骤1：修改Vault配置类 #

给现有VaultEnvironmentConfig类增加@ConditionalOnProperty注解，通过配置项控制配置类是否生效：

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.PropertySource;
import org.springframework.vault.config.EnvironmentVaultConfiguration;

@Configuration
@ConditionalOnProperty(prefix = "vault", name = "enabled", havingValue = "true", matchIfMissing = true)
@PropertySource(value = "file:/home/user/application.properties")
@Import(value = EnvironmentVaultConfiguration.class)
public class VaultEnvironmentConfig {}

注解参数说明：

• matchIfMissing = true 表示默认不配置vault.enabled时默认开启Vault，兼容现有逻辑
• 仅当配置vault.enabled=false时，该配置类不会加载，所有Vault相关Bean都不会初始化

步骤2：在需要禁用的环境添加开关配置 #

在对应环境的application.properties中添加配置即可关闭Vault：

vault.enabled=false

也可以在启动应用时通过命令行参数临时禁用，无需修改配置文件：

java -jar your-application.jar --vault.enabled=false

步骤3：处理VaultTemplate依赖兼容 #

关闭Vault后容器中不存在VaultTemplate实例，为避免注入报错，可根据业务需求选择以下处理方式：

• 禁用环境不需要操作Vault：将注入逻辑改为非必须，业务代码判断实例是否存在再调用

  @Autowired(required = false)
  private VaultTemplate vaultTemplate;
  
  // 业务调用逻辑
  public String getSecret(String key) {
      if (vaultTemplate != null) {
          return vaultTemplate.opsForKv().get(key).toString();
      }
      // 禁用Vault时走本地配置逻辑
      return localConfig.getSecret(key);
  }
  

• 需要兼容Vault相关接口调用：新增兜底配置类，注入空实现的VaultTemplate

  import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  import org.springframework.vault.core.VaultTemplate;
  
  @Configuration
  public class DisabledVaultConfig {
      @Bean
      @ConditionalOnMissingBean(VaultTemplate.class)
      public VaultTemplate fallbackVaultTemplate() {
          // 可自定义实现：返回Mock实例/抛指定异常/对接本地配置
          throw new UnsupportedOperationException("当前环境已禁用Vault，不支持相关操作");
      }
  }
  

方案2：静态排除配置（适用于固定禁用的场景） #

如果某个环境确定永远不需要启用Vault，可以直接修改启动类排除Vault相关配置：

@SpringBootApplication(exclude = {EnvironmentVaultConfiguration.class})
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

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