全部產品
Search
文件中心

Enterprise Distributed Application Service:實現服務註冊與發現

更新時間:Dec 05, 2024

EDAS提供Nacos的商用版本註冊中心,使用Nacos作為註冊中心開發的應用無需修改任何代碼,部署到EDAS後,即可使用EDAS提供的共用註冊中心。本文介紹如何在本地基於Nacos開發一對Spring Cloud微服務樣本應用(包含一個服務提供者Provider和一個服務消費者Consumer)。

如何選擇註冊中心

微服務應用通過註冊中心實現服務註冊與發現。在開發應用時,可以根據實際需求,參考下圖選擇註冊中心。

您可以使用本文介紹的Nacos作為註冊中心實現應用的服務註冊與發現,也可以使用自建或MSE託管的Eureka、ZooKeeper和Consul等其它類型的註冊中心。無論使用哪種類型的註冊中心,在將應用部署到EDAS之後,都可以使用EDAS提供的應用託管、微服務治理及雲原生PaaS平台能力。

您可以按照本文的內容實現應用的服務註冊與發現,也可以直接下載應用Demo:service-providerservice-consumer

準備工作

  • 已下載Maven並設定環境變數。

  • 已下載最新版本的Nacos Server

  • 已按以下步驟啟動Nacos Server。

    1. 解壓下載的Nacos Server壓縮包。

    2. 進入nacos/bin目錄,啟動Nacos Server。

      • Linux/Unix/Mac系統:執行命令sudo sh startup.sh -m standalone

      • Windows系統:雙擊執行startup.cmd檔案。

操作步驟

步驟一:建立服務提供者

在本地建立服務提供者應用工程,添加依賴,開啟服務註冊與發現功能,並將註冊中心指定為Nacos Server。

  1. 建立名為nacos-service-provider的Maven工程。

  2. pom.xml檔案中添加依賴。

    以Spring Boot 2.1.4.RELEASE和Spring Cloud Greenwich.SR1為例,依賴如下。

    展開查看代碼

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/>
    </parent>
    
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2.1.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</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>                  
    說明

    樣本中使用的版本為Spring Cloud Greenwich,對應Spring Cloud Alibaba版本為2.1.1.RELEASE。

    • 如果使用Spring Cloud Finchley版本,對應Spring Cloud Alibaba版本為2.0.1.RELEASE。

    • 如果使用Spring Cloud Edgware版本,對應Spring Cloud Alibaba版本為1.5.1.RELEASE。Spring Cloud Edgware版本的生命週期已結束,不推薦使用該版本開發應用。

  3. src\main\java下建立Packagecom.aliware.edas

  4. 在Packagecom.aliware.edas中建立服務提供者的啟動類ProviderApplication,並添加以下代碼。

        package com.aliware.edas;
    
        import org.springframework.boot.SpringApplication;
        import org.springframework.boot.autoconfigure.SpringBootApplication;
        import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
        @SpringBootApplication
        @EnableDiscoveryClient
        public class ProviderApplication {
    
            public static void main(String[] args) {
                SpringApplication.run(ProviderApplication.class, args);
            }
        }  

    @EnableDiscoveryClient:表明該應用需開啟服務註冊與發現功能。

  5. 在Packagecom.aliware.edas中建立EchoController

        package com.aliware.edas;
    
        import org.springframework.web.bind.annotation.PathVariable;
        import org.springframework.web.bind.annotation.RequestMapping;
        import org.springframework.web.bind.annotation.RequestMethod;
        import org.springframework.web.bind.annotation.RestController;
    
        @RestController
        public class EchoController {
            @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
            public String echo(@PathVariable String string) {
                return string;
            }
        }              

    EchoController中,指定URL Mapping為/echo/{string} ,指定HTTP方法為GET,從URL路徑中擷取方法參數,並返回收到的參數。

  6. src\main\resources路徑下建立檔案application.properties,在application.properties中添加如下配置,指定Nacos Server的地址。

        spring.application.name=service-provider
        server.port=18081
        spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848               

    127.0.0.1為Nacos Server的地址。如果您的Nacos Server部署在另外一台機器,需修改為對應的IP地址。您可在application.properties檔案中增加其它配置以滿足更多需求。更多資訊,請參見配置項參考

  7. 驗證服務提供者service-provider是否建立成功。

    1. 執行nacos-service-providerProviderApplicationmain函數,啟動應用。

    2. 登入本地啟動的Nacos Server控制台http://127.0.0.1:8848/nacos

      本地Nacos控制台的預設使用者名和密碼同為nacos。

    3. 在左側導覽列,選擇服務管理 > 服務列表

      可以看到服務列表中已經包含service-provider,單擊詳情,查詢該服務的詳情。

步驟二:建立服務消費者

