快速入门

Spring Vault 支持需要 Vault 0.6 或更高版本以及 Java SE 6 或更高版本。一种轻松引导设置工作环境的方法是在 STS 中创建一个基于 Spring 的项目。

首先,您需要设置一个正在运行的 Vault 服务器。请参阅 Vault 以了解如何启动 Vault 实例。

要在 STS 中创建 Spring 项目,请转到文件 → 新建 → Spring 模板项目 → 简单 Spring 实用程序项目 → 在出现提示时按“是”。然后输入项目和包名称,例如 org.spring.vault.example

然后将以下内容添加到 pom.xml 的依赖项部分。

示例 1. 添加 Spring Vault 依赖项
<dependencies>

  <!-- other dependency elements omitted -->

  <dependency>
    <groupId>org.springframework.vault</groupId>
    <artifactId>spring-vault-core</artifactId>
    <version>3.1.2</version>
  </dependency>

</dependencies>

如果您使用的是里程碑版本或候选版本,则还需要将 Spring 里程碑存储库的位置添加到您的 maven pom.xml 中,该位置与您的 <dependencies/> 元素位于同一级别。

<repositories>
  <repository>
    <id>spring-milestone</id>
    <name>Spring Maven MILESTONE Repository</name>
    <url>https://repo.spring.io/milestone</url>
  </repository>
</repositories>

此存储库也可以 在这里浏览

如果您使用的是快照版本,则还需要将 Spring 快照存储库的位置添加到您的 maven pom.xml 中,该位置与您的 <dependencies/> 元素位于同一级别。

<repositories>
  <repository>
    <id>spring-snapshot</id>
    <name>Spring Maven SNAPSHOT Repository</name>
    <url>https://repo.spring.io/snapshot</url>
  </repository>
</repositories>

此存储库也可以 在这里浏览

创建一个简单的 Secrets 类以持久化

示例 2. 映射数据对象
package org.spring.vault.example;

public class Secrets {

    String username;
    String password;

    public String getUsername() {
        return username;
    }

    public String getPassword() {
        return password;
    }
}

以及一个用于运行的主应用程序

示例 3. 使用 Spring Vault 的示例应用程序
package org.springframework.vault.example;

import org.springframework.vault.authentication.TokenAuthentication;
import org.springframework.vault.client.VaultEndpoint;
import org.springframework.vault.core.VaultTemplate;
import org.springframework.vault.support.VaultResponseSupport;

public class VaultApp {

    public static void main(String[] args) {

        VaultTemplate vaultTemplate = new VaultTemplate(new VaultEndpoint(),
                new TokenAuthentication("00000000-0000-0000-0000-000000000000"));

        Secrets secrets = new Secrets();
        secrets.username = "hello";
        secrets.password = "world";

        vaultTemplate.write("secret/myapp", secrets);

        VaultResponseSupport<Secrets> response = vaultTemplate.read("secret/myapp", Secrets.class);
        System.out.println(response.getData().getUsername());

        vaultTemplate.delete("secret/myapp");
    }
}

即使在这个简单的示例中,也有一些需要注意的地方

  • 您可以使用 org.springframework.vault.client.VaultEndpoint 对象和 ClientAuthentication 实例化 Spring Vault 的核心类 VaultTemplate。您无需启动 Spring 上下文即可使用 Spring Vault。

  • 运行此应用程序需要将 Vault 配置为具有 00000000-0000-0000-0000-000000000000 的根令牌。

  • 映射器针对标准 POJO 对象工作,无需任何其他元数据(尽管您可以选择提供这些信息)。

  • 映射约定可以使用字段访问。请注意,Secrets 类仅具有 getter 方法。

  • 如果构造函数参数名称与存储文档的字段名称匹配,则将使用它们来实例化对象。