使用 Spring 構建微服務

工程 | Paul Chapman | 2015 年 7 月 14 日 | ...

引言

注意： 於 2019 年 7 月修訂

一個使用 Spring、Spring Boot 和 Spring Cloud 構建微服務系統的簡單示例。

微服務允許大型系統由許多協作元件構建而成。它在程序級別實現了 Spring 在元件級別一直以來所做的事情：鬆散耦合的程序代替了鬆散耦合的元件。

例如，設想一個線上商店，其中包含獨立的使用者賬戶、產品目錄、訂單處理和購物車微服務。

構建這樣的系統不可避免地需要設定和配置許多活動部件。如何讓它們協同工作並非顯而易見——你需要非常熟悉 Spring Boot，因為 Spring Cloud 大量使用了它，還需要一些 Netflix 或其他開源專案，當然，還有一些 Spring 配置的“魔力”！

在本文中，我旨在透過逐步構建最簡單的系統來闡明其工作原理。因此，我將只實現大型系統的一小部分——使用者賬戶服務。

Web 應用將使用 RESTful API 向 Account-Service 微服務發出請求。我們還需要新增一個發現服務——以便其他程序可以相互查詢。

此應用程式的程式碼在這裡：https://github.com/paulc4/microservices-demo。

本文故意詳細描述了其工作原理。不耐煩的讀者可能更喜歡直接檢視程式碼。請注意，它在一個專案中包含了三個微服務。

瞭解更多

報名參加 SpringOne Platform 2019 – 使用 Spring 構建可擴充套件微服務應用的頂級大會。今年大會於 10 月 7 日至 10 日在德克薩斯州奧斯汀舉行。使用折扣碼 S1P_Save200 節省票價。需要說服你的經理？請使用此頁面。
獲取 Matt Stine 撰寫的免費電子書 Migrating to Cloud-Native Architectures (遷移到雲原生架構)
本次網路研討會討論了幫助您將單體應用重新平臺化到現代雲環境的工具和方法。

## 更新 (2018 年 6 月)

自我最初撰寫此部落格以來的一些更改

關於在同一主機上使用同一服務的多個例項的討論。演示應用程式已更新以匹配。
關於 @LoadBalanced 的討論 - 自 Brixton 釋出列 (Spring Cloud 1.1.0.RELEASE) 以來，其工作方式已發生變化。
將賬戶微服務的配置重構到其自己的類 AccountsConfiguration 中。
升級到 Spring Boot 2，因此一些 Boot 類的包已更改。
將演示應用程式升級到 Spring Cloud Finchley 釋出列（包括末尾評論中的各種修復 - 感謝反饋）。
Eureka 伺服器依賴項已更改為 spring-cloud-starter-netflix-eureka-server。

使用 Spring Boot 1.5.10 和 Spring Cloud Edgeware SR3 的舊版本可作為 git 標籤 v1.2.0 獲取。

好了，我們開始吧...

服務註冊

當多個程序協同工作時，它們需要相互查詢。如果您曾使用過 Java 的 RMI 機制，您可能會記得它依賴於一箇中心登錄檔，以便 RMI 程序可以相互查詢。微服務也有同樣的需求。

Netflix 的開發人員在構建他們的系統時遇到了這個問題，並建立了一個名為 Eureka（希臘語意為“我找到了”）的註冊伺服器。幸運的是，他們將其發現伺服器開源，Spring 也將其整合到 Spring Cloud 中，使得執行 Eureka 伺服器更加容易。下面是這個完整的發現伺服器應用程式

@SpringBootApplication
@EnableEurekaServer
public class ServiceRegistrationServer {

  public static void main(String[] args) {
    // Tell Boot to look for registration-server.yml
    System.setProperty("spring.config.name", "registration-server");
    SpringApplication.run(ServiceRegistrationServer.class, args);
  }
}

就是這麼簡單！