本節介紹服務註冊的功能,以及如何配合使用Nacos服務與RestTemplate和FeignClient兩個用戶端。

  1. 建立名為nacos-service-consumer的Maven工程。

  2. pom.xml中添加依賴。

    展開查看代碼

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/>
    </parent>
    
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2.1.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</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>        
  3. src\main\java下建立Packagecom.aliware.edas

  4. 在Packagecom.aliware.edas中配置RestTemplate和FeignClient。

    1. 在Packagecom.aliware.edas中建立介面類EchoService,添加@FeignClient註解,並配置對應的HTTP URL地址及HTTP方法。

      package com.aliware.edas;
      
      import org.springframework.cloud.openfeign.FeignClient;
      import org.springframework.web.bind.annotation.PathVariable;
      import org.springframework.web.bind.annotation.RequestMapping;
      import org.springframework.web.bind.annotation.RequestMethod;
      
      @FeignClient(name = "service-provider")
      public interface EchoService {
          @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
          String echo(@PathVariable("str") String str);
      }                   
    2. 在Packagecom.aliware.edas中建立啟動類ConsumerApplication並添加相關配置。

      package com.aliware.edas;
      
      import org.springframework.boot.SpringApplication;
      import org.springframework.boot.autoconfigure.SpringBootApplication;
      import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
      import org.springframework.cloud.client.loadbalancer.LoadBalanced;
      import org.springframework.cloud.openfeign.EnableFeignClients;
      import org.springframework.context.annotation.Bean;
      import org.springframework.web.client.RestTemplate;
      
      @SpringBootApplication
      @EnableDiscoveryClient
      @EnableFeignClients
      public class ConsumerApplication {
      
          @LoadBalanced
          @Bean
          public RestTemplate restTemplate() {
              return new RestTemplate();
          }
      
          public static void main(String[] args) {
              SpringApplication.run(ConsumerApplication.class, args);
          }
      }
      • @EnableDiscoveryClient:啟用服務註冊與發現。

      • @EnableFeignClients:啟用FeignClient。

      • @LoadBalanced:整合RestTemplate與服務發現。

  5. 在Packagecom.aliware.edas中建立類TestController以示範和驗證服務發現功能。

        package com.aliware.edas;
    
        import org.springframework.beans.factory.annotation.Autowired;
        import org.springframework.web.bind.annotation.PathVariable;
        import org.springframework.web.bind.annotation.RequestMapping;
        import org.springframework.web.bind.annotation.RequestMethod;
        import org.springframework.web.bind.annotation.RestController;
        import org.springframework.web.client.RestTemplate;
    
        @RestController
        public class TestController {
    
            @Autowired
            private RestTemplate restTemplate;
            @Autowired
            private EchoService echoService;
    
            @RequestMapping(value = "/echo-rest/{str}", method = RequestMethod.GET)
            public String rest(@PathVariable String str) {
                return restTemplate.getForObject("http://service-provider/echo/" + str,
                        String.class);
            }
    
            @RequestMapping(value = "/echo-feign/{str}", method = RequestMethod.GET)
            public String feign(@PathVariable String str) {
                return echoService.echo(str);
            }
    
        }           
  6. src\main\resources路徑下建立檔案application.properties,在application.properties中添加以下配置,指定Nacos Server的地址。

        spring.application.name=service-consumer
        server.port=18082
        spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

    127.0.0.1為Nacos Server的地址。如果您的Nacos Server部署在另外一台機器,需修改為對應的IP地址。您可在application.properties檔案中增加其它配置以滿足更多需求。更多資訊,請參見配置項參考

  7. 驗證結果。

    1. 執行nacos-service-consumerConsumerApplicationmain函數,啟動應用。

    2. 登入本地啟動的Nacos Server控制台http://127.0.0.1:8848/nacos

      本地Nacos控制台的預設使用者名和密碼同為nacos。

    3. 在左側導覽列,選擇服務管理 > 服務列表,可以看到服務列表中已經包含service-consumer,單擊詳情,查詢該服務的詳情。

步驟三:本地測試

在本地測試消費者對提供者的服務調用結果。

  • Linux/Unix/Mac系統:運行以下命令。

    curl http://127.0.0.1:18082/echo-rest/rest-rest
    curl http://127.0.0.1:18082/echo-feign/feign-rest
  • Windows系統:在瀏覽器中輸入http://127.0.0.1:18082/echo-rest/rest-rest和http://127.0.0.1:18082/echo-feign/feign-rest。

後續步驟

應用開發完成後,即可部署到EDAS。具體操作,請參見應用建立和部署概述(ECS)建立和部署應用概述(K8s)

配置項說明

配置項

Key

預設值

說明

服務端地址

spring.cloud.nacos.discovery.server-addr

Nacos Server啟動監聽的IP地址和連接埠。

服務名

spring.cloud.nacos.discovery.service

${spring.application.name}

當前服務的名稱。

網卡名

spring.cloud.nacos.discovery.network-interface

當IP未配置時,註冊的IP為此網卡所對應的IP地址。如果網卡名也未配置,預設取第一塊網卡的地址。

註冊的IP地址

spring.cloud.nacos.discovery.ip

註冊到註冊中心的IP地址。優先順序最高。

註冊的連接埠

spring.cloud.nacos.discovery.port

-1

預設情況下無需配置,系統會自動探測。設定為-1表示不限連接埠。

命名空間

spring.cloud.nacos.discovery.namespace

常用於隔離不同環境的資源,例如開發測試環境和生產環境的資源(如配置、服務)隔離等。

Metadata

spring.cloud.nacos.discovery.metadata

使用Map格式配置,您可以根據自己的需求自訂一些和服務相關的中繼資料資訊。

叢集

spring.cloud.nacos.discovery.cluster-name

DEFAULT

Nacos叢集的名稱。

存取點

spring.cloud.nacos.discovery.endpoint

地區的某個服務的入口網域名稱。通過該網域名稱可以動態地擷取服務端地址,該配置在部署到EDAS時無需填寫。

是否整合Ribbon

ribbon.nacos.enabled

true

是否啟用Ribbon負載平衡。Ribbon是用戶端負載平衡器,通過負載平衡策略選擇其中一個執行個體處理請求。如果沒有明確需求,無需修改。

關於更多Spring Cloud Alibaba Nacos Discovery的資訊,請參見開源版本的Nacos Discovery