SpringCloud 微服務實戰筆記

• 2019 年 11 月 11 日
• 筆記

這是很早以前在我的博客上寫的關於 SpringCloud 的一些實戰筆記，現在我把這些實戰筆記集合起來貼到這裡，可能會對一些剛剛接觸 SpringCloud 微服務的小夥伴有幫助。

SpringBoot 構建項目

在我們使用傳統的 spring 開發一個 web 應用程序通常會想到一些基本的需要：

• web.xml 文件（配置 springMVC 的 DispatcherServlet，各種過濾器等等）；
• 啟用了 springMVC 的 spring 配置文件；
• mybatis 等數據庫配置文件等。

以上的這些僅僅只是基本的需求，無論是開發一個大型項目或者只是一個 hello word 程序，都需要配置幾乎同等的配置文件，既然這些都是通用的東西，那有什麼東西可以把這些給自動配置了呢？這時候 springboot 的自動配置功能就派上用場了，springboot 會為這些常用的配置進行自動配置。這些自動配置涉及很多方面，比如：java 持久化 api，各種 web 模板，springMVC 等等。

1. 起步依賴

平時我們使用 maven 創建一個 web 項目的時候，常常需要想項目需要哪些包，以及包的版本。但是在 springboot 創建 web 應用的時候，你只需你只需添加 springboot 的 Web 起步依賴（org.springframework.boot:spring-boot-starter-web）。它會根據依賴傳遞把其他所需依賴引入項目裏面。

而其它你需要的功能，你只需要引入相關的的起步依賴即可。

2. 內嵌 Servlet 容器

其實 springboot 並不是一個應用服務器，它之所以可以運行 web 應用程序，是因為其內部已經內嵌了一個 Servlet 容器（Tomcat、Jetty 或 Undertow），其運行原理是把 web 應用直接打包成為一個 jar/war，然後這個 jar/war 是可以直接啟動的，不需要另外配置一個 Web Server。相關的 embed 類就是它的依賴包。

3. Spring Initializr 構建 springboot 應用程序

本文使用的是 intellij idea 中的 Spring Initializr 工具創建 springboot 應用程序。

菜單欄中選擇File=>New=>Project..，步驟大概是選擇構建的工程類型，如：maven，Gradle；language 的選擇；選擇 Spring Boot 版本和起步依賴包等等。具體創建步驟這裡就省略了。

spring boot 項目結構如圖所示，整個項目結構遵循了 maven 項目的布局，主要的應用程序代碼位於 src/main/java 目錄里，資源都在 src/main/resources 目錄里，測試代碼則在 src/test/java 目錄里。不同的是，web 頁面模板移到 templates 了，我的項目現在主要用 thymeleaf 模板作為 web 頁面。

在結構圖你會發現一些與 springboot 密切項目的文件：

• WebGatewayApplication.java：應用程序的啟動引導類（bootstrap class），也是主要的 Spring 配置類；
• application.properties：用於配置應用程序和 Spring Boot 的屬性；
• ReadingListApplicationTests.java：一個基本的集成測試類。
• banner.txt：spring boot 應用程序啟動時加載的文件。

3.1 啟動引導 Spring

前面我們看到的 WebGatewayApplication.java 在 springboot 應用程序中主要有兩個作用：配置和啟動引導。而也是 Spring 的主要配置類。雖然 springboot 的自動配置免除了很多 Spring 配置，但你還需要進行少量配置來啟用自動配置。

程序清單：

package com.crm;  import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;    @SpringBootApplication  // 開啟組件掃描和自動配置  public class WebGatewayApplication {      public static void main(String[] args) {      	SpringApplication.run(WebGatewayApplication.class, args);// 啟動引導應用程序      }  }  

3.2 配置應用程序屬性

用 Spring Initializr 生成的 application.properties 文件只是一個空文件，它可以刪除完全不影響應用程序的運行，但是，如果你想修改應用程序的屬性，你就得在裏面配置相關屬性了，比如你在裏面配置了 server.port=9010，嵌入式的 tomcat 服務器的監聽端口就不是默認的 8080 了，變成了 9010。而且這個屬性文件是自動被加載的。

這是我的項目 application.properties 屬性配置：

