基于Spring Profile实现Spring Boot项目Vault的条件化禁用

针对你的spring-vault-core 2.2.3.RELEASE版本，结合已有的Spring Profile，有几种实用的方式实现Vault的条件化禁用：

方法1：通过配置属性开关（最简单） #

Spring Vault从2.x版本开始支持spring.vault.enabled配置属性，直接在不同Profile的配置文件中设置该值即可：

• 在启用Vault的Profile（比如prod）配置文件（application-prod.yml）中：

spring:
  vault:
    enabled: true
    # 其他Vault配置（地址、认证方式等）
    uri: http://your-vault-server:8200
    authentication: token
    token: your-vault-token

• 在需要禁用Vault的Profile（比如dev、test）配置文件（application-dev.yml）中：

spring:
  vault:
    enabled: false

切换到对应Profile时，Spring会自动启用/禁用Vault相关的自动配置组件。

方法2：自定义配置类结合Profile控制 #

如果项目有自定义的Vault配置类（比如继承AbstractVaultConfiguration），可以直接用@Profile注解限定该配置类仅在特定Profile下生效：

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.vault.config.AbstractVaultConfiguration;
import org.springframework.vault.authentication.TokenAuthentication;
import org.springframework.vault.client.VaultEndpoint;

@Configuration
@Profile("prod") // 仅在prod Profile下加载该配置
public class VaultConfig extends AbstractVaultConfiguration {

    @Override
    public ClientAuthentication clientAuthentication() {
        return new TokenAuthentication("your-vault-token");
    }

    @Override
    public VaultEndpoint vaultEndpoint() {
        return VaultEndpoint.create("your-vault-server", 8200);
    }
}

使用非prod的Profile时，这个配置类不会被加载，自然禁用Vault功能。

方法3：条件化排除Vault自动配置类 #

如果需要更精细的控制，可以通过@SpringBootApplication的exclude属性结合@ConditionalOnProfile来排除Vault的自动配置类：

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProfile;
import org.springframework.vault.autoconfigure.VaultAutoConfiguration;

@SpringBootApplication(exclude = {
    @ConditionalOnProfile(name = {"dev", "test"}, value = VaultAutoConfiguration.class)
})
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

这种方式会在dev或test Profile下排除Vault的自动配置类，从而禁用Vault相关功能。

注：方法1是最推荐的方案，配置简单且符合Spring Boot自动配置的设计理念。

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