Spring Cloud 構建在 Spring Boot 之上，並利用了父 POM 和 Starter POM。POM 中的重要部分是

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <!-- Setup Spring Boot -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <!-- Setup Spring MVC & REST, use Embedded Tomcat -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <!-- Spring Cloud starter -->
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter</artifactId>
        </dependency>

        <dependency>
            <!-- Eureka for service registration -->
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
        </dependency>
    </dependencies>

   <!-- Spring Cloud dependencies -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

此 POM 自我最初撰寫本文以來已更改為使用 Spring Boot 作為其父級，而非 Spring Cloud。Spring Cloud 依賴項透過依賴管理部分提供。

github 程式碼中還包含一個示例 gradle 構建檔案。

注意： Finchley.RELEASE 是當前的“釋出列”——一組協調一致的版本 -- 參見 Spring Cloud 主頁上的說明。

預設情況下，Spring Boot 應用程式會查詢 application.properties 或 application.yml 檔案進行配置。透過設定 spring.config.name 屬性，我們可以告訴 Spring Boot 查詢不同的檔案——當您在同一個專案中有多個 Spring Boot 應用程式時這很有用——我很快就會這樣做。

此應用程式查詢 registration-server.properties 或 registration-server.yml。以下是 registration-server.yml 中的相關配置

# Configure this Discovery Server
eureka:
  instance:
    hostname: localhost
  client:  # Not a client, don't register with yourself (unless running
           # multiple discovery servers for redundancy)
    registerWithEureka: false
    fetchRegistry: false

server:
  port: 1111   # HTTP (Tomcat) port

預設情況下，Eureka 執行在埠 8761 上，但這裡我們將使用埠 1111 代替。此外，透過在我的程序中包含註冊程式碼，我可能是一個伺服器或一個客戶端。配置指定我不是客戶端，並阻止伺服器程序嘗試向自身註冊。

使用 Consul

Spring Cloud 還支援將 Consul 作為 Eureka 的替代方案。您可以使用指令碼啟動 Consul Agent（其註冊伺服器），然後客戶端使用它來查詢其微服務。有關詳細資訊，請參見這篇部落格文章或專案主頁。

現在嘗試執行 RegistrationServer（有關執行應用程式的幫助，請參見下文）。您可以在此處開啟 Eureka 控制面板：https://:1111，顯示應用程式的部分將是空的。

從現在開始，我們將稱之為發現伺服器，因為它可能是 Eureka 或 Consul（參見側邊欄）。

建立一個微服務：Account-Service

微服務是一個獨立的程序，用於處理明確定義的需求。

在使用 Spring 配置應用程式時，我們強調鬆散耦合和緊密內聚。這些並非新概念（Larry Constantine 在 20 世紀 60 年代末首次定義了這些概念 - 參考），但現在我們將它們應用於互動程序，而非互動元件 (Spring Beans)。

在這個示例中，我有一個簡單的賬戶管理微服務，它使用 Spring Data 實現 JPA AccountRepository，並使用 Spring REST 提供賬戶資訊的 RESTful 介面。從大多數方面來看，這是一個直截了當的 Spring Boot 應用程式。

其特別之處在於它在啟動時會向發現伺服器註冊自己。以下是 Spring Boot 的啟動類

@EnableAutoConfiguration
@EnableDiscoveryClient
@Import(AccountsWebApplication.class)
public class AccountsServer {

    @Autowired
    AccountRepository accountRepository;

    public static void main(String[] args) {
        // Will configure using accounts-server.yml
        System.setProperty("spring.config.name", "accounts-server");

        SpringApplication.run(AccountsServer.class, args);
    }
}

註解完成了工作

@EnableAutoConfiguration - 將其定義為一個 Spring Boot 應用程式。
@EnableDiscoveryClient - 這啟用了服務註冊和發現。在這種情況下，此程序使用其應用程式名稱（見下文）向發現伺服器服務註冊自己。
@Import(AccountsWebApplication.class) - 這個 Java 配置類設定了其他所有內容（有關更多詳細資訊，請參見下文）。

使其成為微服務的是透過 @EnableDiscoveryClient 向發現伺服器進行的註冊，其 YML 配置完成了設定