###### MySQL配置  spring.datasource.name=test  spring.datasource.url=jdbc:mysql://localhost:3306/crm?characterEncoding=UTF8  spring.datasource.username=zch  spring.datasource.password=123456  spring.datasource.driver-class-name=com.mysql.jdbc.Driver  spring.datasource.filters=stat  spring.datasource.maxActive=20  spring.datasource.initialSize=1  spring.datasource.maxWait=60000  spring.datasource.minIdle=1  spring.datasource.timeBetweenEvictionRunsMillis=60000  spring.datasource.minEvictableIdleTimeMillis=300000  spring.datasource.validationQuery=select 'x'  spring.datasource.testWhileIdle=true  spring.datasource.testOnBorrow=false  spring.datasource.testOnReturn=false  spring.datasource.poolPreparedStatements=true  spring.datasource.maxOpenPreparedStatements=20  ###### mybatis  mybatis.typeAliasesPackage=com.joosure.integral.cloud.pojo.cloud  mybatis.mapperLocations=classpath:mapper/*.xml  ####### thymeleaf  spring.thymeleaf.cache=false  spring.thymeleaf.check-template-location=true  spring.thymeleaf.content-type=text/html  spring.thymeleaf.enabled=true  spring.thymeleaf.encoding=UTF-8  spring.thymeleaf.excluded-view-names=  spring.thymeleaf.mode=HTML5  spring.thymeleaf.prefix=classpath:/templates/  spring.thymeleaf.suffix=.html  spring.thymeleaf.template-resolver-order=  

3.3 構建過程解釋

我的項目用的是 maven 作為構建工具，因此用 Spring Initializr 會生成 pom.xml 文件，這與創建普通的 maven 項目一樣，代碼清單如下：

<version>0.0.1-SNAPSHOT</version>  	<packaging>jar</packaging>    	<name>crm</name>  	<description>crm-system</description>    	<parent> <!-- 從spring-boot-starterparent繼承版本號 -->  		<groupId>org.springframework.boot</groupId>  		<artifactId>spring-boot-starter-parent</artifactId>  		<version>1.5.3.RELEASE</version>  		<relativePath/> <!-- lookup parent from repository -->  	</parent>    	<properties>  		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>  		<java.version>1.8</java.version>  	</properties>    	<dependencies><!-- 起步依賴 -->  		<dependency>  			<groupId>org.springframework.boot</groupId>  			<artifactId>spring-boot-starter-aop</artifactId>  		</dependency>    		<!--web及模板引擎-->  		<dependency>  			<groupId>org.springframework.boot</groupId>  			<artifactId>spring-boot-starter-thymeleaf</artifactId>  		</dependency>  		<dependency>  			<groupId>org.springframework.boot</groupId>  			<artifactId>spring-boot-starter-web</artifactId>  		</dependency>    		<!--數據庫-->  		<dependency>  			<groupId>mysql</groupId>  			<artifactId>mysql-connector-java</artifactId>  			<scope>runtime</scope>  		</dependency>  		<dependency>  			<groupId>org.springframework.boot</groupId>  			<artifactId>spring-boot-starter-jdbc</artifactId>  		</dependency>  		<dependency>  			<groupId>org.mybatis.spring.boot</groupId>  			<artifactId>mybatis-spring-boot-starter</artifactId>  			<version>1.3.0</version>  		</dependency>    		<!--測試-->  		<dependency>  			<groupId>org.springframework.boot</groupId>  			<artifactId>spring-boot-starter-test</artifactId>  			<scope>test</scope>  		</dependency>  	</dependencies>    	<build><!-- 運行spring boot插件 -->  		<plugins>  			<plugin>  				<groupId>org.springframework.boot</groupId>  				<artifactId>spring-boot-maven-plugin</artifactId>  			</plugin>  		</plugins>  	</build>    </project>  

• 其中 Artifact ID 為 spring-boot-starter-xxx 的都是 spring boot 起步依賴；
• 構建插件的主要功能是把項目打包成一個可執行的超級 JAR（uber-JAR），包括把應用程序的所有依賴打入 JAR 文件內，並為 JAR 添加一個描述文件，其中的內容能讓你用 java -jar 來運行應用程序；
• Maven 構建說明中還將 spring-boot-starter-parent 作為上一級，這樣一來就能利用 Maven 的依賴管理功能，繼承很多常用庫的依賴版本，在你聲明依賴時就不用再去指定版本號了。

