使用 Spring 的微服務

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

引言

注意:2019 年 7 月修訂

使用 Spring、Spring Boot 和 Spring Cloud 設定微服務系統的簡單示例。

微服務允許大型系統由許多協作元件構建。它在程序級別實現了 Spring 在元件級別一直做的事情:鬆散耦合的程序而不是鬆散耦合的元件。

Shopping Application

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

不可避免地,您必須設定和配置許多移動部件才能構建這樣的系統。如何使它們協同工作並不明顯——您需要對 Spring Boot 非常熟悉,因為 Spring Cloud 大量利用了它,還需要幾個 Netflix 或其他開源專案,當然,還有一些 Spring 配置的“魔法”!

Demo Application

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

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

此應用程式的程式碼在此處:https://github.com/paulc4/microservices-demo

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

瞭解更多

  • 報名參加 SpringOne Platform 2019 – 使用 Spring 構建可擴充套件微服務應用程式的頂級會議。今年我們將於 10 月 7 日至 10 日在德克薩斯州奧斯汀舉行。使用折扣碼 S1P_Save200 節省您的門票費用。需要幫助說服您的經理嗎?請使用此頁面
  • 獲取 Matt Stine 撰寫的免費電子書 《遷移到雲原生應用程式架構》
  • 網路研討會討論了可幫助您將單體應用程式重新平臺化到現代雲環境的工具和方案。
## 更新(2018 年 6 月)

自從我最初撰寫此部落格以來,發生了一些變化

  1. 關於在同一主機上使用同一服務的多個例項的討論。演示應用程式已更新以匹配。
  2. 關於 @LoadBalanced討論——自從 Brixton 釋出列車(Spring Cloud 1.1.0.RELEASE)以來,它的工作方式已經改變
  3. 將賬戶微服務的配置重構到其自己的類 AccountsConfiguration 中。
  4. 升級到 Spring Boot 2,因此一些 Boot 類的包已更改。
  5. 演示應用程式升級到 Spring Cloud Finchley 釋出列車(包括末尾評論中的各種修復——感謝您的反饋)。
  6. 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。 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(請參閱側面板)。

建立微服務:賬戶服務

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

Beans vs Processes

在使用 Spring 配置應用程式時,我們強調鬆散耦合和緊密內聚。這些並不是新概念(Larry Constantine 因在 1960 年代後期首次定義這些概念而受到讚譽——參考),但現在我們將其應用於互動程序,而不是互動元件(Spring Bean)。

在此示例中,我有一個簡單的賬戶管理微服務,它使用 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);
    }
}

註解完成工作

  1. @EnableAutoConfiguration - 將此定義為 Spring Boot 應用程式。
  2. @EnableDiscoveryClient - 這啟用了服務註冊和發現。在這種情況下,此程序使用其應用程式名稱(見下文)向 發現服務 註冊自己。
  3. @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

請注意此檔案

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

Eureka Dashboard

現在執行 AccountsService 應用程式,讓它完成初始化。重新整理儀表板 https://:1111,您應該會在應用程式下方看到 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 釋出列車下,客戶端用於向發現伺服器註冊的例項 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 服務

為了消費 RESTful 服務,Spring 提供了 RestTemplate 類。這允許您向 RESTful 伺服器傳送 HTTP 請求並以多種格式(例如 JSON 和 XML)獲取資料。

注意:賬戶微服務透過 HTTP 提供 RESTful 介面,但可以使用任何合適的協議。AMQP 或 JMS 的訊息傳遞是一個明顯的替代方案(在這種情況下,不再需要發現伺服器——相反,程序需要知道要與之通訊的佇列名稱,可以考慮使用 Spring Cloud 配置伺服器來完成此操作)。

可以使用哪些格式取決於類路徑中是否存在編組類——例如,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 從微服務獲取資料的包裝器。有趣的部分是 serviceUrlRestTemplate

訪問微服務

如下所示,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
    }
}

有幾點需要注意

  1. WebController 是一個典型的基於 Spring MVC 檢視的控制器,返回 HTML。該應用程式使用 Thymeleaf 作為檢視技術(用於生成動態 HTML)
  2. WebServer 也是一個 @EnableDiscoveryClient,但在這種情況下,它不僅向 發現服務 註冊自己(這是不必要的,因為它不提供自己的服務),還使用 Eureka 來定位賬戶服務。
  3. 繼承自 Spring Boot 的預設元件掃描器設定會查詢 @Component 類,在這種情況下,它會找到我的 WebAccountController 並嘗試建立它。但是,我想自己建立它,因此我透過 @ComponentScan(useDefaultFilters=false) 停用掃描器。
  4. 我傳遞給 WebAccountController服務 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 中的相關配置。它用於

  1. 設定應用程式名稱
  2. 定義訪問發現伺服器的 URL
  3. 將 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:

由於 AccountServiceWebService 都使用 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

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

    <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 Boot 應用程式,使用 Spring Data。註解完成了大部分工作

  1. @SpringBootApplication - 將此定義為 Spring Boot 應用程式。這個方便的註解結合了 @EnableAutoConfiguration@Configuration@ComponentScan(預設情況下,它會導致 Spring 搜尋包含此類的包及其子包中的元件——潛在的 Spring Bean:AccountControllerAccountRepository)。
  2. @EntityScan("io.pivotal.microservices.accounts") - 因為我正在使用 JPA,所以我需要指定 @Entity 類所在的位置。通常,這是您在 JPA 的 persistence.xml 中或建立 LocalContainerEntityManagerFactoryBean 時指定的選項。Spring Boot 將為我建立這個工廠 bean,因為 spring-boot-starter-data-jpa 依賴項在類路徑中。因此,指定在哪裡查詢 @Entity 類的另一種方法是使用 @EntityScan。這將找到 Account
  3. @EnableJpaRepositories("io.pivotal.microservices.accounts") - 查詢擴充套件 Spring Data 的 Repository 標記介面的類,並使用 JPA 自動實現它們——參見 Spring Data JPA
  4. @PropertySource("classpath:db-config.properties") - 配置我的 DataSource 的屬性——參見 db-config.properties

配置屬性

如上所述,Spring Boot 應用程式會查詢 application.propertiesapplication.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 新聞通訊

透過 Spring 新聞通訊保持聯絡

訂閱

領先一步

VMware 提供培訓和認證,助您加速進步。

瞭解更多

獲得支援

Tanzu Spring 提供 OpenJDK™、Spring 和 Apache Tomcat® 的支援和二進位制檔案,只需一份簡單的訂閱。

瞭解更多

即將舉行的活動

檢視 Spring 社群所有即將舉行的活動。

檢視所有