# Spring properties
spring:
  application:
     name: accounts-service

# Discovery Server Access
eureka:
  client:
    serviceUrl:
      defaultZone: https://:1111/eureka/

# HTTP Server
server:
  port: 2222   # HTTP (Tomcat) port

請注意，此檔案

將應用程式名稱設定為 accounts-service。此服務以該名稱註冊，也可以透過該名稱訪問——見下文。
指定一個自定義埠進行監聽 (2222)。我的所有程序都使用 Tomcat，它們不能都監聽 8080 埠。
Eureka 服務程序的 URL - 來自上一節。

現在執行 AccountsService 應用程式並等待其初始化完成。重新整理控制面板 https://:1111，您應該在 Applications 下看到 ACCOUNTS-SERVICE。註冊最多需要 30 秒（預設），請耐心等待——檢視 RegistrationService 的日誌輸出。

警告：請勿嘗試使用 Eclipse/STS 的內部網頁檢視器顯示 XML 輸出，因為它無法做到。請改用您喜歡的網頁瀏覽器。

有關更多詳細資訊，請訪問此處：https://:1111/eureka/apps/，您應該看到類似以下內容

<applications>
    <versions__delta>1</versions__delta>
    <apps__hashcode>UP_1_</apps__hashcode>
    <application>
        <name>ACCOUNTS-SERVICE</name>
        <instance>
            <hostName>autgchapmp1m1.corp.emc.com</hostName>
            <app>ACCOUNTS-SERVICE</app>
            <ipAddr>172.16.84.1</ipAddr><status>UP</status>
            <overriddenstatus>UNKNOWN</overriddenstatus>
            <port enabled="true">3344</port>
            <securePort enabled="false">443</securePort>
            ...
        </instance>
    </application>
</applications>

或者訪問 https://:1111/eureka/apps/ACCOUNTS-SERVICE，只檢視 AccountsService 的詳細資訊 - 如果未註冊，您將收到 404 錯誤。

配置選項

註冊時間：註冊最多需要 30 秒，因為這是預設的客戶端重新整理時間。您可以透過將 eureka.instance.leaseRenewalIntervalInSeconds 屬性設定為更小的值來更改此設定（在演示應用程式中我將其設定為 5）。在生產環境中不建議這樣做。另請參見此處。

eureka:
  instance:
    leaseRenewalIntervalInSeconds: 5         # DO NOT DO THIS IN PRODUCTION

註冊 ID：一個程序（微服務）使用唯一的 ID 向發現服務註冊。如果另一個程序使用相同的 ID 註冊，則將其視為重新啟動（例如某種故障轉移或恢復），並且第一個程序的註冊將被丟棄。這為我們提供了所需的容錯系統。

要運行同一程序的多個例項（用於負載均衡和彈性），它們需要使用唯一的 ID 進行註冊。當我第一次撰寫這篇部落格時，這是自動的，自從 Brixton 釋出列以來，它又恢復了自動註冊。

在 Angel 釋出列下，客戶端用於向發現伺服器註冊的 instance-id 源自客戶端的服務名稱（與 Spring 應用程式名稱相同）以及客戶端的主機名。因此，在同一主機上執行的同一程序會具有相同的 ID，所以只能註冊一個例項。

幸運的是，您可以透過客戶端的 Eureka 元資料對映手動設定 id 屬性，如下所示

eureka:
  instance:
    metadataMap:
      instanceId: ${spring.application.name}:${spring.application.instance_id:${server.port}}

自從 Brixton 釋出列以來，這現在是預設設定。那麼它有什麼作用呢？

我們將 instanceId 設定為 application-name:instance_id，但如果 instance_id 未定義，我們將使用 application-name::server-port 代替。請注意，spring.application.instance_id 僅在使用 Cloud Foundry 時設定，但它方便地為同一應用程式的每個例項提供一個唯一的 ID 號。在其他地方執行時，我們可以使用伺服器埠做類似的事情（因為同一機器上的不同例項必須監聽不同的埠）。您經常看到的另一個示例是 ${spring.application.name}:${spring.application.instance_id:${random.value}}，但我個人認為使用埠號更容易識別每個例項 - 隨機值只是沒有意義的長字串。

