Spring Cloud微服務系列文，Hystrix與Eureka的整合

時間 2019-12-08

標籤 spring cloud 微服系列 hystrix eureka 整合欄目 Spring 简体版

原文原文鏈接

和Ribbon等組件同樣，在項目中，Hystrix通常不會單獨出現，而是會和Eureka等組件配套出現。在Hystrix和Eureka整合後的框架裏，通常會用到Hystrix的斷路器以及合併請求等特性，而在Web框架裏，大多會有專門的緩存組件，因此不怎麼會用到Hystrix的緩存特性。html

1 準備Eureka服務器項目

HystrixEurekaServer項目承擔着Eureka服務器的做用，這部分的代碼關鍵點以下。java

第一，在pom.xml裏，經過以下關鍵代碼引入Eureka服務器組件的依賴包。 spring

1    <dependency>
2        <groupId>org.springframework.cloud</groupId>
3        <artifactId>spring-cloud-starter-eureka-server</artifactId>
4    </dependency>

第二，在application.yml裏，指定了本項目的主機名和端口號，並指定了對外提供eureka服務的Url路徑，代碼以下。數據庫

1    server:
2      port: 8888
3    eureka:
4      instance:
5        hostname: localhost
6      client:
7        register-with-eureka: false
8        fetch-registry: false 
9        serviceUrl:
10          defaultZone: http://localhost:8888/eureka/

第三，在ServerStarter.java裏，編寫啓動Eureka服務的代碼，這裏請注意，在第2和第3行裏，經過註解聲明瞭本類是Eureka服務器的啓動類。瀏覽器

1    //省略必要的package和import的代碼
2    @EnableEurekaServer
3    @SpringBootApplication
4    public class ServerStarter 
5    {
6          public static void main( String[] args ){  
7              SpringApplication.run(ServerStarter.class, args);  
8        }
9    }

注：本部分給出的是Eureka服務器省略版的代碼，完整代碼你們能夠參見另一篇博文，架構師入門：搭建基本的Eureka架構（從項目裏抽取）。緩存

2 準備Eureka服務器項目

在pom.xml裏，咱們除了指定Eureka的依賴包之外，還了指定了Hystrix的依賴包，關鍵代碼以下。其中，前4行指定的是Eureka的依賴包，後4行指定的是Hystrix的依賴包。服務器

1    <dependency>
2            <groupId>org.springframework.cloud</groupId>
3            <artifactId>spring-cloud-starter-eureka</artifactId>
4        </dependency>
5    <dependency>
6            <groupId>org.springframework.cloud</groupId>
7            <artifactId>spring-cloud-starter-hystrix</artifactId>
8        </dependency>

而在application.yml裏，指定了本項目的服務端口是1111，對外提供的項目名是hystrixEureka，以及是向第一部分指定的Eureka服務器註冊，代碼以下。數據結構

1    server:
2      port: 1111
3    spring:
4      application:
5        name: hystrixEureka
6    eureka:  
7      client:
8        serviceUrl:
9          defaultZone: http://localhost:8888/eureka/

3 在服務提供者項目裏引入斷路器機制

在服務提供者的啓動類ServiceProviderApp.java裏，咱們是經過加入@EnableCircuitBreaker註解來啓動斷路器，代碼以下。架構

1    //省略必要的package和import代碼
2    @SpringBootApplication
3    @EnableEurekaClient
4    @EnableCircuitBreaker
5    @ServletComponentScan
6    public class ServiceProviderApp 
7    {
8        public static void main( String[] args ){ 
9             SpringApplication.run(ServiceProviderApp.class, args);  
10       }
11    }

在Controller.java這個控制器類裏，咱們是在第9行裏，經過調用service類提供的方法來返回具體的OrderDetail信息，代碼以下。 app

1    //省略必要的package和import代碼
2    @RestController
3    public class Controller {
4            @Autowired
5        private OrderDetailService service;   
6        //對外提供服務的getOrderDetailById方法 
7            @RequestMapping(value = "/getOrderDetailById/{orderId}", method = RequestMethod.GET)
8            public OrderDetail getOrderDetailById(@PathVariable("orderId")   String orderId) throws Exception {
9            return service.getOrderDetailByID(orderId);
10        }
11    }

