1. 程式人生 > >Spring Cloud Alibaba(二) 配置中心多專案、多配置檔案、分目錄實現

Spring Cloud Alibaba(二) 配置中心多專案、多配置檔案、分目錄實現

介紹

之前Spring Cloud Config基礎篇這篇文章介紹了Spring Cloud Config 配置中心基礎的實現,今天繼續聊下Spring Cloud Config 並結合nacos做服務註冊中心,實現多專案、多配置檔案、按專案目錄劃分等功能的配置服務中心。

閱讀本篇文章之前,最好要有nacos基礎;關於nacos是什麼,如何使用,可以參考我的上一篇文章 Spring Cloud Alibaba(一) 如何使用nacos服務註冊和發現,或者直接連結到官網教程Nacos 快速開始

本示例主要內容

  • 採用nacos做服務註冊中心,Spring Cloud Config做配置服務中心,在上一篇基礎上新建了ali-nacos-config-server配置服務中心專案、ali-nacos-config-client配置客戶端專案、並把ali-nacos-consumer-feign配置也調整成從配置中心載入配置
  • 支援多專案,config-repo配置檔案目錄按專案名稱來規劃,在配置中心 searchPaths: /cloud-alibaba/config-repo/{application}/ 使用application自動識別查詢目錄
  • 支援單專案多配置檔案,ali-nacos-config-client專案的配置檔案 spring.cloud.config.name=${spring.application.name},myconfig,通過指定多個name實現多配置檔案

實現示例過程

新建ali-nacos-config-server專案

該專案用來做配置服務中心,以下貼出關鍵部分程式碼

pom.xml

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>

application.yml

server:
  port: 8001

spring:
  application:
    name: ali-nacos-config-server
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    config:
      server:
        git:
          #uri: https://github.com/smltq/spring-boot-demo.git
          uri: https://gitee.com/tqlin/spring-boot-demo.git
          searchPaths: /cloud-alibaba/config-repo/{application}/
          force-pull: true

啟動類AnConfigServerApplication.java

@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class AnConfigServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(AnConfigServerApplication.class, args);
    }
}

新建ali-nacos-config-client專案

該專案用來做配置中心客戶端測試之一,以下貼出幾處關鍵程式碼

pom.xml

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</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-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
        </dependency>

    </dependencies>

bootstrap.yml

spring:
  application:
    name: ali-nacos-config-client
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    config:
      name: ${spring.application.name},myconfig
      uri: http://localhost:8001/ # config server 配置服務地址
      profile: ${spring.profiles.active}
      label: master
  profiles:
    active: pro                  # 配置檔案版本(該示例分為test,dev,pro)

寫個配置讀取測試類HelloController.java

@RestController
public class HelloController {
    @Value("${easy.hello}")
    private String hello;

    @Value("${easy.myconfig}")
    private String myconfig;

    @RequestMapping("/hello")
    public Map hello() {
        Map map = new HashMap<>();
        map.put("hello", hello);
        map.put("myconfig", myconfig);
        return map;
    }
}

啟動類AnConfigClientApplication.java

@SpringBootApplication
@EnableDiscoveryClient
public class AnConfigClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(AnConfigClientApplication.class, args);
    }
}

調整ali-nacos-consumer-feign專案

以下貼出調整部分程式碼

pom.xml增加spring-cloud-starter-config依賴

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
    </dependencies>

yml配置檔案增加bootstrap.yml,把核心配置移到該配置檔案
bootstrap.yml

spring:
  application:
    name: ali-nacos-consumer-feign
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    config:
      name: ${spring.application.name}
      uri: http://localhost:8001/ # config server 配置服務地址
      profile: ${spring.profiles.active}
      label: master
  profiles:
    active: dev                  # 配置檔案版本(該示例分為test,dev,pro)

編寫配置讀寫測試類HomeController.java

@RestController
@Slf4j
public class HomeController {

    @Autowired
    private HelloService helloService;

    @Value("${easy.hello}")
    private String hello;

    @GetMapping(value = "/", produces = "application/json")
    public String home() {
        log.info("-----------------consumer呼叫開始-----------------");
        String param = "雲天";
        log.info("消費者傳遞引數:" + param);
        String result = helloService.hello(param);
        log.info("收到提供者響應:" + result);
        return "feign消費者" + result;
    }

    @RequestMapping("/hello")
    public Map hello() {
        Map map = new HashMap<>();
        map.put("hello", hello);
        return map;
    }
}

最後放上配置檔案目錄規劃

config-repo配置總目錄
ali-nacos-config-server 專案GIT的配置目錄
ali-nacos-consumer-feign 專案GIT的配置目錄

使用示例

在上一篇基礎上,我們新建了2個專案,並調整ali-nacos-consumer-feign專案使它支援配置遠端讀取,有以下三個專案做測試。

ali-nacos-config-server:配置服務中心,服務名:ali-nacos-config-server,埠:8001
ali-nacos-config-client:配置客戶端1(消費端),服務名:ali-nacos-config-client,埠:8002
ali-nacos-consumer-feign:配置客戶端2(消費端),服務名:ali-nacos-consumer-feign,埠:9101

執行測試

首先要啟動服務註冊中心 nacos

啟動ali-nacos-config-server服務,配置服務中心測試

  • 訪問:http://localhost:8001/ali-nacos-config-client/dev ,返回:
{
    name: "ali-nacos-config-client",
    profiles: [
    "dev"
    ],
    label: null,
    version: "5456d7ca31d46e91464b6efd3a0831a8208413d9",
    state: null,
    propertySources: [ ]
}
  • 訪問:http://localhost:8001/ali-nacos-config-client/test ,返回:
{
    name: "ali-nacos-config-client",
    profiles: [
    "test"
    ],
    label: null,
    version: "5456d7ca31d46e91464b6efd3a0831a8208413d9",
    state: null,
    propertySources: [ ]
}

這表示配置能正確從git上載入到了。

啟動ali-nacos-config-client服務,執行客戶端測試1

  • bootstrap.yml的active調成dev,訪問:http://localhost:8002/hello ,返回:
{
    hello: "ali-nacos-config-client 專案的 dev config",
    myconfig: "ali-nacos-config-client 專案的 myconfig config"
}
  • bootstrap.yml的active調成test,訪問:http://localhost:8002/hello ,返回:
{
hello: "ali-nacos-config-client 專案的 test config",
myconfig: "ali-nacos-config-client 專案的 myconfig config"
}

表示我git上該專案的2個配置檔案都成功讀取到了。

啟動ali-nacos-consumer-feign專案,測試客戶端測試2

訪問:http://localhost:9101/hello

返回結果

{
  hello: "ali-nacos-consumer-feign 專案的 dev config"
}

表示該專案的配置檔案載入成功了

資料

  • Spring Cloud Alibaba 示例原始碼
  • 原文地址