SpringCloud入门教程(三)配置管理

一时失言乱红尘 2021-09-27 11:48 270阅读 0赞

配置管理根据字面上理解，就是一些管理项目中使用到的一些配置文件。以前开发单台服务器的时候，我们通过一个配置文件就可以将平常用到的一些配置记录下来，但是如果是搭建多台集群服务器部署，当然也可以使用多个配置文件，但是维护和同步就会比较麻烦。所以配置服务一般分两种情况：

1.多台服务器集群使用同一配置，比如：数据库信息

2.不同的服务器集群使用不同的配置，比如：开发、测试、生产环境使用的数据库不一样

Spring Cloud的解决方案是， 将这些配置文件放到版本管理服务器里面，Spring Cloud缺省配置使用GIT中。所有Web服务均从GIT中获取这些配置文件。由于GIT服务器与具体Web服务器之间不需要共享存储， 只要网络可达就行，从而可以实现Web服务于配置信息的存放位置的解耦。

Spring Cloud统一控制应用和GIT服务的交互，应用只需要按照Spring Cloud的规范配置GIT的URL即可。 使用GIT后，场景2和场景1的区别仅仅是，场景2中不同的client使用不同版本的配置文件，但应用但访问的文件看起来是会是同一个。Spring Cloud的配置服务结构入下图：

![70][]

一、创建Maven工程ConfigServer（使用IDEA工具创建Maven工程）

（1）File--New--Probject--Maven

![70 1][]

项目信息填写完成后点击Next，然后Fishing。

（2）pom文件配置如下：

<?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.springcloud.study</groupId>
        <artifactId>ConfigServer</artifactId>
        <version>1.0-SNAPSHOT</version>
        <packaging>jar</packaging>
        <name>springcloud.config.server</name>
        <description>Demo Config Server</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.3.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-eureka</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</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>

（3）创建Config Server，它也是一个Spring Boot应用，@EnableConfigServer注解说明了一个Config Server。同样我们使用@EnableEurekaClient将它注册到服务中心。

![70 2][]

（4）创建配置文件application.yml

在resources下创建配置文件application.yml，配置内容台下：

![70 3][]

Git:

uri：可以是任何代码管理工具的上的地址

searchPaths：项目路径

码云项目截图：

![70 4][]

配置文件内容如下：

![70 5][]

（5）启动ConfigServer，访问http://localhost:8888/aa/xx, 可见如下响应。这个是输出是并没有包括具体配置文件的内容， 这个响应说明，config server可以正常访问我们配置在application.yml中的GIT服务。

![70 6][]

这个URL是啥意思， 需要解释一下。我们从输出就可以看到 abc 就是application的名字，xyz是profile的名字， 注意这里的abc, xyz均是随便输入的名字， 并不需要真实存在，config server这个REST接口返回的只是应用名为abc, profile名为xyz时，GIT配置环境的结构。

config server提供的REST接口，Spring Cloud官方文档提供了几个可选URL可以是如下几个：

1.  /\{application\}/\{profile\}\[/\{label\}\]
2.  /\{application\}-\{profile\}.yml
3.  /\{label\}/\{application\}-\{profile\}.yml
4.  /\{application\}-\{profile\}.properties
5.  /\{label\}/\{application\}-\{profile\}.properties

比如 第三个格式，如果我们在GIT版本库中有一个配置文件 SpringCloud/ConfigServer/config-server-dev.properties. 那么访问http://localhost:8888/config-server-dev.properties就可以显示配置文件内容。这个例子中， application的名字是"config-client"(也是下面我们即将创建的client), profile名字是dev, 文件后缀是.properties。

![70 7][]

二、创建ConfigClient工程

（1）File--New--Probject--Maven

![70 1][]

项目信息填写完成后点击Next，然后Fishing。

（2）pom文件配置如下：

<?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.springcloud.stydu</groupId>
        <artifactId>ConfigClient</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name>Springcloud.config.client</name>
        <packaging>jar</packaging>
        <description>Demo Spring Config Client</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.3.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-eureka</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</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>

（3）创建ConfigClientApplication

![70 8][]

这个应用非常简单，就是从远端服务器(码云)项目SpringCloud路径下ConfigServer文件夹中获取配置项hello的值，ConfigClient向ConfigServer提交REST请求后，ConfigServer将访问GIT服务器，并将取得的配置项hello的值返回给ConfigClient.

（4）创建applicaltion.yml文件

![70 9][]

这个配置定义了应用的名字是config-client(这就是将要用于组装前面ConfigServer中题到的application), profile采用dev, GIT分支用master。url是ConfigServer的地址。那么问题来了，我们似乎没定义配置文件名， 那配置文件名是什么呢？ 这点又体现了约定优于配置的思路，这里Spring Cloud约定， 应用的配置文件名以如下方式组成：\{application\}-\{profile\}.properties（或者\{application\}-\{profile\}.yml）。比如我们这个应用的配置文件就是config-client-dev.properties. 所以只需要在GIT的中创建配置文件SpringCloud/ConfigServer/config-client-dev.properties就可以了， 内容如下：

![70 10][]

（5）启动ConfigClient应用， 访问http://locahost/8881/hello, 可以看到，应用本身并没有直接配置hello的具体内容，也没指定具体配置文件，所有这些都由Spring Cloud框架提交给ConfigServer了

![70 11][]

[70]: /images/20210923/e0c8820545344997a939588df8c25434.png
[70 1]: /images/20210923/a4a24a1bdef14224bccc6eddc30490e8.png
[70 2]: /images/20210923/fb11637bde1c430ba7f11e9ba8585a7b.png
[70 3]: /images/20210923/f4b2161cfbf84a89ab736c8dd5a9394d.png
[70 4]: /images/20210923/0953ecfcd4ba4b4ba1b97779b34ebf21.png
[70 5]: /images/20210923/0a4ad099a0394036a9e00338d0a7930c.png
[70 6]: /images/20210923/fd67453ebc7e4e23bd6229993a4ce1cc.png
[70 7]: /images/20210923/51d952f7e5404dd9a66b40568bfc4800.png
[70 8]: /images/20210923/a91c35b60849439bb67a7eed148d96ea.png
[70 9]: /images/20210923/b1e29ae834094d7094d0d06a813d9668.png
[70 10]: /images/20210923/96cdda91836b4d7187b2d869c1918501.png
[70 11]: /images/20210923/fe0e5fa3da294f879ee83487897037d6.png