在OrderDetailService.java裏，咱們用HashMap這個數據結構來模擬數據庫，以此來模擬從數據庫讀OrderDetail的方式，提供了「根據ID找相應對象的服務」，代碼以下。

1    //省略必要的package和import代碼
2    @Service
3    public class OrderDetailService {
4        static HashMap<String,String> orderDB = new HashMap<String,String> ();
5        static //經過static代碼，模擬數據庫中存儲的OrderDetail信息
6        {
7            orderDB.put("1","Peter");
8            orderDB.put("2","Tom");
9            orderDB.put("3","Mike");
10        }
11    //在方法以前，經過註解引入Hystrix，並指定回退方法
12        @HystrixCommand(fallbackMethod = "getFallback")
13        public OrderDetail getOrderDetailByID(String id) throws Exception
14        {
15            OrderDetail orderDetail = new OrderDetail();        
16            if("error".equals(id) ) //若是輸入是error，則故意拋出異常
17            {throw new Exception(); }
18            //模擬地從數據庫裏獲得信息並返回
19            orderDetail.setOrderId(id);
20            orderDetail.setOrderOwner(orderDB.get(id));
21            return orderDetail;
22        }
23        //定義Hystrix的回退方法
24        public OrderDetail getFallback(String orderId) {
25            OrderDetail orderDetail = new OrderDetail();
26            orderDetail.setOrderId("error");
27            orderDetail.setOrderOwner("error");        
28            System.out.println("In fallbackForOrderDetail function");    
29            return orderDetail;
30        }
31    }

在第13行的getOrderDetailByID方法以前，咱們在第12行經過fallbackMethod定義了回退方法，在這個方法的第16行裏，咱們定義了若是輸入是error，那麼則將拋出異常，以此觸發回退方法getFallback。而在第24行定義的回退方法裏，咱們將返回一個ID和Owner都是error的OrderDetail對象。本類用到的OrderDetail模型類定義以下。

1    public class OrderDetail{
2           private String orderId;//訂單id
3         private String orderOwner; //訂單全部人 
4        //省略必要的get和set方法
5    }

至此咱們完成了開發工做，啓動HystrixEurekaServer和HystrixEurekaserviceProvider後，若是在瀏覽器中輸入http://localhost:1111/getOrderDetailById/1，能看到以下的輸出，這說明走的是正常的流程。

{"orderId":"1","orderOwner":"Peter"}

但若是輸入的是http://localhost:1111/getOrderDetailById/error，那麼會在OrderDetailService類的getOrderDetailByID方法裏拋出異常，從而走Hystrix的回退流程，由此會輸入以下的語句。

{"orderId":"error","orderOwner":"error"}

在這個案例中，咱們是在「提供者服務」的模塊引入hytrix斷路器，而不是在「服務調用」模塊，這和項目中的常規作法相符，由於啓動斷路器的場景通常是「提供服務模塊的流量超載」。

4 在服務調用者項目裏引入合併請求機制

這裏咱們將在HystrixEurekaserviceCaller項目裏，調用HystrixEurekaserviceProvider裏定義的服務，在調用時，咱們將合併5秒內發送的請求。

步驟一，在控制器類Controller.java裏，初始化Hystrix請求上下文，並經過Future對象屢次發送請求，代碼以下。

1    //省略必要的package和import代碼
2    @Configuration
3    @RestController
4    public class Controller {         
5          @Autowired
6         private OrderDetailService service;//提供服務的service類
7    //在這個方法裏，將演示合併請求的效果
8        @RequestMapping(value = "/mergeDemo", method = RequestMethod.GET)
9        public List<OrderDetail> hystrixMergeDemo() throws Exception {
10        //初始化Hystrix請求上下文         
11            HystrixRequestContext context = HystrixRequestContext
12                    .initializeContext();
13            //經過定義三個Future對象，調用三次請求
14            Future<OrderDetail> f1 = service.getOneOrderDetail("1");
15            Future<OrderDetail> f2 = service.getOneOrderDetail("2");
16            Future<OrderDetail> f3 = service.getOneOrderDetail("3");
17            OrderDetail o1 = f1.get();
18            OrderDetail o2 = f2.get();
19            OrderDetail o3 = f3.get();
20            //把三個返回對象組裝到一個List中並返回
21            List<OrderDetail> orderDetailList = new ArrayList<OrderDetail>();
22            orderDetailList.add(o1);
23            orderDetailList.add(o2);
24            orderDetailList.add(o3);
25            //釋放上下文
26            context.shutdown();        
27            return orderDetailList;
28         }
29    }

