Consul对Spring配置文件的分发

Consul对Spring配置文件的分发

在Spring项目中使用Consul来分发配置文件，可以通过Spring Cloud Consul的配置管理功能实现。以下是一个详细的步骤和示例，展示如何设置和使用Consul来分发和管理Spring应用的配置文件。

1. 设置 Consul 服务器

首先，需要确保 Consul 服务器已启动并运行。可以使用以下命令启动一个单节点的 Consul 服务器：

consul agent -dev

2. 配置 Spring 项目

在Spring项目中，需要配置 bootstrap.yml 文件，以便应用在启动时能够连接到Consul并从中获取配置。

创建 bootstrap.yml

spring:
  application:
    name: your-server-name
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        service-name: ${spring.application.name}
      config:
        prefix: xxxx/yyyy/xxxx/……
        profile-separator: '-'
        format: YAML
        data-key: your-data-name

3. 在Consul中存储配置

需要将应用的配置存储在Consul的Key-Value存储中，可以通过Consul的HTTP API或命令行工具来完成。

示例配置

假设我们有一个 application.yml 文件，需要将其内容存储在Consul中。

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testbase
    username: root
    password: password

使用Consul命令行工具存储配置

将上述配置存储在Consul中：

consul kv put config/payment-service,application/data "$(cat application.yml)"

使用ConsulUI工具存储配置

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testbase
    username: root
    password: password

4. 配置 Spring Cloud Consul 客户端

在Spring Boot项目的 pom.xml 文件中添加依赖：

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

5. 使用 Consul 配置

SpringApplication加上动态刷新的注解

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

@RefreshScope // 动态刷新
@EnableDiscoveryClient//该注解用于向使用consul或者zookeeper作为注册中心时注册服务
@SpringBootApplication
public class SpringApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringApplication.class, args);
    }
}

6. 注意事项

1. 修改完Consul中的配置文件后，Spring项目不会立即获取最新配置，因为 spring.cloud.consul.config.watch.wait-time 的默认值是55秒。Spring项目会在55秒的周期内去检查并获取对应位置的配置文件。

2. 这是为了避免过于频繁的轮询对Consul服务器造成过大的负载。

Consul在配置文件中的参数列表

1. Spring Cloud Consul官方文档
2. 当然，以下是一个包含Spring Cloud Consul常见配置参数的Markdown表格：

这个表格汇总了Spring Cloud Consul中一些常见的配置参数及其示例，方便查阅和使用。