使用 Spring Cloud Config 来管理 Spring Boot 项目中密码

在 Spring Boot 项目中，使用 Spring Cloud Config 来管理敏感信息（如数据库密码、Elasticsearch 密码等）是一种推荐的做法。Spring Cloud Config 提供了一个集中化的配置管理方案，可以将配置文件存储在远程仓库（如 Git、SVN 等）中，并通过 HTTP 接口动态获取配置。

以下是如何配置和使用 Spring Cloud Config 的详细步骤。

1. 添加依赖

首先，在你的 Spring Boot 项目中添加 spring-cloud-config 依赖。

Maven 配置

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Gradle 配置

implementation 'org.springframework.cloud:spring-cloud-starter-config'
implementation 'org.springframework.boot:spring-boot-starter-web'

2. 创建 Spring Cloud Config Server

Spring Cloud Config Server 是一个独立的服务，用于集中管理配置文件。你需要创建一个新的 Spring Boot 项目作为 Config Server。

2.1 添加依赖

在 Config Server 项目中，添加以下依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2.2 启用 Config Server

在 Config Server 的主类上添加 @EnableConfigServer 注解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class, args);
    }
}

2.3 配置 Config Server

在 application.yml 中配置 Config Server 的 Git 仓库地址：

server:
  port: 8888

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-repo/config-repo.git # 你的 Git 仓库地址
          search-paths: config-files # 配置文件所在的目录
          username: your-git-username # Git 用户名（如果需要认证）
          password: your-git-password # Git 密码（如果需要认证）

2.4 配置文件示例

在 Git 仓库中创建一个配置文件，例如 application.yml 或 myapp-dev.yml，内容如下：

elasticsearch:
  first:
    rest:
      uris: 10.1.0.239:9200,10.1.0.240:9200,10.1.0.241:9200
      username: elastic
      password: secure_password_1
  second:
    rest:
      uris: 10.1.0.242:9200,10.1.0.243:9200,10.1.0.244:9200
      username: elastic
      password: secure_password_2

3. 配置 Spring Boot 客户端

在你的 Spring Boot 客户端项目中，配置从 Config Server 获取配置文件。

3.1 添加依赖

确保客户端项目中包含 spring-cloud-starter-config 依赖。

3.2 配置客户端

在客户端的 bootstrap.yml 中配置 Config Server 的地址：

spring:
  application:
    name: myapp # 应用名称，对应 Config Server 中的配置文件名称
  cloud:
    config:
      uri: http://localhost:8888 # Config Server 的地址
      fail-fast: true # 如果 Config Server 不可用，启动失败
      username: user # Config Server 的认证信息（如果需要）
      password: password

3.3 使用配置

在客户端项目中，你可以像平常一样使用 @Value 或 @ConfigurationProperties 注入配置值。

例如：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyConfig {

    @Value("${elasticsearch.first.rest.username}")
    private String firstUsername;

    @Value("${elasticsearch.first.rest.password}")
    private String firstPassword;

    public void printConfig() {
        System.out.println("First Username: " + firstUsername);
        System.out.println("First Password: " + firstPassword);
    }
}

4. 加密敏感信息

Spring Cloud Config 支持对敏感信息（如密码）进行加密。你可以使用对称加密或非对称加密。

4.1 配置加密密钥

在 Config Server 的 application.yml 中配置加密密钥：

encrypt:
  key: my-secret-key # 对称加密密钥

4.2 加密数据

使用 Config Server 的 /encrypt 端点加密数据：

curl -X POST http://localhost:8888/encrypt -d "secure_password_1"

返回的加密字符串可以存储在配置文件中：

elasticsearch:
  first:
    rest:
      password: "{cipher}加密后的字符串"

4.3 解密数据

Config Server 会自动解密带有 {cipher} 前缀的值。

5. 高可用和安全性

• 高可用：可以将 Config Server 部署为多个实例，并通过负载均衡器访问。

• 安全性：使用 HTTPS 保护 Config Server 的通信，并启用认证（如 OAuth2 或 Basic Auth）。

6. 总结

通过 Spring Cloud Config，你可以将配置文件集中管理，并动态加载到 Spring Boot 应用中。以下是主要步骤：

1. 创建 Config Server，并配置 Git 仓库。

2. 在客户端项目中配置 Config Server 地址。

3. 使用 @Value 或 @ConfigurationProperties 注入配置值。

4. 对敏感信息进行加密。

这种方式不仅提高了配置管理的灵活性，还增强了安全性，特别适合生产环境使用。