注意：語法 ${x:${y}} 是 Spring 屬性的簡寫形式，表示 ${x} != null ? ${x} : ${y}。

自 Brixton 版本釋出以來，還有一個專門為此目的的屬性

eureka:
  instance:
    instanceId: ${spring.application.name}:${spring.application.instance_id:${random.value}}

訪問微服務：Web-Service

要消費 RESTful 服務，Spring 提供了 RestTemplate 類。它允許您向 RESTful 伺服器傳送 HTTP 請求，並以多種格式（例如 JSON 和 XML）獲取資料。

注意：賬戶微服務透過 HTTP 提供 RESTful 介面，但可以使用任何合適的協議。使用AMQP或 JMS 進行訊息傳遞是一個顯而易見的替代方案（在這種情況下，不再需要發現伺服器 - 而是程序需要知道要通訊的佇列名稱，可以考慮使用Spring Cloud Configuration Server 來管理）。

可以使用哪種格式取決於類路徑中是否存在編組類——例如，JAXB 總是會被檢測到，因為它是 Java 的標準部分。如果類路徑中存在 Jackson 的 jar 包，則支援 JSON。

微服務（發現）客戶端可以使用 RestTemplate，Spring 會自動將其配置為具備微服務感知能力（稍後會詳細介紹）。

封裝微服務訪問

以下是我的客戶端應用程式的 WebAccountService 的一部分

@Service
public class WebAccountsService {

    @Autowired        // NO LONGER auto-created by Spring Cloud (see below)
    @LoadBalanced     // Explicitly request the load-balanced template
                      // with Ribbon built-in
    protected RestTemplate restTemplate; 

    protected String serviceUrl;

    public WebAccountsService(String serviceUrl) {
        this.serviceUrl = serviceUrl.startsWith("http") ?
               serviceUrl : "http://" + serviceUrl;
    }

    public Account getByNumber(String accountNumber) {
        Account account = restTemplate.getForObject(serviceUrl
                + "/accounts/{number}", Account.class, accountNumber);

        if (account == null)
            throw new AccountNotFoundException(accountNumber);
        else
            return account;
    }
    ...
}

請注意，我的 WebAccountService 只是一個 RestTemplate 的包裝器，用於從微服務中獲取資料。有趣的部分是 serviceUrl 和 RestTemplate。

訪問微服務

如下所示，serviceUrl 由主程式提供給 WebAccountController（後者又將其傳遞給 WebAccountService）

@SpringBootApplication
@EnableDiscoveryClient
@ComponentScan(useDefaultFilters=false)  // Disable component scanner
public class WebServer {

    // Case insensitive: could also use: http://accounts-service
    public static final String ACCOUNTS_SERVICE_URL
                                        = "http://ACCOUNTS-SERVICE";

    public static void main(String[] args) {
        // Will configure using web-server.yml
        System.setProperty("spring.config.name", "web-server");
        SpringApplication.run(WebServer.class, args);
    }

    @LoadBalanced    // Make sure to create the load-balanced template
    @Bean
    RestTemplate restTemplate() {
        return new RestTemplate();
    }

    /**
     * Account service calls microservice internally using provided URL.
     */
    @Bean
    public WebAccountsService accountsService() {
        return new WebAccountsService(ACCOUNTS_SERVICE_URL);
    }

    @Bean
    public WebAccountsController accountsController() {
         return new WebAccountsController
                       (accountsService());  // plug in account-service
    }
}

需要注意的幾點