服務註冊與發現

現在公司的積分聯盟平台系統構建於公司內部的第 4 代架構中，而第 4 代就是 基於 SpringCloud 的微服務架構，趁着項目上手，花了幾天研究了一下。

SpringCloud 是一個龐大的分佈式系統，它包含了眾多模塊，其中主要有：服務發現（Eureka），斷路器（Hystrix），智能路由（Zuul），客戶端負載均衡（Ribbon）等。也就是說微服務架構就是將一個完整的應用從數據存儲開始垂直拆分成多個不同的服務，每個服務都能獨立部署、獨立維護、獨立擴展，服務與服務間通過諸如 RESTful API 的方式互相調用。

1. 創建服務註冊中心

• 在搭建 SpringCloud 分佈式系統前我們需要創建一個註冊服務中心，以便監控其餘模塊的狀況。這裡需要在 pom.xml 中引入：

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

• 並且在 SpringBoot 主程序中加入@EnableEurekaServer 註解：

@EnableEurekaServer  @SpringCloudApplication  public class EurekaServerApplication {        public static void main(String[] args) {          SpringApplication.run(EurekaServerApplication.class, args);      }  }  

• 接下來在 SpringBoot 的屬性配置文件 application.properties 中如下配置：

server.port=9100  eureka.client.register-with-eureka=false  eureka.client.fetch-registry=false  eureka.client.serviceUrl.defaultZone=http://localhost:${server.port}/eureka/  

server.port 就是你指定註冊服務中心的端口號，在啟動服務後，可以通過訪問http://localhost:9100服務發現頁面，如下：

2. 創建服務方

我們可以發現其它系統在這裡註冊並顯示在頁面上了，想要註冊到服務中心，需要在系統上做一些配置，步驟跟創建服務註冊中心類似，這裡 web-gateway 系統做例子：

• 首先在 pom.xml 中加入：

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

• 在 SpringBoot 主程序中加入@EnableDiscoveryClient 註解，該註解能激活 Eureka 中的DiscoveryClient實現，才能實現 Controller 中對服務信息的輸出：

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

• 在 SpringBoot 的屬性配置文件 application.properties 中如下配置：

spring.application.name=web-gateway  server.port=9010  eureka.client.serviceUrl.defaultZone=http://localhost:9100/eureka/  eureka.instance.leaseRenewalIntervalInSeconds=5  

再次啟動服務中心，打開鏈接：http://localhost:9100/，就可以看到剛剛創建的服務了。

服務消費者

在系統與系統之間，如何進行相互間的調用呢？也就是說怎麼去調用服務提供的接口內容呢？這裡就要說一下 Ribbon 了，Ribbon 是一個基於 http 和 tcp 客戶端的負載均衡器。

下面我來簡單介紹如何在 SpringCloud 分佈式系統下使用 Ribbon 來實現負載均衡。

• 首先在 pom.xml 中引入一下依賴：

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

• 然後在 spring boot 主程序中創建 RestTemplate 類，並為它加上@LoadBalanced 註解開啟負載均衡的能力：

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

RestTemplate 類是 Spring 用於構建 Restful 服務而提供的一種 Rest 服務可客戶端，RestTemplate 提供了多種便捷訪問遠程 Http 服務的方法。

在 apllication.properties 配置文件中配置 eureka 服務，並註冊到服務中心：

spring.application.name=integral-server  server.port=9600  eureka.client.serviceUrl.defaultZone=http://localhost:9100/eureka/  

• 在公司項目中正是通過 RestTemplate 來訪問各個微服務提供的接口，比如在項目中要訪問積分系統 integral-server，添加積分用戶：

JSONObject integralServerResult = restTemplate.postForObject("http://integral-server/shop/add", RequestHandler.getRestRawRequestEntity(integralShopJson), JSONObject.class);  

這樣就可以調用 integral-server 系統的添加用戶的接口實現在別的系統中添加用戶了。

• 我們也可以在 application.properties 配置文件中加入：

###### Ribbon  ribbon.ReadTimeout=60000  

這個是設置負載均衡的超時時間的。

斷路器

微服務架構中，各個系統被拆分成一個個服務單元，鏈路調用可能包括很多個服務單元，而每個單元又會個 N 個服務單元提供服務，因此如果有一個服務單元出現故障，就可能導致其它依賴此服務的服務單元出現延遲，導致整個微服務系統出現雪崩效應。

