一個C#開發者學習SpringCloud搭建微服務的心路歷程

2022 年 10 月 8 日
筆記
JAVA

前言

Spring Cloud很火，很多文章都有介紹如何使用，但對於我這種初學者，我需要從創建項目開始學起，所以這些文章對於我的啟蒙，幫助不大，所以只好自己寫一篇文章，用於備忘。

SpringCloud是封裝了Netflix公司開發的Eureka模組來實現服務註冊和發現。下圖為Spring Cloud Eureka的本版列表：

下圖為Spring Cloud 微服務的各個實現的總覽。

創建父項目

首先，我們打開IEDA創建項目，然後選擇Maven選項，然後點擊下一步，如下圖：

創建完成後，是一個空的Java父項目，如下圖：

創建服務查詢中心子項目——EurekaServer

EurekaServer是用於服務查詢的，C#開發者可能更熟悉consul，雖然用法不一樣，但實現的效果是一樣的。

現在我們創建一個服務查詢中心項目，在項目上右鍵–>new–>Module–>Spring Initializr–>next，選擇和父類項目同一版本的jdk，如下圖：

然後選擇SpringCloudDiscovery—EurekaServer，如下圖：

創建完成如下圖所示：

打開新建的項目的入口文件——EurekaserverApplication，為EurekaserverApplication類增加註解@EnableEurekaServer，這個註解會將當前類標記為Eureka Server。

然後修改application.properties為application.yml，編寫程式碼如下：

# 配置啟動埠
server:
  port: 5180
# 配置eureka
eureka:
  instance:
    hostname: localhost
  client:
    fetch-registry: false # 表示是否從Eureka Server獲取註冊資訊,默認為true.因為這是一個單點的Eureka Server,不需要同步其他的Eureka Server節點的數據,這裡設置為false
    register-with-eureka: false # 表示是否將自己註冊到Eureka Server,默認為true.由於當前應用就是Eureka Server,故而設置為false.
    service-url:
      # 設置與Eureka Server的地址,查詢服務和註冊服務都需要依賴這個地址.默認是//localhost:8761/eureka/;多個地址可使用','風格.
      defaultZone: //${eureka.instance.hostname}:${server.port}/eureka/

可以看到，上面的配置eureka的hostname是localhost，這個是屬於伺服器端的配置，但還配置了client，裡面配置的內容是不把自己作為服務註冊到Eureka Server服務查詢中，這個配置會讓我們看不懂，為什麼伺服器查詢要配置是否把自己註冊進服務查詢呢？這樣配置的確有點奇怪，調查發現，eureka中的服務端也是個客戶端，這樣做的目的是為了讓服務端也可以互相註冊，實現高可用，但這樣的配置模式，確實很容易讓人誤解，不過既然已經使用了eureka，我們只能死記硬背了。

PS：具體可以搜索org.springframework.cloud.netflix.eureka. EurekaClientConfigBean來查找相關屬性如何配置。

配置好EurekaServer後，我們使用IDEA調試項目，然後在瀏覽器輸入：//localhost:5180/，EurekaServer運行成功，如下圖：

創建普通服務並註冊到服務查詢中心——EurekaClient

下面我們創建一個WebApi，一個使用了EurekaClient的WebApi，項目會通過EurekaClient 將當前項目註冊到服務查詢中心裡，如下個圖：

點擊下一步，然後這次我們選擇SpringCloudDiscovery—Eureka Discovery Client，如下圖：

項目創建成功後，然後我們還是找到入口文件，為KibaApplication類加上@EnableEurekaClient註解，如下圖：

然後修改application.properties為application.yml，編寫程式碼如下：

# 啟動埠
server:
  port: 5181

spring:
  application:
    name: eureka-kiba
# eureka客戶端配置，配置要註冊的服務查詢中心
eureka:
  client:
    service-url:
      defaultZone: //localhost:5180/eureka # 指定服務註冊中心

然後我們在pom.xml里添加spring-boot-starter-web的Jar包引用，程式碼如下：

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

然後創建一個controller文件，再創建一個HelloWorld的java類，如下圖：

然後編輯HelloWorld類，程式碼如下：

package com.client.kiba.controller;

import org.springframework.web.bind.annotation.*;

@RequestMapping(value = "/helloWorld")
@RestController
public class HelloWorld {
    @RequestMapping(value = "/GetName", method = RequestMethod.GET)
    public String GetName()
    {
        return "我是Kiba518";
    }
    @RequestMapping(value = "/GetAge", method = {RequestMethod.GET,RequestMethod.POST})
    public int GetAge()
    {
        return 518;
    }
    @PostMapping("/GetAge1")
    public int GetAge1()
    {
        return 518;
    }
    @GetMapping("/GetAge2")
    public int GetAge2()
    {
        return 518;
    }
}

然後啟動項目，然後在打開我們的eureka服務查詢中心——//localhost:5180/，可以看到服務已經成功註冊進了服務中心。

注意：這裡需要單獨啟動一下我們剛剛建好的項目。

到此，eureka服務註冊就介紹完了。