WebController 是一個典型的基於檢視的 Spring MVC 控制器，返回 HTML。該應用程式使用 Thymeleaf 作為檢視技術（用於生成動態 HTML）
WebServer 也是一個 @EnableDiscoveryClient，但在這種情況下，除了向發現伺服器註冊自己（這不是必需的，因為它不提供自己的服務）之外，它還使用 Eureka 來定位賬戶服務。
從 Spring Boot 繼承的預設元件掃描器設定會查詢 @Component 類，並在此示例中找到我的 WebAccountController 並嘗試建立它。然而，我想自己建立它，所以我透過 @ComponentScan(useDefaultFilters=false) 停用了掃描器。
我傳遞給 WebAccountController 的 service-url 是該服務用於向發現伺服器註冊自己的名稱——預設情況下，這與程序的 spring.application.name 相同，即 account-service——參見上面的 account-service.yml。使用大寫字母不是必需的，但這有助於強調 ACCOUNTS-SERVICE 是一個邏輯主機（將透過發現獲得），而不是實際主機。

負載均衡的 RestTemplate

RestTemplate bean 將被 Spring Cloud 攔截並自動配置（由於 @LoadBalanced 註解），以使用一個自定義的 HttpRequestClient，該客戶端使用 Netflix Ribbon 進行微服務查詢。Ribbon 也是一個負載均衡器，因此如果一個服務有多個可用例項，它會為您選擇一個。（Eureka 和 Consul 本身都不執行負載均衡，所以我們使用 Ribbon 來完成）。

注意：從 Brixton 釋出列 (Spring Cloud 1.1.0.RELEASE) 開始，RestTemplate 不再自動建立。最初它是為您建立的，這導致了混淆和潛在的衝突（有時 Spring 會過於樂於助人！）。

請注意，此例項使用 @LoadBalanced 進行了限定。（該註解本身被 @Qualifier 註解 - 有關詳細資訊，請參見此處）。因此，如果您有多個 RestTemplate bean，可以確保注入正確的那個，如下所示

    @Autowired
    @LoadBalanced     // Make sure to inject the load-balanced template
    protected RestTemplate restTemplate;

如果您檢視 RibbonClientHttpRequestFactory，您將看到以下程式碼

    String serviceId = originalUri.getHost();
    ServiceInstance instance =
             loadBalancer.choose(serviceId);  // loadBalancer uses Ribbon
    ... if instance non-null (service exists) ...
    URI uri = loadBalancer.reconstructURI(instance, originalUri);

loadBalancer 接收邏輯服務名稱（已向發現伺服器註冊）並將其轉換為所選微服務的實際主機名。

RestTemplate 例項是執行緒安全的，可用於訪問應用程式不同部分的任意數量的服務（例如，我可能有一個 CustomerService 包裝同一個 RestTemplate 例項，訪問客戶資料微服務）。

配置

下面是來自 web-server.yml 的相關配置。它用於

設定應用程式名稱
定義訪問發現伺服器的 URL
將 Tomcat 埠設定為 3333

# Spring Properties
spring:
  application:
     name: web-service

# Discovery Server Access
eureka:
  client:
    serviceUrl:
      defaultZone: https://:1111/eureka/

# HTTP Server
server:
  port: 3333   # HTTP (Tomcat) port

# 如何執行演示

此係統的小型演示位於 http://github.com/paulc4/microservices-demo。克隆它並載入到您喜歡的 IDE 中，或直接使用 maven。關於如何執行演示的建議包含在專案主頁的 README 中。

額外說明

關於這些應用程式使用 Spring Boot 的一些說明。如果您不熟悉 Spring Boot，這解釋了一些“魔力”！

檢視模板引擎

Eureka 控制面板（在 RegistrationServer 內部）使用 FreeMarker 模板實現，而另外兩個應用程式使用 Thymeleaf。為了確保每個應用程式使用正確的檢視引擎，每個 YML 檔案中都有額外的配置。

這在 registration-server.yml 的末尾，用於停用 Thymeleaf。

...
# Discovery Server Dashboard uses FreeMarker.  Don't want Thymeleaf templates
spring:
  thymeleaf:
    enabled: false     # Disable Thymeleaf spring:

由於 AccountService 和 WebService 都使用 thymeleaf，我們還需要將每個應用程式指向其自己的模板。以下是 account-server.yml 的一部分

