Spring Cloud Config 基础示例

梦幻小丑灯

Spring Cloud Config 简介什么是Srping Cloud Config?

Spring Cloud Config 是一种分布式配置中心框架， 为分布式系统中的外部化配置提供服务器和客户端支持。(同类技术还有vault，zookeeper，Consul)
使用Config Server，可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment和PropertySource抽象，因此它们非常适合Spring应用程序，但可以与任何语言运行的任何应用程序一起使用。当应用程序通过部署管道从开发到测试并进入生产时，您可以管理这些环境之间的配置，并确保应用程序具有迁移时需要运行的所有内容。服务器存储后端的默认实现使用git，因此它可以轻松支持配置环境的标记版本，以及可用于管理内容的各种工具。
Spring Cloud Config也主要由两部分组成：
Config-Server: 用于配置外部的资源文件,支持对属性值进行加解密
Config-client：绑定到config server使用远程配置文件初始化spring，支持对属性值进行加解密

本文示例说明

• 为了更直观的理解spring cloud config，本文通过server获取整个配置，效果上与通过配置springboot的active 来切换环境一致；通过接口查询数据库以查看效果；
• 采用高可用架构；此处使用eureka去做服务注册发现（暂时也只会这个。。）
  

新建ConfigServer

为了减少文章长度，尽量干货，创建过程就不截说明了，建议使用Intellij idea进行创建；

• POM文件：
  

1. <?xml version="1.0" encoding="UTF-8"?>
   
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   
3.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   
4.         <modelVersion>4.0.0</modelVersion>
   
5. 
   
6.         <groupId>com.lc.springcloud</groupId>
   
7.         <artifactId>config-server</artifactId>
   
8.         <version>0.0.1-SNAPSHOT</version>
   
9.         <packaging>jar</packaging>
   
10. 
    
11.         <name>config-server</name>
    
12.         <description>Demo project for Spring Boot</description>
    
13. 
    
14.         <parent>
    
15.                 <groupId>org.springframework.boot</groupId>
    
16.                 <artifactId>spring-boot-starter-parent</artifactId>
    
17.                 <version>2.1.0.RELEASE</version>
    
18.                 <relativePath/> <!-- lookup parent from repository -->
    
19.         </parent>
    
20. 
    
21.         <properties>
    
22.                 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    
23.                 <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    
24.                 <java.version>1.8</java.version>
    
25.                 <spring-cloud.version>Greenwich.M2</spring-cloud.version>
    
26.         </properties>
    
27. 
    
28.         <dependencies>
    
29.                 <dependency>
    
30.                         <groupId>org.springframework.cloud</groupId>
    
31.                         <artifactId>spring-cloud-config-server</artifactId>
    
32.                 </dependency>
    
33. 
    
34.                 <dependency>
    
35.                         <groupId>org.springframework.cloud</groupId>
    
36.                         <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    
37.                 </dependency>
    
38. 
    
39.                 <dependency>
    
40.                         <groupId>org.springframework.boot</groupId>
    
41.                         <artifactId>spring-boot-starter-test</artifactId>
    
42.                         <scope>test</scope>
    
43.                 </dependency>
    
44.         </dependencies>
    
45. 
    
46.         <dependencyManagement>
    
47.                 <dependencies>
    
48.                         <dependency>
    
49.                                 <groupId>org.springframework.cloud</groupId>
    
50.                                 <artifactId>spring-cloud-dependencies</artifactId>
    
51.                                 <version>${spring-cloud.version}</version>
    
52.                                 <type>pom</type>
    
53.                                 <scope>import</scope>
    
54.                         </dependency>
    
55.                 </dependencies>
    
56.         </dependencyManagement>
    
57. 
    
58.         <build>
    
59.                 <plugins>
    
60.                         <plugin>
    
61.                                 <groupId>org.springframework.boot</groupId>
    
62.                                 <artifactId>spring-boot-maven-plugin</artifactId>
    
63.                         </plugin>
    
64.                 </plugins>
    
65.         </build>
    
66. 
    
67.         <repositories>
    
68.                 <repository>
    
69.                         <id>spring-milestones</id>
    
70.                         <name>Spring Milestones</name>
    
71.                         <url>https://repo.spring.io/milestone</url>
    
72.                         <snapshots>
    
73.                                 <enabled>false</enabled>
    
74.                         </snapshots>
    
75.                 </repository>
    
76.         </repositories>
    
77. </project>

复制代码

• application.yml配置如
  

1. server:
   
2.         port: 8100
   
3. spring:
   
4.         application:
   
5.                 name: config-server
   
6.         cloud:
   
7.             config:
   
8.                         server:
   
9.                         git:
   
10.                            uri: https://github.com/lvchaogit/SpringCloud
    
11. eureka:
    
12.    client:
    
13.     service-url:
    
14.       defaultZone: http://localhost:8081/eureka/ # 服务注册中心地址

复制代码

通过配置不难理解，该配置是从git上获取配置，更多配置后续详解；

• application.java
  

1. @SpringBootApplication
   
2. @EnableConfigServer
   
3. @EnableDiscoveryClient
   
4. public class ConfigServerApplication {
   
5. 
   
6.         public static void main(String[] args) {
   
7.                 SpringApplication.run(ConfigServerApplication.class, args);
   
8.         }
   
9. }

复制代码

主要是加上** @EnableConfigServer**注解，开启configserver功能

搭建 Config Client

• POM文件
  

1. <?xml version="1.0" encoding="UTF-8"?>
   
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   
3.         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   
4.         <modelVersion>4.0.0</modelVersion>
   
5. 
   
6.         <groupId>com.lc.springcloud</groupId>
   
7.         <artifactId>config-client</artifactId>
   
8.         <version>0.0.1-SNAPSHOT</version>
   