在 SpringCloud 模塊中有一個叫 Netflix Hystrix 的斷路器模塊，就是專門解決這個問題而生的，Hystrix 是 Netflix 開源的微服務框架套件之一，該框架目標在於通過控制那些訪問遠程系統、服務和第三方庫的節點，從而對延遲和故障提供更強大的容錯能力。

下面來說一下 Hystrix 在微服務系統中的具體用法：

• 首先還是在 pom.xml 中加入以下依賴：

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

• 在 spring boot 主程序中加入@EnableCircuitBreaker 註解開啟斷路器模式：

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

如果在調用過程中返回類似這樣的響應：

Whitelabel Error Page    This application has no explicit mapping for /error, so you are seeing this as a fallback.    Sat May 13 00:10:22 CST 2017  There was an unexpected error (type=Internal Server Error, status=500).  400 null  

斷路器也就開啟了。

• 我們也可以在 application.properties 配置文件中加入：

## hystrix  hystrix.commond.default.execution.isolation.thread.timeoutInMilliseconds=60000  

這個設置可以更改返回錯誤響應的超時時間。

• 如果不想返回默認的錯誤響應信息，我們還可以通過自定義來更改錯誤響應信息，我們需要一個類中注入一個 RestTemplate 類：

 @Autowired   RestTemplate restTemplate;  

這個類在上面已經通過 Spring 創建好了，這裡直接注入在類中即可，接下來我們在類中寫一個方法：

@HystrixCommand(fallbackMethod = "addServiceFallback")      public String addService() {          return restTemplate.postForObject("http://integral-server/shop/add", RequestHandler.getRestRawRequestEntity(integralShopJson), JSONObject.class);      }      public String addServiceFallback() {          return "error";      }  

當調用 integral-server 系統的添加接口超出延時的時間時，就會返回「error」。

服務網關

前面我們通過 Ribbon 實現服務的消費和負載均衡，但還有些不足的地方，舉個例子，服務 A 和服務 B，他們都註冊到服務註冊中心，這裡還有個對外提供的一個服務，這個服務通過負載均衡提供調用服務 A 和服務 B 的方法，那麼問題來了，每個服務都變得有狀態了，即每個服務都需要維護一套校驗邏輯，這樣會帶來對外接口有污染。而且權限等不好集中管理，整個集群處於混亂之中。

最好的方法就是把所有請求都集中在最前端的地方，這地方就是 zuul 服務網關。

服務網關是微服務架構組件中處於最外一層，通過服務網關統一，可以將鏈路前端集中管理起來，除了具備服務路由、均衡負載功能之外，它還需要具備權限控制等功能。Spring Cloud Netflix 中的 Zuul 就擔任了這樣的一個角色，為微服務披上了一層保護層，也方便了權限校驗集中管理，增加了接口的通用性。

1. 配置服務路由

• 要使用 zuul，就要引入它的依賴：

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

• 在 spring boot 主程序中加入@EnableZuulProxy 註解開啟 zuul：

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

• 在 application.properties 配置文件中配置 zuul 路由 url：

spring.application.name=web-gateway  server.port=9010  

到這裡，一個微服務 zuul 服務網關係統已經可以運行了，接下來就是如何配置訪問其它微服務系統的 url，zuul 提供了兩種配置方式，一種是通過 url 直接映射，另一種是利用註冊到 eureka server 中的服務 id 作映射：

• url 直接映射：

