属性源

Vault 可以以多种不同的方式使用。一个特定的用例是使用 Vault 来存储加密的属性。Spring Vault 支持将 Vault 作为属性 source 使用 Spring 的 PropertySource 抽象获取配置属性。spring-doc.cn

您可以在其他属性源中引用存储在 Vault 中的属性，或者将值注入与一起使用。在引导需要数据存储在 Vault 内的 bean 时，需要特别注意。此时必须初始化 VaultPropertySource 才能从 Vault 中检索属性。@Value(…)

Spring Boot/Spring Cloud 用户可以从 Spring Cloud Vault 的配置集成，用于在应用程序启动期间初始化各种属性源。

注册`VaultPropertySource`

Spring Vault 提供了一个 VaultPropertySource，用于 Vault 以获取性能。它使用嵌套元素来公开 stored 和在 Vault 中加密。dataspring-doc.cn

ConfigurableApplicationContext ctx = new GenericApplicationContext();
MutablePropertySources sources = ctx.getEnvironment().getPropertySources();
sources.addFirst(new VaultPropertySource(vaultTemplate, "secret/my-application"));

在上面的代码中，添加了具有最高优先级的 VaultPropertySource 在搜索中。如果它包含 'foo' 属性，则将被检测并返回在任何其他 . 公开了许多允许精确操作属性源集。fooPropertySourceMutablePropertySourcesspring-doc.cn

@VaultPropertySource

注解提供了一个方便且声明性的将 a 添加到 Spring 以与 classes 结合使用的机制。@VaultPropertySourcePropertySourceEnvironment@Configurationspring-doc.cn

@VaultPropertySource采用 Vault 路径（如 and ）将存储在节点中的数据公开在 . 支持与租约关联的密钥的租约（即来自后端的凭证）和终端上的凭证轮换租约到期。默认情况下，租约续订处于禁用状态。secret/my-applicationPropertySource@VaultPropertySourcemysqlspring-doc.cn

示例 1.存储在 Vault 中的属性

{
  // …

  "data": {
    "database": {
      "password": ...
    },
    "user.name": ...,
  }

  // …
}

示例 2.声明@VaultPropertySource

@Configuration
@VaultPropertySource("secret/my-application")
public class AppConfig {

    @Autowired Environment env;

    @Bean
    public TestBean testBean() {
        TestBean testBean = new TestBean();
        testBean.setUser(env.getProperty("user.name"));
        testBean.setPassword(env.getProperty("database.password"));
        return testBean;
    }
}

例 3.声明具有凭证轮换和前缀的@VaultPropertySource

@Configuration
@VaultPropertySource(value = "aws/creds/s3-access",
                     propertyNamePrefix = "aws.",
                     renewal = Renewal.ROTATE)
public class AppConfig {
  // provides aws.access_key and aws.secret_key properties
}

从秘密后端获得的秘密与 TTL （）相关联，而不是与租约 ID 相关联。Spring Vault 在达到其 TTL 时轮换通用秘密。genericrefresh_intervalPropertySource

您可以使用从受版本控制的 Key-Value 后端获取最新的密钥版本。确保路径中不包含该区段。@VaultPropertySourcedata/

路径中存在的任何占位符都将根据已针对环境注册的属性源集进行解析，如下例所示：${…}@VaultPropertySourcespring-doc.cn

示例 4.使用占位符声明路径@VaultPropertySource

@Configuration
@VaultPropertySource(value = "aws/creds/${my.placeholder:fallback/value}",
                     propertyNamePrefix = "aws.",
                     renewal = Renewal.ROTATE)
public class AppConfig {
}

假设它存在于已注册的属性源之一（例如，系统属性或环境变量）中，则占位符将解析为相应的值。如果不是，则用作默认值。如果未指定 default 且无法解析属性，则会引发 an。my.placeholderfallback/valueIllegalArgumentExceptionspring-doc.cn

在某些情况下，严格控制可能是不可能的或不切实际的使用注释时的属性源排序。例如，如果上面的类是通过 component-scanning 中，顺序很难预测。在这种情况下 - 如果覆盖很重要 - 建议将用户回退到使用编程式 PropertySource API。有关详细信息，请参阅 ConfigurableEnvironment 和 MutablePropertySources。@VaultPropertySource@Configurationspring-doc.cn

属性源

注册VaultPropertySource

@VaultPropertySource

注册`VaultPropertySource`