在本博客之前的Spring Cloud系列里,我們講述了Feign的基本用法,這里我們將講述下Feign整合Ribbon實現負載均衡以及整合Hystrix實現斷路保護效果的方式。
1 准備Eureka服務器以及多個服務提供者
這里,我們將重用之前博文里講過的案例,提供的兩個(即主從)Eureka服務項目以及三個服務提供者的項目。隨后在此基礎上,在服務調用者的項目中,通過Feign以負載均衡的方式調用三個服務提供者所提供的sayHello方法。
2 在客戶端引入Ribbon
在FeignDemo-ServiceCaller項目里開發Fegin整合Ribbon,具體的步驟如下。
在pom.xml中,引入Ribbon依賴包,關鍵代碼如下。
1 <dependency> 2 <groupId>org.springframework.cloud</groupId> 3 <artifactId>spring-cloud-ribbon</artifactId> 4 </dependency>
在ControllerForFeignRibbon.java中,編寫Feign以Ribbon負載均衡的方式調用服務的代碼。
//省略必要的package和import的代碼 //這和Ribbon Provider中的applicationname一致 @FeignClient(value = "sayHelloAvoidCopy") interface FeignClientRibbonTool{ @RequestMapping(method = RequestMethod.GET, value = "/sayHello/{username}/avoidCopy") String sayHelloAsRibbon(@PathVariable("username") String username); } @RestController public class ControllerForFeignRibbon { private FeignClientRibbonTool tool; @RequestMapping(value = "/callHelloAsRibbon/{username}", method = RequestMethod.GET) public String callHelloAsRibbon(@PathVariable("username") String username) { return tool.sayHelloAsRibbon(username); } }
在上述代碼里,,我們定義了一個名為FeignClientRibbonTool的接口;在第3行中,我們通過@FeignClient注解指定了該Feign接口將會調用名為sayHello的服務。請注意,這里的sayHello命名需要和EurekaRibbonDemo-ServiceProviderOne等項目中application.yml中的相應配置一致。
在第10行中,我們通過@RestController注解定義了一個名為ControllerForFeignRibbon的控制器類,在其中的第14行的callHelloAsRibbon中,我們是通過Feign接口中的sayHelloAsRibbon方法調用服務的。
在application.yml中,編寫Ribbon的相關配置信息,關鍵代碼如下。
1 sayHello: 2 ribbon: 3 listOfServer: http://localhost:1111/,http://localhost:2222/,http://localhost:3333 4 ConnectionsTimeout: 1000 5 ribbon: 6 ConnectionsTimeout: 2000
在第1~4行,我們通過配置指定了基於ribbon的多台服務器,它們將以負載均衡的方式承擔請求url,而且還指定了連接超時的時間。從第1行我們能看到,這個配置是針對sayHello這個服務實例的。而在第5行和第6行,我們配置了全局性的ribbon屬性,這里也配置了連接超時時間。
完成開發后,啟動定義在表6.2中的兩台Eureka服務器、三台服務提供者和一台服務調用者程序后,在瀏覽器中多次輸入http://localhost:8080/callHelloAsRibbon/Peter以調用服務,這時我們能看到有如下輸出。從輸出結果來看,我們以Feign的形式調用的請求確實被均衡地轉發到3台服務提供者的機器上。
1 Hello Ribbon, there are Server1, my name is:Peter
2 Hello Ribbon, there are Server2, my name is:Peter
3 Hello Ribbon, there are Server3, my name is:Peter
這里我們來總結一下Feign整合Ribbon的要點。
第一,多個服務器提供者的實例名應當一致,比如這里都是sayHello。
第二,在Feign的接口中,是通過@FeignClient的注解調用服務提供者的方法的。
第三,這里我們是在application.yml配置文件中指定Ribbon的各種參數,也可以通過@Configuration注解在Java文件中配置Ribbon的參數。
3 在客戶端引入Hystrix(Feigh整合Hystrix)
在通過Feign調用服務時,同樣不能保證服務一定可用,為了提升客戶體驗,這里可以通過引入Hystrix對訪問請求進行“容錯保護”。
在FeignDemo-ServiceCaller的pom.xml中,增加Hystrix的依賴包,關鍵代碼如下。
1 <dependency> 2 <groupId>org.springframework.cloud</groupId> 3 <artifactId>spring-cloud-hystrix</artifactId> 4 </dependency>
還是在FeignDemo-ServiceCaller項目的application.yml配置文件中,通過如下配置項啟動Hystrix模式,關鍵代碼如下。
1 feign: 2 hystrix: 3 enabled: true
此外,還可以通過如下代碼配置針對sayHelloServiceProvider服務的hystrix參數。其中,第3行指定了hystrix所作用的服務名,第7行指定了請求時間一旦超過1000毫秒(也就是1秒),就會啟動熔斷模式,調用定義在回退方法中的業務動作。
1 hystrix: 2 command: 3 sayHelloServiceProvider: 4 execution: 5 isolations: 6 threads: 7 timeoutInMilliseconds: 1000
在啟動類ServiceCallerApp.java中,增加啟動hystrix斷路器的注解,如第5行所示,這個類的關鍵代碼如下。
1 //省略必要的package和import方法 2 EnableFeignClients 3 @EnableDiscoveryClient 4 @SpringBootApplication 5 @EnableCircuitBreakers 6 public class ServiceCallerApp 7 { 8 //省略其他代碼 9 }
新建一個名為ControllerForFeignHystrix.java的控制器類,代碼如下。
1 //省略必要的package和import代碼 2 @FeignClient(value = "sayHelloServiceProvider",fallback=FeignClientHystrixToolFallback.class) 3 interface FeignClientHystrixTool{ 4 @RequestMapping(method = RequestMethod.GET, value = "/hello/{name}") 5 String sayHelloInClient(@RequestParam("name") String name); 6 }
在第3行中,我們定義了一個名為FeignClientHystrixTool的接口;在第2行的注解中,我們定義了它將以Feign的形式調用sayHelloServiceProvider中的服務,並且通過fallback配置指定一旦出現調用異常,將調用FeignClientHystrixToolFallback類中的回退方法。
7 @Component 8 class FeignClientHystrixToolFallback implements FeignClientHystrixTool{ 9 public String sayHelloInClient(String name) 10 { return "In Fallback Function."; } 11 }
在第8行的FeignClientHystrixToolFallback類中,我們將定義針對FeignClientHystrixTool接口的回退方法。
注意該類必須和第2行中fallback指定的類同名,而且,該類需要實現(implements)FeignClientHystrixTool接口,在其中的sayHelloInClient方法中定義了回退動作,這里的動作是打印一段話。
12 @RestController 13 public class ControllerForFeignHystrix { 14 @Autowired 15 private FeignClientHystrixTool tool; 16 @RequestMapping(value = "/callHelloAsHystrix/{username}", method = RequestMethod.GET) 17 public String callHelloAsHystrix(@PathVariable("username") String username) 18 { return tool.sayHelloInClient(username);} 19 }
在第13行中,我們定義了一個包含@RestController注解的控制器類ControllerForFeignHystrix,在其中第17行的callHelloAsHystrix方法中,我們是以Feign的形式調用sayHelloInClient方法的。
至此,完成代碼的編寫工作。我們依次啟動FeignDemo-Server、FeignDemo-ServiceProvider和FeignDemo-ServiceCaller項目,隨后在瀏覽器中輸入http://localhost:8080/callHelloAsHystrix/Peter,此時能看到“hello Peter”的輸出,這個是正常的調用流程。
如果我們關閉FeignDemo-ServiceProvider項目,也就是說sayHelloServiceProvider服務不可用了,如果再次在瀏覽器中輸入http://localhost:8080/callHelloAsHystrix/Peter,此時就會走熔斷保護的流程,觸發FeignClientHystrixToolFallback 類中的sayHelloInClient方法,在瀏覽器中輸出“In Fallback Function“的字樣。
本文謝絕轉載,如果要代碼,請和作者聯系。Spring Cloud相關博文如下: