前言
上兩章節,介紹了下關於注冊中心-Eureka的使用及高可用的配置示例,本章節開始,來介紹下服務和服務之間如何進行服務調用的,同時會講解下幾種不同方式的服務調用。
一點知識
在SpringCloud
體系中,我們知道服務之間的調用是通過http
協議進行調用的。而注冊中心的主要目的就是維護這些服務的服務列表。我們知道,在Spring
中,提供了RestTemplate
。RestTemplate
是Spring
提供的用於訪問Rest服務的客戶端。而在SpringCloud
中也是使用此服務進行服務調用的。
同時在微服務中,一般上服務都不會進行單點部署的,都會至少部署2台及以上的。現在我們有了注冊中心進行服務列表的維護,就需要一個客戶端負載均衡來進行動態服務的調用。
所以開始示例前,我們先來大致了解下關於負載均衡
和RestTemplate
的相關知識點。其實后面實例的Ribbon
和Feign
最后的調用都是基於RestTemplate
的。使用比較簡單~
何為負載均衡
負載均衡(Load Balance)是分布式系統架構設計中必須考慮的因素之一,它通常是指,將請求/數據【均勻】分攤到多個操作單元上執行,負載均衡的關鍵在於【均勻】。
實現的方式
實現負載均衡的方式有很多種,這里簡單介紹下幾種方式,並未過多深入。
注意:以下部分內容轉至幾種負載均衡技術的實現。
1.HTTP重定向負載均衡
根據用戶的http請求計算出一個真實的web服務器地址,並將該web服務器地址寫入http重定向響應中返回給瀏覽器,由瀏覽器重新進行訪問
優缺點:實現起來很簡單,而缺點也顯而易見了:請求兩次才能完成一次訪問;性能差;重定向服務器會成為瓶頸
2.DNS域名解析負載均衡
在DNS服務器上配置多個域名對應IP的記錄。例如一個域名
www.baidu.com
對應一組web服務器IP地址,域名解析時經過DNS服務器的算法將一個域名請求分配到合適的真實服務器上。
優缺點:加快訪問速度,改善性能。同時由於DNS解析是多級解析,每一級DNS都可能化緩存記錄A,當某一服務器下線后,該服務器對應的DNS記錄A可能仍然存在,導致分配到該服務器的用戶訪問失敗,而且DNS負載均衡采用的是簡單的輪詢算法,不能區分服務器之間的差異,不能反映服務器當前運行狀態。
3.反向代理負載均衡
反向代理處於web服務器這邊,反向代理服務器提供負載均衡的功能,同時管理一組web服務器,它根據負載均衡算法將請求的瀏覽器訪問轉發到不同的web服務器處理,處理結果經過反向服務器返回給瀏覽器。
優缺點:實現簡單,可利用反向代理緩存資源(這是最常用的了)及改善網站性能。同時因為是所有請求和響應的中轉站,所以反向代理服務器可能成為瓶頸。
以上僅僅是部分實現方式,還有比如IP負載均衡
、數據鏈路層負載均衡
等等,這些可能涉及到相關網絡方面的知識點了,不是很了解,大家有興趣可以自行搜索下吧。
客戶端和服務端的負載均衡
實現負載均衡也又區分客戶端和服務端之分,Ribbon
就是基於客戶端的負載均衡。
客戶端負載均衡:
服務端負載均衡:
服務端實現負載均衡方式有很多,比如:硬件F5
、Nginx
、HA Proxy
等等,這些應該實施相關人員應該比較熟悉了,本人可能也就對Nginx
了解下,⊙﹏⊙‖∣
RestTemplate簡單介紹
RestTemplate
是Spring
提供的用於訪問Rest服務
的客戶端,RestTemplate
提供了多種便捷訪問遠程Http服務的方法,能夠大大提高客戶端的編寫效率。
簡單來說,RestTemplate
采用了模版設計
的設計模式,將過程中與特定實現相關的部分委托給接口,而這個接口的不同實現定義了接口的不同行為,所以可以很容易的使用不同的第三方http服務,如okHttp
、httpclient
等。
RestTemplate
定義了很多的與REST資源交互,這里簡單介紹下一些常用的請求方式的使用。
exchange
在URL上執行特定的HTTP方法,返回包含對象的ResponseEntity
。其他的如GET
、POST
等方法底層都是基於此方法的。
如:
- get請求
RequestEntity requestEntity = RequestEntity.get(new URI(uri)).build();
ResponseEntity<User> responseEntity2 = this.restTemplate.exchange(requestEntity, User.class);
- post請求
RequestEntity<User> requestEntity = RequestEntity.post(new URI(uri)).body(user);
ResponseEntity<User> responseEntity2 = this.restTemplate.exchange(requestEntity, User.class);
GET請求
get請求可以分為兩類:
getForEntity()
和getForObject()
.
// 1-getForObject()
User user1 = this.restTemplate.getForObject(uri, User.class);
// 2-getForEntity()
ResponseEntity<User> responseEntity1 = this.restTemplate.getForEntity(uri, User.class);
HttpStatus statusCode = responseEntity1.getStatusCode();
HttpHeaders header = responseEntity1.getHeaders();
User user2 = responseEntity1.getBody();
其他的方法都大同小異了,可以根據實際的業務需求進行調用。
POST請求
簡單示例:
// 1-postForObject()
User user1 = this.restTemplate.postForObject(uri, user, User.class);
// 2-postForEntity()
ResponseEntity<User> responseEntity1 = this.restTemplate.postForEntity(uri, user, User.class);
關於postForLocation()
,用的比較少,作用是返回新創建資源的URI,前面介紹的兩者是返回資源本身,也就是結果集了。
關於其他的請求類型相關用法,這里就不詳細闡述了,都是類似的。可以查看下此文章:詳解 RestTemplate 操作,講的蠻詳細了。
特別說明:系列教程為了方便,github上分別創建了一個單體的Eureka
注冊中心和高可用的Eureka
注冊中心,無特殊說明,都是使用單體的Eureka
注冊中心進行服務注冊與發現的,工程名為:spring-cloud-eureka-server
,端口號為:1000。服務提供方工程名為:spring-cloud-eureka-client
,應用名稱為:eureka-client
,端口號為:2000,提供了一個接口:http://127.0.0.1:2000/hello
spring-cloud-eureka-server示例:spring-cloud-eureka-server
spring-cloud-eureka-client示例:spring-cloud-eureka-client
LoadBalancerClient實例
此類是實現客戶端負載均衡的關鍵。本身它是個接口類,位於spring-cloud-commons
包下,此包包含了大量的服務治理相關的抽象接口,比如已經介紹過的DiscoveryClient
、ServiceRegistry
以及LoadBalancerClient實例
等等。
首先,我們使用最原生的方式去獲取調用服務接口。
創建個工程:spring-cloud-eureka-consumer
0.引入pom文件依賴。
<!-- 客戶端依賴 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
1.配置文件添加相關注冊中心等信息。
## 服務名稱
spring.application.name=eureka-consumer
## 端口號
server.port=8008
#指定注冊中心地址
eureka.client.service-url.defaultZone=http://127.0.0.1:1000/eureka
# 啟用ip配置 這樣在注冊中心列表中看見的是以ip+端口呈現的
eureka.instance.prefer-ip-address=true
# 實例名稱 最后呈現地址:ip:2000
eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}
2.編寫啟動類,加入@EnableDiscoveryClient
,申明為一個客戶端應用,同時申明一個RestTemplate
,最后是使用RestTemplate
來完成rest服務調用的。
@SpringBootApplication
@EnableDiscoveryClient
@Slf4j
public class EurekaConsumerApplication {
public static void main(String[] args) throws Exception {
SpringApplication.run(EurekaConsumerApplication.class, args);
log.info("spring-cloud-eureka-consumer啟動!");
}
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
}
3.編寫一個調用類,調用spring-cloud-eureka-client
服務提供者提供的服務。
/**
* 訪問客戶端示例
* @author oKong
*
*/
@RestController
@Slf4j
public class DemoController {
@Autowired
LoadBalancerClient loadBalancerClient;
@Autowired
RestTemplate restTemplate;
@GetMapping("/hello")
public String hello(String name) {
ServiceInstance serviceInstance = loadBalancerClient.choose("eureka-client");
String url = "http://" + serviceInstance.getHost() + ":" + serviceInstance.getPort() + "/hello?name=" + name;
log.info("url地址為:{}", url);
return restTemplate.getForObject(url, String.class);
}
}
4.啟動應用,訪問:http://127.0.0.1:8008/hell0?name=oKong ,可以看見控制台輸出了利用LoadBalancerClient
的choose
方法,獲取到了對應eureka-client
服務ID的服務地址。
最后通過范圍對應的http地址進行服務請求:
最后瀏覽器上可以看見,進行了正確的訪問了:
此時,切換到服務提供者spring-cloud-eureka-client
控制台,可以看見日志輸出:
此時我們已經調用成功了,通過LoadBalancerClient
獲取到了服務提供者實際服務地址,最后進行調用。
大家可以創建多個的spring-cloud-eureka-client
服務提供者,再去調用下,可以看見會調用不同的服務地址的。
客戶端負載均衡Ribbon實例
Spring Cloud Ribbon
是一個基於Http和TCP的客服端負載均衡工具,它是基於Netflix Ribbon
實現的。與Eureka
配合使用時,Ribbon
可自動從Eureka Server (注冊中心)
獲取服務提供者地址列表,並基於負載均衡
算法,通過在客戶端中配置ribbonServerList
來設置服務端列表去輪詢訪問以達到均衡負載的作用。
上小節,簡單的使用LoadBalancerClient
進行了服務實例獲取最后調用,也說了其實LoadBalancerClient
是個接口類。而Ribbon
實現了此接口,對應實現類為:RibbonLoadBalancerClient
.
Ribbon實例
現在我們來看下,使用Ribbon
的方式如何進行更加優雅的方式進行服務調用。
創建一個工程:spring-cloud-eureka-consumer-ribbon
(其實這個工程和spring-cloud-eureka-consumer
是差不多的,只是有些許不同。)
0.加入pom依賴
<!-- 客戶端依賴 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
1.配置文件修改,添加注冊中心等相關信息。
spring.application.name=eureka-consumer-ribbon
server.port=8018
#指定注冊中心地址
eureka.client.service-url.defaultZone=http://127.0.0.1:1000/eureka
# 啟用ip配置 這樣在注冊中心列表中看見的是以ip+端口呈現的
eureka.instance.prefer-ip-address=true
# 實例名稱 最后呈現地址:ip:2000
eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}
2.編寫啟動類,加入@EnableDiscoveryClient
,同時申明一個RestTemplate
,這里和原先不同,就在於加入了@LoadBalanced
注解進行修飾RestTemplate
類,稍后會大致講解下是如何進行實現的。
@SpringBootApplication
@EnableDiscoveryClient
@Slf4j
public class EurekaConsumerRibbonApplication {
public static void main(String[] args) throws Exception {
SpringApplication.run(EurekaConsumerRibbonApplication.class, args);
log.info("spring-cloud-eureka-consumer-ribbon啟動!");
}
//添加 @LoadBalanced 使其具備了使用LoadBalancerClient 進行負載均衡的能力
@Bean
@LoadBalanced
public RestTemplate restTemplage() {
return new RestTemplate();
}
}
3.編寫測試類,進行服務調用。
/**
* ribbon訪問客戶端示例
* @author oKong
*
*/
@RestController
@Slf4j
public class DemoController {
@Autowired
RestTemplate restTemplate;
@GetMapping("/hello")
public String hello(String name) {
//直接使用服務名進行訪問
log.info("請求參數name:{}", name);
return restTemplate.getForObject("http://eureka-client/hello?name=" + name, String.class);
}
}
可以看見,可以直接注入RestTemplate
,通過服務名直接調用.
4.啟動應用,訪問:http://127.0.0.1:8018/hello?name=oKong ,可以看見調用成功:
控制台輸出:
簡單聊聊LoadBalanced注解
可以從以上示例中,可以看出,我們就加了一個
@LoadBalanced
注解修飾RestTemplate
bean類,就實現了服務的調用。現在來簡單看看具體是如何實現的。
首先,我們看看此注解的代碼說明:
從注釋可以看出,該注解用來給RestTemplate做標記,以使用負載均衡的客戶端LoadBalancerClient
。
現在來看一眼相同包下的類的情況,可以看到有個LoadBalancerAutoConfiguration
,字面意思可以知道這是一個自動配置類,此類就是我們要找的關鍵類了。
LoadBalancerAutoConfiguration
,此類不長,一百來行,這里就不貼了。
簡單說明下:
首先,此類生效的條件是
@ConditionalOnClass(RestTemplate.class)
@ConditionalOnBean(LoadBalancerClient.class)
RestTemplate
類必須存在於當前工程的環境中。- 在Spring的Bean工程中有必須有
LoadBalancerClient
的實現Bean。
該自動化配置類中,主要做了幾件事情:
- 維護了一個被@LoadBalanced注解修飾的RestTemplate對象列表
@LoadBalanced
@Autowired(required = false)
private List<RestTemplate> restTemplates = Collections.emptyList();
同時為其每個對象通過調用RestTemplateCustomizer
添加了一個LoadBalancerInterceptor
和RetryLoadBalancerInterceptor
攔截器(有生效條件),其為ClientHttpRequestInterceptor
接口的實現類,ClientHttpRequestInterceptor
是RestTemplate
的請求攔截器
RetryLoadBalancerInterceptor攔截器
LoadBalancerInterceptor攔截器
我們主要看下LoadBalancerInterceptor
:
可以看見,最后是實現了ClientHttpRequestInterceptor
接口的實現類執行execute
方法進行.
從繼承關系里,此實現類就是RibbonLoadBalancerClient
類了。
RibbonLoadBalancerClient
類:
簡單來說:最后還是通過loadBalancerClient.choose()
獲取到服務實例,最通過拼湊http地址來進行最后的服務調用。
總體來說,就是通過為加入@LoadBalanced
注解的RestTemplate
添加一個請求攔截器,在請求前通過攔截器獲取真正的請求地址,最后進行服務調用。
里面的細節就不闡述了,畢竟源碼分析不是很在行呀,大家可以跟蹤進去一探究竟吧。
友情提醒:若被@LoadBalanced
注解的RestTemplate
訪問正常的服務地址,如http://127.0.0.1:8080/hello
時,是會提示無法找到此服務的。
具體原因:serverid
必須是我們訪問的服務名稱
,當我們直接輸入ip
的時候獲取的server
是null
,就會拋出異常。
此時,若是需要調用非注冊中心的服務,可以創建一個不被@LoadBalanced
注解的RestTemplate
,同時指定bean的名稱,使用時,使用@Qualifier
指定name注入此RestTemplate
。
@Bean("normalRestTemplage")
public RestTemplate normalRestTemplage() {
return new RestTemplate();
}
//使用
@Autowired
@Qualifier("normalRestTemplage")
RestTemplate normalRestTemplate;
@GetMapping("/ip")
public String ip(String name) {
//直接使用服務名進行訪問
log.info("使用ip請求,請求參數name:{}", name);
return normalRestTemplate.getForObject("http://127.0.0.1:2000/hello?name=" + name, String.class);
}
負載均衡器
目前還未進行過自定義負載均衡,這里就簡單的舉例下,上次整理ppt時有講過一些,但未深入了解過⊙﹏⊙‖∣,
可以從繼承關系看出,是通過繼承IRule
來實現的。
可繼承ClientConfigEnabledRoundRobinRule,來實現自己負載均衡策略。
聲明式服務Feign實例
從上一章節,我們知道,當我們要調用一個服務時,需要知道服務名和api地址,這樣才能進行服務調用,服務少時,這樣寫覺得沒有什么問題,但當服務一多,接口參數很多時,上面的寫法就顯得不夠優雅了。所以,接下來,來說說一種更好更優雅的調用服務的方式:Feign。
Feign
是Netflix
開發的聲明式、模塊化的HTTP客戶端。Feign
可幫助我們更好更快的便捷、優雅地調用HTTP API
。
在Spring Cloud
中,使用Feign
非常簡單——創建一個接口,並在接口上添加一些注解。Feign
支持多種注釋,例如Feign自帶的注解或者JAX-RS注解等
Spring Cloud對Feign進行了增強,使Feign支持了Spring MVC注解,並整合了Ribbon和 Eureka,從而讓Feign 的使用更加方便。只需要通過創建接口並用注解來配置它既可完成對Web服務接口的綁定。
Feign實例
創建個spring-cloud-eureka-consumer-ribbon
工程項目。
0.加入feigin
依賴
<!-- feign -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!-- eureka客戶端依賴 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!-- rest api -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
1.配置文件
spring.application.name=eureka-consumer-feign
server.port=8028
#指定注冊中心地址
eureka.client.service-url.defaultZone=http://127.0.0.1:1000/eureka
# 啟用ip配置 這樣在注冊中心列表中看見的是以ip+端口呈現的
eureka.instance.prefer-ip-address=true
# 實例名稱 最后呈現地址:ip:2000
eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}
2.創建啟動類,加入注解@EnableFeignClients
,開啟feign
支持。
@SpringBootApplication
@EnableFeignClients
@Slf4j
public class EurekaConsumerFeignApplication {
public static void main(String[] args) throws Exception {
SpringApplication.run(EurekaConsumerFeignApplication.class, args);
log.info("spring-cloud-eureka-consumer-feign啟動");
}
}
3.創建一個接口類IHelloClient
,加入注解@FeignClient
來指定這個接口所要調用的服務名稱。
@FeignClient(name="eureka-client")
public interface IHelloClient {
/**
* 定義接口
* @param name
* @return
*/
@RequestMapping(value="/hello", method=RequestMethod.GET)
public String hello(@RequestParam("name") String name);
}
4.創建一個demo控制層,引入此接口類。
/**
* feign 示例
* @author OKong
*
*/
@RestController
@Slf4j
public class DemoController {
@Autowired
IHelloClient helloClient;
@GetMapping("/hello")
public String hello(String name) {
log.info("使用feign調用服務,參數name:{}", name);
return helloClient.hello(name);
}
}
5.啟動應用,訪問:http://127.0.0.1:8028/hello?name=oKong-feign
是不是很簡單,和調用本地服務是一樣的了!
Feign繼承特性
Feign
支持繼承,但不支持多繼承。使用繼承,可將一些公共操作分組到一些父類接口中,從而簡化Feign的開發。
所以在實際開發中,調用服務接口時,可直接按接口類和實現類進行編寫,調用方引入接口依賴,繼承一個本地接口,這樣接口方法默認都是定義好的,也少了很多編碼量。用起來就更爽了,就是有點依賴性,對方服務修改后需要同步更新下,但這個團隊內部約定下問題不大的
這里簡單實例下,創建一個spring-cloud-eureka-client-api
工程。
0.加入依賴,注意此依賴的作用范圍:
<!--api接口依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<scope>provided</scope>
</dependency>
1.編寫一個接口類IHellpApi
:
public interface IHelloApi {
//定義提供者服務名
public static final String SERVICE_NAME = "eureka-client";
/**
* 定義接口
* @param name
* @return
*/
@RequestMapping(value="/hello", method=RequestMethod.GET)
public String hello(@RequestParam("name") String name);
}
修改spring-cloud-eureka-client
工程
0.引入api依賴
<!-- 導入接口依賴 -->
<dependency>
<groupId>cn.lqdev.learning</groupId>
<artifactId>spring-cloud-eureka-client-api</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
1.創建一個HelloApiImpl
類,實現IHelloApi
:
/**
* 使用接口方式進行接口編寫
* @author oKong
*
*/
@RestController
@Slf4j
public class HelloApiImpl implements IHelloApi {
@Override
public String helloApi(@RequestParam("name") String name) {
log.info("[spring-cloud-eureka-client]服務[helloApi]被調用,參數name值為:{}", name);
return name + ",helloApi調用!";
}
}
此時,HelloApiImpl
是個控制層也是個接口實現類了。
修改spring-cloud-eureka-consumer-feign
工程。
0.引入api依賴
<!-- 導入接口依賴 -->
<dependency>
<groupId>cn.lqdev.learning</groupId>
<artifactId>spring-cloud-eureka-client-api</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
1.同樣創建一個接口,使其繼承IHelloApi
:
/**
* 直接繼承接口
* @author Okong
*
*/
@FeignClient(name = IHelloApi.SERVICE_NAME)
public interface HelloApi extends IHelloApi{
}
小技巧:可以在IHelloApi
定義一個服務名變量,如:SERVICE_NAME,這樣讓提供者進行變量的賦值,可以避免一些不必要的交流成本的,若有變化,服務調用方也無需關心的。一切都是約定編程!
2.修改下DemoController
類,注入HelloApi
:
@Autowired
HelloApi helloApi;
@GetMapping("hello2")
public String hello2(String name) {
log.info("使用feign繼承方式調用服務,參數name:{}", name);
return helloApi.helloApi(name);
}
3.分別啟動各服務,訪問:http://127.0.0.1:8028/hello2?name=oKong-api
使用起來沒啥差別的,一樣的調用,但對於調用方而言,可以無需去理會具體細節了,照着接口方法去傳參就好了。
這種方式,和原來的dubbo
調用的方式是類似的,簡單方便。大家可以把接口和實體放入一個包中,調用者和提供者都進行依賴即可。
注意事項
在使用Feign
時,會碰見一些問題,為了避免不必要的錯誤,以下這些需要額外注意下。
- GET請求多個參數時,需要使用@RequestParam
- GET請求參數為實體時,會自動轉換成POST請求
- POST請求使用@RequestBody注解參數
- 不建議直接將@RequestMapping注解在類上,直接寫在方法上
參考資料
總結
本章節主要講解了下服務消費者如何利用原生、ribbon、fegin三種方式進行服務調用的,其實每種調用方式都是使用
ribbon
來進行調用的,只是有些進行了增強,是的使用起來更簡單高效而已。對於其原理的實現,本文未進行詳細闡述,大家可以谷歌想相關知識,跟蹤下源碼了解下,本人也尚未深入研究過,還是停留在使用階段,之后有時間了看一看,有啥心得再來分享吧。此時若服務上線下線,調用者調用可能會出現短暫的調用異常,最常見的就是找不到服務,此時服務容錯保護就排上用場了,所以下一章節,就來說說關於服務容錯保護
相關知識點~
最后
目前互聯網上大佬都有分享
SpringCloud
系列教程,內容可能會類似,望多多包涵了。原創不易,碼字不易,還希望大家多多支持。若文中有錯誤之處,還望提出,謝謝。
老生常談
- 個人QQ:
499452441
- 微信公眾號:
lqdevOps
個人博客:http://blog.lqdev.cn
源碼示例:https://github.com/xie19900123/spring-cloud-learning
原文地址:http://blog.lqdev.cn/2018/09/21/SpringCloud/chapter-four/