SpringCloud 分布式配置中心Cloud Config使用

Dear 丶 2022-06-02 01:16 181阅读 0赞

在分布式系统中，由于服务数量巨多，为了方便服务配置文件统一管理，实时更新，所以需要分布式配置中心组件。在Spring Cloud中，有分布式配置中心组件spring cloud config ，它支持配置服务放在配置服务的内存中（即本地），也支持放在远程Git仓库中。在spring cloud config 组件中，分两个角色，一是config server，二是config client。

## 1.服务端编写 ##

1.新建SpringBoot模块config-server-demo

添加项目依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.hqq</groupId>
        <artifactId>config-server-demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>config-server-demo</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.9.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
    
            <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>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka</artifactId>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Camden.SR6</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    </project>

在Application类中添加@EnableConfigServer注解开启配置服务功能

编写配置文件

spring.application.name=config-server
    server.port=8888
    spring.cloud.config.server.git.uri=https://github.com/heqianqianeh/learngit/
    ##spring.cloud.config.server.git.searchPaths=respo
    spring.cloud.config.label=master
    spring.cloud.config.server.git.username=your username
    spring.cloud.config.server.git.password=your password

*  spring.cloud.config.server.git.uri：配置git仓库地址
 *  spring.cloud.config.server.git.searchPaths：配置仓库路径
 *  spring.cloud.config.label：配置仓库的分支
 *  spring.cloud.config.server.git.username：访问git仓库的用户名
 *  spring.cloud.config.server.git.password：访问git仓库的用户密码

公有仓库可以无需配置用户名密码。

启动项目，输入[http://localhost:8888/server-config/dev][http_localhost_8888_server-config_dev] 即可看到

{"name":"server-config","profiles":["dev"],"label":"master","version":"bd270aba55a4c4d36e2e5e5c85d0c4e9f4fd338c","state":null,"propertySources":[{"name":"https://github.com/heqianqianeh/learngit/server-config.properties","source":{"graduated":"jxau","age":"22","name":"heqianqian"}}]}

读取到的配置信息

## 2.编写客户端 ##

依然是新建一个SpringBoot项目，导入项目依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.hqq</groupId>
        <artifactId>config-client-demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>config-client-demo</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.9.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
    
            <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>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Dalston.RC1</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    </project>

编写配置文件

spring.application.name=config-client
    ##指明远程仓库的分支
    spring.cloud.config.label=master
    ##dev开发环境配置文件
    ##test测试环境
    ##pro正式环境
    spring.cloud.config.profile=dev
    ##指明配置服务中心的网址
    spring.cloud.config.uri= http://localhost:8888/
    server.port=8881
    
    spring.cloud.config.name=server-config

由于我的项目名称和要访问的文件名称不一致，所以需要使用`spring.cloud.config.name`指定文件名称

修改入口类，添加RestController注解，并且读取相应的配置信息

@RestController
    @SpringBootApplication
    public class ConfigClientDemoApplication { 
    
        @Value("${name}")
        String name;
    
        @Value("${age}")
        String age;
    
        @Value("${graduated}")
        String graduated;
    
        @RequestMapping("/profile")
        public String profile() {
            return "name: " + name + ",age: " + age
                    + ",graduated: " + graduated;
        }
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigClientDemoApplication.class, args);
        }
    }

启动项目，访问[http://localhost:8881/profile][http_localhost_8881_profile]

即可看到

name: heqianqian,age: 22,graduated: jxau

读取到的结果

[http_localhost_8888_server-config_dev]: http://localhost:8888/server-config/dev
[http_localhost_8881_profile]: http://localhost:8881/profile