9.         <packaging>jar</packaging>
   
10. 
    
11.         <name>config-client</name>
    
12.         <description>Demo project for Spring Boot</description>
    
13. 
    
14.         <parent>
    
15.                 <groupId>org.springframework.boot</groupId>
    
16.                 <artifactId>spring-boot-starter-parent</artifactId>
    
17.                 <version>2.1.0.RELEASE</version>
    
18.                 <relativePath/> <!-- lookup parent from repository -->
    
19.         </parent>
    
20. 
    
21.         <properties>
    
22.                 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    
23.                 <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    
24.                 <java.version>1.8</java.version>
    
25.                 <spring-cloud.version>Greenwich.M2</spring-cloud.version>
    
26.         </properties>
    
27. 
    
28.         <dependencies>
    
29.                 <!-- config starter begin-->
    
30.                 <dependency>
    
31.                         <groupId>org.springframework.cloud</groupId>
    
32.                         <artifactId>spring-cloud-starter-config</artifactId>
    
33.                 </dependency>
    
34.                 <!-- config starter end-->
    
35.                 <dependency>
    
36.                         <groupId>org.springframework.cloud</groupId>
    
37.                         <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    
38.                 </dependency>
    
39.                 <dependency>
    
40.                         <groupId>org.springframework.boot</groupId>
    
41.                         <artifactId>spring-boot-starter-web</artifactId>
    
42.                 </dependency>
    
43.                 <dependency>
    
44.                         <groupId>mysql</groupId>
    
45.                         <artifactId>mysql-connector-java</artifactId>
    
46.                 </dependency>
    
47.                 <dependency>
    
48.                         <groupId>org.apache.commons</groupId>
    
49.                         <artifactId>commons-pool2</artifactId>
    
50.                         <version>2.5.0</version>
    
51.                 </dependency>
    
52.                 <dependency>
    
53.                         <groupId>com.alibaba</groupId>
    
54.                         <artifactId>druid-spring-boot-starter</artifactId>
    
55.                         <version>1.1.10</version>
    
56.                 </dependency>
    
57.                 <!-- mybatis-plus begin -->
    
58.                 <dependency>
    
59.                         <groupId>com.baomidou</groupId>
    
60.                         <artifactId>mybatis-plus-boot-starter</artifactId>
    
61.                         <version>2.1.9</version>
    
62.                         <exclusions>
    
63.                                 <exclusion>
    
64.                                         <artifactId>tomcat-jdbc</artifactId>
    
65.                                         <groupId>org.apache.tomcat</groupId>
    
66.                                 </exclusion>
    
67.                         </exclusions>
    
68.                 </dependency>
    
69.                 <!--config监控模块  -->
    
70.                 <dependency>
    
71.                         <groupId>org.springframework.boot</groupId>
    
72.                         <artifactId>spring-boot-starter-actuator</artifactId>
    
73.                 </dependency>
    
74.                 <dependency>
    
75.                         <groupId>org.springframework.boot</groupId>
    
76.                         <artifactId>spring-boot-starter-test</artifactId>
    
77.                         <scope>test</scope>
    
78.                 </dependency>
    
79.                 <dependency>
    
80.                         <groupId>log4j</groupId>
    
81.                         <artifactId>log4j</artifactId>
    
82.                         <version>1.2.13</version>
    
83.                         <scope>runtime</scope>
    
84.                 </dependency>
    
85.                 <dependency>
    
86.                         <groupId>org.projectlombok</groupId>
    
87.                         <artifactId>lombok</artifactId>
    
88.                 </dependency>
    
89.         </dependencies>
    
90. 
    
91.         <dependencyManagement>
    
92.                 <dependencies>
    
93.                         <dependency>
    
94.                                 <groupId>org.springframework.cloud</groupId>
    
95.                                 <artifactId>spring-cloud-dependencies</artifactId>
    
96.                                 <version>${spring-cloud.version}</version>
    
97.                                 <type>pom</type>
    
98.                                 <scope>import</scope>
    
99.                         </dependency>
    
100.                 </dependencies>
     
101.         </dependencyManagement>
     
102. 
     
103.         <build>
     
104.                 <plugins>
     
105.                         <plugin>
     
106.                                 <groupId>org.springframework.boot</groupId>
     
107.                                 <artifactId>spring-boot-maven-plugin</artifactId>
     
108.                         </plugin>
     
109.                 </plugins>
     
110.         </build>
     
111. 
     
112.         <repositories>
     
113.                 <repository>
     
114.                         <id>spring-milestones</id>
     
115.                         <name>Spring Milestones</name>
     
116.                         <url>https://repo.spring.io/milestone</url>
     
117.                         <snapshots>
     
118.                                 <enabled>false</enabled>
     
119.                         </snapshots>
     
120.                 </repository>
     
121.         </repositories>
     
122. </project>

复制代码

• bootstrap.yml
  

1. spring:
   
2.   application:
   
3.     name: config-client
   
4.   cloud:
   
5.     config:
   
6.       profile: dev
   
7.       label: master
   
8.       discovery:
   
9.         enabled: true
   
10.         service-id: config-server
    
11. server:
    
12.   port: 2001
    
13. eureka:
    
14.   client:
    
15.       register-with-eureka: false     #因此处只是消费，不提供服务，所以不需要向eureka server注册
    
16.       service-url:
    
17.         defaultZone: http://localhost:8081/eureka/ # 服务注册中心地址

复制代码

• 首先注意配置文件名称为：bootstartp.yml，并不是~~application.yml~~
• 通过配置discovery，并设置enabled为true，使client通过服务发现去获取server，server-id为注册中心里配置的服务名称
• label=git的标签；profile=配置文件版本（类似于spring boot中的active）