SpringCloud微服務之Config知識總結

Posted on by

一、什麼是Spring Cloud Config？

  • Spring Cloud Config 可以為微服務架構中的應用提供集中化的外部配置支持，它分為服務端和客戶端兩個部分。
  • Spring Cloud Config 服務端被稱為分佈式配置中心，它是個獨立的應用，可以從配置倉庫獲取配置信息並提供給客戶端使用。
  • Spring Cloud Config 客戶端可以通過配置中心來獲取配置信息，在啟動時加載配置。
  • Spring Cloud Config 的配置中心默認采用Git來存儲配置信息，所以天然就支持配置信息的版本管理，並且可以使用Git客戶端來方便地管理和訪問配置信息。

二、搭建GIT環境

創建倉庫

在這裡插入圖片描述

創建文件

  • master分支
# config-dev.yml
config:
  info: "config info for dev(master)"
# config-test.yml
config:
  info: "config info for test(master)"
# config-prod.yml
config:
  info: "config info for prod(master)"
  • dev分支
# config-dev.yml
config:
  info: "config info for dev(dev)"
# config-test.yml
config:
  info: "config info for test(dev)"
# config-prod.yml
config:
  info: "config info for prod(dev)"

三、服務端示例

添加依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    <version>2.2.0.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
    <version>2.2.0.RELEASE</version>
</dependency>

添加配置

  • 啟動類
@SpringBootApplication
@EnableEurekaClient
@EnableConfigServer
public class SpringcloudConfigServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringcloudConfigServerApplication.class, args);
    }
}
  • application.yml配置文件
server:
  port: 8888
spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        # 配置存儲配置信息的Git倉庫
        git:
          uri: https://gitee.com/prochick/spring-cloud-config.git
          # Git用戶名
          username: xxx
          # Git密碼
          password: xxx
          # 指定是否開啟啟動時直接從git獲取配置
          clone-on-start: true

eureka:
  instance:
    prefer-ip-address: true
    instance-id: config-server-8888
  client:
    fetch-registry: false
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:8010/eureka/

訪問說明

# 獲取配置信息
/{label}/{application}-{profile}
# 獲取配置文件信息
/{label}/{application}-{profile}.yml
  • application

代表應用名稱，默認為配置文件中的spring.application.name，如果配置瞭spring.cloud.config.name，則為該名稱

  • label

代表分支名稱，對應配置文件中的spring.cloud.config.label

  • profile

代表環境名稱，對應配置文件中的spring.cloud.config.profile

測試使用

# 訪問http://localhost:8888/master/config-dev來獲取master分支上dev環境的配置信息
# 訪問http://localhost:8888/master/config-dev.yml來獲取master分支上dev環境的配置文件信息
# 訪問http://localhost:8888/master/config-test.yml來獲取master分支上test環境的配置文件信息
# 訪問http://localhost:8888/dev/config-dev.yml來獲取dev分支上dev環境的配置文件信息

四、客戶端示例

添加依賴

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-actuator</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-netflix-eureka-client</artifactId>
    <version>2.2.0.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
    <version>2.2.0.RELEASE</version>
</dependency>

添加配置

  • 配置文件

bootstrap.yml

server:
  port: 9999
spring:
  application:
    name: config-client

  cloud:
    config:
      # 配置中心地址
      uri: http://localhost:8888
      # 分支名稱
      label: master
      # 配置文件名稱
      name: config
      # 配置後綴名稱
      profile: dev

eureka:
  instance:
    prefer-ip-address: true
    instance-id: config-client-9999
    client:
      fetch-registry: false
      register-with-eureka: true
      service-url:
        defaultZone: http://localhost:8010/eureka/
 
# 暴露刷新監控 
management:
  endpoints:
    web:
      exposure:
        include: 'refresh'

控制器類

@RestController
@RefreshScope
public class ConfigController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() {

        return configInfo;
    }
}

測試使用

# 訪問http://localhost:9999/configInfo 可以獲取到dev分支下dev環境的配置

五、安全認證示例

添加依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
    <version>2.2.0.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

添加配置

  • 服務端配置
server:
  port: 8888
spring:
  application:
    name: config-server
  # 配置存儲配置信息的Git倉庫
  cloud:
    config:
      server:
        git:
          # 訪問地址
          uri: https://gitee.com/prochick/spring-cloud-config.git
          # Git用戶名
          username: xxx
          # Git密碼
          password: xxx
          # 指定是否開啟啟動時直接從git獲取配置
          clone-on-start: true
  # 配置用戶名和密碼
  security: 
    user:
      name: xxx
      password: xxx
  • 客戶端配置
server:
  port: 9999
spring:
  application:
    name: config-client

  cloud:
    config:
      # 配置中心地址
      uri: http://localhost:8888
      # 分支名稱
      label: master
      # 配置文件名稱
      name: config
      # 配置後綴名稱
      profile: dev
      # 配置中心用戶名
      username: xxx
      # 配置中心密碼
      password: xxx

六、集群搭建示例

添加配置

bootstrap.yml

server:
  port: 9999
spring:
  application:
    name: config-client

  cloud:
    config:
      # 分支名稱
      label: master
      # 配置文件名稱
      name: config
      # 配置後綴名稱
      profile: dev
      # 集群綁定
      discovery:
        enabled: true
        service-id: config-server

eureka:
  instance:
    prefer-ip-address: true
    instance-id: config-client-9999
    client:
      fetch-registry: true
      register-with-eureka: true
      service-url:
        defaultZone: http://localhost:8010/eureka/

測試訪問

# 訪問eureka-server

在這裡插入圖片描述

# 訪問http://localhost:9999/configInfo 可以獲取到dev分支下dev環境的配置

到此這篇關於SpringCloud微服務之Config知識總結的文章就介紹到這瞭,更多相關SpringCloud Config內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：