Java服务端配置管理：Spring Cloud Config的实践

原创

省赚客开发者 2024-09-02 14:58:42 ©著作权

文章标签 spring Cloud xml 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者省赚客开发者的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java服务端配置管理：Spring Cloud Config的实践

大家好，我是微赚淘客返利系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！

在微服务架构中，配置管理是一个关键的环节。随着服务数量的增加，手动管理配置变得不再可行。Spring Cloud Config 提供了一种集中化的配置管理方式，使得配置信息可以被外部化存储和统一管理。本文将介绍如何在 Java 服务端使用 Spring Cloud Config 进行配置管理。

环境准备

首先，确保你的开发环境中已经安装了 Java 和 Maven。Spring Cloud Config 需要 Spring Boot 作为基础，因此确保你的项目是基于 Spring Boot 的。

创建配置服务器

添加依赖

在 pom.xml 文件中添加 Spring Cloud Config Server 的依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
</dependencies>

配置应用主类

创建一个配置服务器的主类，使用 @EnableConfigServer 注解来启用配置服务器：

package cn.juwatech.config;

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);
    }
}

配置文件

在 application.properties 或 application.yml 文件中配置 Git 仓库地址，Spring Cloud Config Server 将从这个仓库中读取配置文件：
```
spring.cloud.config.server.git.uri=https://github.com/your-repo/config-repo
spring.cloud.config.server.git.searchPaths=repo
```

创建配置客户端

添加依赖

在客户端项目的 pom.xml 文件中添加 Spring Cloud Config Client 的依赖：

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

配置应用主类

在客户端应用的主类上添加 @RefreshScope 注解，以便在配置更新时能够刷新配置：

package cn.juwatech.client;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.context.config.annotation.RefreshScope;

@SpringBootApplication
public class ConfigClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigClientApplication.class, args);
    }
}

配置文件

在 bootstrap.properties 或 bootstrap.yml 文件中指定配置服务器的地址：
```
spring.cloud.config.uri=http://localhost:8888
spring.application.name=myapp
```

使用配置

在客户端代码中，可以通过注入 @Value 来使用配置信息：

package cn.juwatech.client.config;

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

@Component
public class AppConfig {
    @Value("${my.config.value}")
    private String configValue;

    public String getConfigValue() {
        return configValue;
    }
}

动态刷新配置

Spring Cloud Config 支持动态刷新配置，无需重启应用即可更新配置。

添加依赖

在客户端项目的 pom.xml 文件中添加 Spring Cloud Context 的依赖：

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

使用 @RefreshScope

如前所述，确保你的配置类使用了 @RefreshScope 注解。
手动刷新配置

可以通过发送 POST 请求到 /actuator/refresh 端点来手动刷新配置：
```
curl -X POST http://localhost:8080/actuator/refresh
```

安全性考虑

在生产环境中，配置服务器应该受到保护，避免未授权访问。

启用 Spring Security

在配置服务器中启用 Spring Security，并配置用户认证：

package cn.juwatech.config.security;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
            .anyRequest().authenticated()
            .and()
            .httpBasic();
    }
}