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

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

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

1.服务端编写

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

添加项目依赖

  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" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.hqq</groupId>
  6.     <artifactId>config-server-demo</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <packaging>jar</packaging>
  10.     <name>config-server-demo</name>
  11.     <description>Demo project for Spring Boot</description>
  13.     <parent>
  14.         <groupId>org.springframework.boot</groupId>
  15.         <artifactId>spring-boot-starter-parent</artifactId>
  16.         <version>1.5.9.RELEASE</version>
  17.         <relativePath/> <!-- lookup parent from repository -->
  18.     </parent>
  20.     <properties>
  21.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  22.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  23.         <java.version>1.8</java.version>
  24.     </properties>
  26.     <dependencies>
  28.         <dependency>
  29.             <groupId>org.springframework.cloud</groupId>
  30.             <artifactId>spring-cloud-config-server</artifactId>
  31.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-web</artifactId>
  36.         </dependency>
  38.         <dependency>
  39.             <groupId>org.springframework.boot</groupId>
  40.             <artifactId>spring-boot-starter-test</artifactId>
  41.             <scope>test</scope>
  42.         </dependency>
  44.         <dependency>
  45.             <groupId>org.springframework.cloud</groupId>
  46.             <artifactId>spring-cloud-starter-eureka</artifactId>
  47.         </dependency>
  48.     </dependencies>
  50.     <dependencyManagement>
  51.         <dependencies>
  52.             <dependency>
  53.                 <groupId>org.springframework.cloud</groupId>
  54.                 <artifactId>spring-cloud-dependencies</artifactId>
  55.                 <version>Camden.SR6</version>
  56.                 <type>pom</type>
  57.                 <scope>import</scope>
  58.             </dependency>
  59.         </dependencies>
  60.     </dependencyManagement>
  62.     <build>
  63.         <plugins>
  64.             <plugin>
  65.                 <groupId>org.springframework.boot</groupId>
  66.                 <artifactId>spring-boot-maven-plugin</artifactId>
  67.             </plugin>
  68.         </plugins>
  69.     </build>
  71.     <repositories>
  72.         <repository>
  73.             <id>spring-milestones</id>
  74.             <name>Spring Milestones</name>
  75.             <url>https://repo.spring.io/milestone</url>
  76.             <snapshots>
  77.                 <enabled>false</enabled>
  78.             </snapshots>
  79.         </repository>
  80.     </repositories>
  82. </project>

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

编写配置文件

  1. spring.application.name=config-server
  2. server.port=8888
  3. spring.cloud.config.server.git.uri=https://github.com/heqianqianeh/learngit/
  4. ##spring.cloud.config.server.git.searchPaths=respo
  5. spring.cloud.config.label=master
  6. spring.cloud.config.server.git.username=your username
  7. 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 即可看到

  1. {"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项目，导入项目依赖

  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" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.hqq</groupId>
  6.     <artifactId>config-client-demo</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <packaging>jar</packaging>
  10.     <name>config-client-demo</name>
  11.     <description>Demo project for Spring Boot</description>
  13.     <parent>
  14.         <groupId>org.springframework.boot</groupId>
  15.         <artifactId>spring-boot-starter-parent</artifactId>
  16.         <version>1.5.9.RELEASE</version>
  17.         <relativePath/> <!-- lookup parent from repository -->
  18.     </parent>
  20.     <properties>
  21.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  22.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  23.         <java.version>1.8</java.version>
  24.     </properties>
  26.     <dependencies>
  28.         <dependency>
  29.             <groupId>org.springframework.cloud</groupId>
  30.             <artifactId>spring-cloud-starter-config</artifactId>
  31.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-web</artifactId>
  36.         </dependency>
  38.         <dependency>
  39.             <groupId>org.springframework.boot</groupId>
  40.             <artifactId>spring-boot-starter-test</artifactId>
  41.             <scope>test</scope>
  42.         </dependency>
  43.     </dependencies>
  45.     <dependencyManagement>
  46.         <dependencies>
  47.             <dependency>
  48.                 <groupId>org.springframework.cloud</groupId>
  49.                 <artifactId>spring-cloud-dependencies</artifactId>
  50.                 <version>Dalston.RC1</version>
  51.                 <type>pom</type>
  52.                 <scope>import</scope>
  53.             </dependency>
  54.         </dependencies>
  55.     </dependencyManagement>
  57.     <build>
  58.         <plugins>
  59.             <plugin>
  60.                 <groupId>org.springframework.boot</groupId>
  61.                 <artifactId>spring-boot-maven-plugin</artifactId>
  62.             </plugin>
  63.         </plugins>
  64.     </build>
  66.     <repositories>
  67.         <repository>
  68.             <id>spring-milestones</id>
  69.             <name>Spring Milestones</name>
  70.             <url>https://repo.spring.io/milestone</url>
  71.             <snapshots>
  72.                 <enabled>false</enabled>
  73.             </snapshots>
  74.         </repository>
  75.     </repositories>
  77. </project>

编写配置文件

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

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

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

  1. @RestController
  2. @SpringBootApplication
  3. public class ConfigClientDemoApplication { 
  5.     @Value("${name}")
  6.     String name;
  8.     @Value("${age}")
  9.     String age;
  11.     @Value("${graduated}")
  12.     String graduated;
  14.     @RequestMapping("/profile")
  15.     public String profile() {
  16.         return "name: " + name + ",age: " + age
  17.                 + ",graduated: " + graduated;
  18.     }
  20.     public static void main(String[] args) {
  21.         SpringApplication.run(ConfigClientDemoApplication.class, args);
  22.     }
  23. }

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

即可看到

  1. name: heqianqian,age: 22,graduated: jxau

读取到的结果

发表评论

表情：
评论列表 （有 0 条评论，299人围观）

还没有评论，来说两句吧...

相关阅读