不得不說，eureka把服務註冊處理的如此簡單，僅僅用配置就搞定了，實在非常優秀。

使用eureka內註冊的服務

創建一個新moudle，創建過程如上。

修改Kiba3Application的程式碼如下：

package com.clinet.kiba3;

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.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
@EnableDiscoveryClient
public class Kiba3Application {

    public static void main(String[] args) {
        SpringApplication.run(Kiba3Application.class, args);
    }
    @Bean
    @LoadBalanced
    RestTemplate restTemplate()
    {
        return new RestTemplate();
    }
}

然後創建RemoteController介面，程式碼如下：

package com.clinet.kiba3.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
@RequestMapping("/Remote")
public class RemoteController {
    @Autowired
    RestTemplate restTemplate;

    /**
     * //localhost:5183/Remote/TestRestRequest
     * @return
     */
    @GetMapping("/TestRestRequest")
    public ResponseEntity<String> TestRestRequest() {
        /**
         * 第一個參數：url——//eureka-kiba2/helloWorld/GetName 這裡把ip替換為在eureka中註冊的名字
         * 第二個參數：返回值類型
         */
        ResponseEntity<String> entity = restTemplate.getForEntity("//eureka-kiba2/helloWorld/GetName", String.class);
        System.out.println("狀態碼:" + entity.getStatusCode());
        System.out.println("響應體" + entity.getBody());

        return ResponseEntity.ok(entity.getBody());

    }      
}

如上所示，遠程調用使用的是RestTemplate，不過調用的URL稍微做了修改，如上所示，我們請求的url地址是【//eureka-kiba2/helloWorld/GetName】，可以看到，我們將ip替換為了在eureka中註冊的應用名了。

在其他的註冊中心中，比如consul，也是通過應用名來調用單體服務的，這種調用模式屬於潛規則了。

下圖為各個單體服務在註冊中心註冊的應用名。

在網頁輸入//localhost:5183/Remote/TestRestRequest，輸出結果如下圖：

PS：Eureka還可以通過配置實現負載均衡，因為註冊到註冊中心的服務，使用【協議+應用名+controller】的模式請求，所以將同一個服務發布到不同伺服器，調用時，因為應用名相同，就可以進行請求分流了，進而實現負載均衡了。

網關

網關的作用主要是將請求重新分發。現在我們新建一個項目用於做網關。

與上文一樣，在項目上右鍵–>new–>Module–>Spring Initializr。

然後在選擇依賴jar包時，選擇Spring Cloud Routing——Getway，如下圖：

在Eureka中，網關也是要作為客戶端註冊進註冊中心的。

也就是說，我們必須引用eureka-client，如下：

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

還要在啟動類上增加@EnableEurekaClient註解，如下：

@EnableEurekaClient
@SpringBootApplication
public class GetwayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GetwayApplication.class, args);
    }

}

然後，我們配置Getway中最複雜的內容，application.yml配置。

詳細配置如下：

server:
  port: 5184
spring:
  application:
    name: getway
  cloud:
    gateway:
      discovery:
        # locator需要打開，不然通過 lb://.. 方式請求不到
        locator:
          enabled: true #開啟 Gateway 服務註冊中心服務發現
      routes:
        - id: kiba1 # 路由的id,要求唯一,通常使用應用名
          uri: lb://eureka-kiba #lb是一個動態路由協議，後面的eureka-kiba 是要跳轉的服務名稱。
          predicates:
            - Path=/kiba1/helloWorld/** # 指定匹配的controller，也可以指定到方法，比如 - Path=/helloWorld/GetName/** 這裡kiba1會在下面被過濾掉，即請求的是lb://eureka-kiba/helloworld
          filters:
            - StripPrefix=1 #過濾掉一個請求前綴
            # JwtAuthorization
        - id: kiba2
          uri: lb://eureka-kiba2
          predicates:
            - Path=/kiba2/helloWorld_kiba2/**
          filters:
            - StripPrefix=1


eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: //localhost:5180/eureka #註冊中心地址
#    healthcheck:
#      enabled: true

請求註冊中心的服務採用【協議+應用名+controller】的模式，但在Getway里，需要把協議從http改為了lb，才能請求註冊中心的服務，開啟lb協議需要配置locator的enable為true。

應用名就是在註冊中心註冊的應用名，

routes：指定下面就是配置路由的配置模組。

id：路由的id,要求唯一,通常使用應用名。

predicates：斷言，就是判斷請求是否符合條件，符合條件方可請求，即使用一些已經定義好的配置條件過濾。

predicates—Path：指定匹配的controller，也可以指定到方法，比如 – Path=/helloWorld/**，這樣配置的話就是要求，請求url格式必須為//localhost:5184/helloWorld，不然就請求失敗。

filters：過濾，可以過濾請求資訊，這裡只用到了過濾路由的路徑。

filters—StripPrefix：過濾掉請求地址總的路徑，每個【/】分割一對路徑，這個功能非常有用，因為配置路徑時，通常會加上前綴來區分服務，這個過濾可以過濾掉前綴。

配置完成後啟動項目，訪問如下地址，結果如下：

//localhost:5184/kiba1/helloWorld/GetName