zuul.routes.api-integral.path=/api-integral-url/**  zuul.routes.api-integral.url=http://localhost:8080/  

以上規則意思是 /api-integral-url/** 的訪問都會被路由到 http://localhost:8080/上。

• 但是這麼做必須得知道所有的微服務的地址，才能完成配置，這時我們可以利用註冊到 eureka server 中的服務 id 作映射：

###### Zuul配置  zuul.routes.api-integral.path=/integral/**  zuul.routes.api-integral.serviceId=integral-server    zuul.routes.api-member.path=/member/**  zuul.routes.api-member.serviceId=member-server  

integral-server 和 member-server 是這倆微服務系統註冊到微服務中心的一個 serverId，我們通過配置，訪問http://localhost:9010/integual/add?a=1&b=2，該請求就會訪問 integral-server 系統中的 add 服務。

2. 服務過濾

在定義 zuul 網關服務過濾只需要創建一個繼承 ZuulFilter 抽象類並重寫四個方法即可，下面是 ZuulFilter 的一些解釋：

• filterType：過濾類型，具體如下： pre：請求路由之前執行； routing：請求路由時執行； post：在 routing 和 error 過濾器之後執行； error：在請求發生錯誤的時候執行；
• filterOrder：定義過濾器的執行順序
• shouldFilter：判斷該過濾器是否要執行，
• run：過濾器的具體邏輯。

標準實例程序：

public class ErrFilter extends ZuulFilter {      @Override      public String filterType() {          return "pre";      }        @Override      public int filterOrder() {          return 0;      }        @Override      public boolean shouldFilter() {          return true;      }        @Override      public Object run() {          RequestContext ctx = RequestContext.getCurrentContext();          HttpServletRequest request = ctx.getRequest();            Object accessToken = request.getParameter("accessToken");          if(accessToken == null) {              log.warn("access token is empty");              ctx.setSendZuulResponse(false);              ctx.setResponseStatusCode(401);              return null;          }          return null;      }  }  

在自定過濾器之後，我們還需要在 SpringBoot 主程序中加入@EnableZuulProxy 註解來開啟 zuul 路由的服務過濾：

@EnableZuulProxy  @EnableEurekaClient  @RibbonClients  @SpringCloudApplication  public class ApiGatewayApplication {    	public static void main(String[] args) {  		SpringApplication.run(ApiGatewayApplication.class, args);  	}    	@Bean  	PosPreFilter posPreFilter(){  		return new PosPreFilter();  	}  

到這裡，微服務系統的 zuul 路由功能基本搭建完成。

Feign

之前說過了微服務間，我是通過 Spring 的 RestTemplate 類來相互調用的，它可通過整合 Ribbon 實現負載均衡，但發現了這樣寫不夠優雅，且不夠模板化，因此本篇介紹一下 Feign。

Feign 是一種聲明式、模板化的 HTTP 客戶端，在 Spring Cloud 中使用 Feign 其實就是創建一個接口類，它跟普通接口沒啥兩樣，因此通過 Feign 調用 HTTP 請求，開發者完全感知不到這是遠程方法。

2. 整合 Feign

• 添加 Feign 依賴：

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

• 創建 一個 Feign 接口：

@FeignClient(value = FeignConst.COUPON_PROVIDER, url = "${feign.coupon.url:}")  public interface CouponClient {      @GetMapping(value = "/coupon/list/page", headers = LocalsEncoder.CONTENT_TYPE_LOCALS_GET)    RestResponse couponList(@ModelAttribute CouponCriteria criteria);    }  

• 啟動 Feign 類

@EnableFeignClients(basePackages = {"com.objcoding"})  @SpringCloudApplication  public class ProviderApplication {    }  

2. 服務降級

當網絡不穩定時，一個接口響應非常慢，就會一直佔用這個連接資源，如果長時間不做處理，會導致系統雪崩，幸好，Feign 已經繼承了熔斷器 Hystrix

@FeignClient(value = FeignConst.COUPON_PROVIDER, url = "${feign.coupon.url:}", fallback = CouponClient.CouponClientFallBack.class)  public interface CouponClient {      @GetMapping(value = "/coupon/list/page", headers = LocalsEncoder.CONTENT_TYPE_LOCALS_GET)    RestResponse couponList(@ModelAttribute CouponCriteria criteria);      @Component    class CouponClientFallBack implements CouponClient {      @Override      public RestResponse couponList(CouponCriteria criteria) {        return RestResponse.failed("網絡超時");      }    }    }  

3. 攔截器

有時候微服務間的調用，需要傳遞權限信息，這些信息都包含在請求頭了，這時我們可以通過 Feign 攔截器實現權限穿透：

@Configuration  public class WebRequestInterceptor {      @Bean    public RequestInterceptor headerInterceptor() {      return template -> {        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();        if (attributes == null) {          return;        }        HttpServletRequest request = attributes.getRequest();        Enumeration<String> headerNames = request.getHeaderNames();        if (headerNames != null) {          while (headerNames.hasMoreElements()) {            String name = headerNames.nextElement();            String values = request.getHeader(name);            template.header(name, values);          }        }      };    }  }