在上文的hystrixMergeDemo方法裏，咱們首先在第11行初始化Hystrix請求上下文，隨後在第14到16行調用了三次getOneOrderDetail方法，並在第17到19行裏，經過Furure類型對象的get方法，把三次調用的結果分別賦予三個OrderDetail類型的對象。

以後，經過第21到24行的代碼，把三個OrderDetail對象組裝成一個List<OrderDetail>類型的orderDetailList對象，並在第27行返回了orderDetailList對象。

這裏雖然咱們是發出了三次調用請求，但從後文的講解裏，咱們能看到這三次請求實際上是被合併處理的。因爲在合併請求時，Hystrix處理類會把請求暫存在Hystrix請求上下文裏，因此這裏咱們必定得經過相似於第11行的代碼初始化上下文，不然將沒法獲得合併請求的結果。

步驟二，以前咱們看到，在Controller類裏，是調用OrderDetailService類的方法來查詢多個訂單，因此合併請求的代碼是寫在這個類裏的，咱們來看下代碼。

1    //省略必要的package和import代碼
2    @Component
3    public class OrderDetailService {
4        // 合併處理收集5秒內的請求
5        @HystrixCollapser(batchMethod = "getMoreOrderDetails",collapserProperties = {@HystrixProperty(name ="timerDelayInMilliseconds",value = "5000")})
6        public Future<OrderDetail> getOneOrderDetail(String id) {
7            System.out.println("in getOneOrderDetail");
8            return null;
9        }
10        @Bean
11        @LoadBalanced
12        public RestTemplate getRestTemplate()
13        { return new RestTemplate();      }
14    //這裏是合併請求的代碼    
15        @HystrixCommand
16        public List<OrderDetail> getMoreOrderDetails(List<String> orderIds) {
17            System.out.println("in getMoreOrderDetails," + orderIds.size());
18            List<OrderDetail> list = new ArrayList<OrderDetail>();
19            RestTemplate template = getRestTemplate();
20            //經過for循環，調用服務提供者的方法獲得OrderDetail對象
21            for (String orderId : orderIds) {
22                OrderDetail orderDetail = new OrderDetail();  
23                orderDetail = template.getForObject("http://localhost:1111/getOrderDetailById/{orderId}", OrderDetail.class,orderId);
24                list.add(orderDetail);
25            }
26            return list;
27        }
28    }

在第6行裏，咱們定義了只查詢一個對象的getOneOrderDetail方法，在定義該方法的註解裏，咱們指定了會把在5秒內調用該方法的請求合併到getMoreOrderDetails方法裏。

在第16行的getMoreOrderDetails方法裏，咱們是經過第21行到第25行的for循環，依次遍歷待查詢的orderId，並經過第23行的getForObject方法，調用服務提供者的getOrderDetailById方法，獲得對應的OrderDetail對象，並添加到List<OrderDetail>類型的list對象中。最後，是經過第26行的代碼，返回包含屢次請求結果的list對象。

當咱們啓動Eureka服務器（HystrixEurekaServer）、服務提供者（HystrixEurekaserviceProvider）和服務調用者（HystrixEurekaserviceCaller）三個項目後，能夠在瀏覽器裏輸入以下的請求，以此來查看合併請求的效果。

http://localhost:8080/mergeDemo

上述請求的輸出以下，咱們能看到3個OrderDetail對象。從上述的講解能看出，這3個對象實際上是經過一次合併後的請求獲得的。

[{"orderId":"1","orderOwner":"Peter"},{"orderId":"2","orderOwner":"Tom"},{"orderId":"3","orderOwner":"Mike"}]

本文謝絕轉載。其它和Spring Cloud相關的博文以下：

架構師系列文：經過Spring Cloud組件Hystrix合併請求

架構師入門：Spring Cloud系列，Hystrix與Eureka的整合

Hystrix針對不可用服務的保護機制以及引入緩存

經過案例瞭解Hystrix的各類基本使用方式

Ribbon整合Eureka組件，以實現負載均衡

Spring Clould負載均衡重要組件：Ribbon中重要類的用法

架構師入門：搭建雙註冊中心的高可用Eureka架構（基於項目實戰）