# Spring properties
spring:
  application:
     name: accounts-service  # Service registers under this name
  freemarker:
    enabled: false      # Ignore Eureka dashboard FreeMarker templates
  thymeleaf:
    cache: false        # Allow Thymeleaf templates to be reloaded at runtime
    prefix: classpath:/accounts-server/templates/
                        # Template location for this application only
...

web-server.yml 類似，但其模板由以下內容定義

   prefix: classpath:/web-server/templates/

請注意每個 spring.thymeleaf.prefix 類路徑末尾的 / - 這是關鍵。

命令列執行

編譯後的 jar 包在命令列呼叫時會自動執行 io.pivotal.microservices.services.Main - 參見 Main.java。

在 POM 中可以看到 Spring Boot 設定 start-class 的選項

    <properties>
        <!-- Stand-alone RESTFul application for testing only -->
        <start-class>io.pivotal.microservices.services.Main</start-class>
    </properties>

AccountsConfiguration 類

@SpringBootApplication
@EntityScan("io.pivotal.microservices.accounts")
@EnableJpaRepositories("io.pivotal.microservices.accounts")
@PropertySource("classpath:db-config.properties")
public class AccountsWebApplication {
...
}

這是 AccountService 的主要配置類，它是一個使用 Spring Data 的經典 Spring Boot 應用程式。註解完成了大部分工作

@SpringBootApplication - 將其定義為一個 Spring Boot 應用程式。這個便捷註解結合了 @EnableAutoConfiguration、@Configuration 和 @ComponentScan（後者預設會使 Spring 掃描包含此類的包及其子包，查詢元件——潛在的 Spring Bean：AccountController 和 AccountRepository）。
@EntityScan("io.pivotal.microservices.accounts") - 因為我使用 JPA，我需要指定 @Entity 類在哪裡。通常這是您在 JPA 的 persistence.xml 或建立 LocalContainerEntityManagerFactoryBean 時指定的選項。Spring Boot 會為我建立這個 factory-bean，因為 spring-boot-starter-data-jpa 依賴項在類路徑上。所以指定查詢 @Entity 類的另一種方法是使用 @EntityScan。它將找到 Account。
@EnableJpaRepositories("io.pivotal.microservices.accounts") - 查詢擴充套件 Spring Data 的 Repository 標記介面的類，並使用 JPA 自動實現它們——參見Spring Data JPA。
@PropertySource("classpath:db-config.properties") - 用於配置我的 DataSource 的屬性——參見 db-config.properties。

配置屬性

如上所述，Spring Boot 應用程式會查詢 application.properties 或 application.yml 來配置自身。由於此應用程式中使用的所有三個伺服器都在同一個專案中，它們會自動使用相同的配置。

為避免這種情況，每個應用程式都透過設定 spring.config.name 屬性來指定一個替代檔案。

例如，以下是 WebServer.java 的一部分。

public static void main(String[] args) {
  // Tell server to look for web-server.properties or web-server.yml
  System.setProperty("spring.config.name", "web-server");
  SpringApplication.run(WebServer.class, args);
}

執行時，應用程式將在 src/main/resources 中找到並使用 web-server.yml。

日誌記錄

Spring Boot 預設將 Spring 的日誌級別設定為 INFO。由於我們需要檢查日誌以確認微服務是否正常工作，我已將級別提高到 WARN 以減少日誌量。

為此，需要在每個 xxxx-server.yml 配置檔案中指定日誌級別。這通常是定義它們的最佳位置，因為日誌屬性不能在屬性檔案中指定（日誌在處理 @PropertySource 指令之前就已經初始化了）。在 Spring Boot 手冊中有一個關於這方面的說明，但很容易忽略。

我沒有在每個 YAML 檔案中重複日誌配置，而是選擇將其放在 logback 配置檔案中，因為 Spring Boot 使用 logback - 請參閱 src/main/resources/logback.xml。所有三個服務將共享同一個 logback.xml。

Spring 部落格