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

    和Ribbon等元件一樣，在項目中，Hystrix一般不會單獨出現，而是會和Eureka等元件配套出現。在Hystrix和Eureka整合後的架構裡，一般會用到Hystrix的斷路器以及合并請求等特性，而在Web架構裡，大多會有專門的緩存元件，是以不怎麼會用到Hystrix的緩存特性。

1 準備Eureka伺服器項目

    HystrixEurekaServer項目承擔着Eureka伺服器的作用，這部分的代碼關鍵點如下。

    第一，在pom.xml裡，通過如下關鍵代碼引入Eureka伺服器元件的依賴包。    

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);  }
   }      

2 服務提供者的代碼結構

    HystrixEurekaserviceProvider項目承擔着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    }      

    在Controller.java這個控制器類裡，我們是在第9行裡，通過調用service類提供的方法來傳回具體的OrderDetail資訊，代碼如下。    

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斷路器，而不是在“服務調用”子產品，這和項目中的正常做法相符，因為啟動斷路器的場景一般是“提供服務子產品的流量超載”。

    本人之前寫的和本文有關的Spring Cloud其它相關文章。

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

 通過案例了解Hystrix的各種基本使用方式 

  Ribbon整合Eureka元件，以實作負載均衡      Spring Clould負載均衡重要元件：Ribbon中重要類的用法      架構師入門：搭建雙注冊中心的高可用Eureka架構（基于項目實戰）      架構師入門：搭建基本的Eureka架構（從項目裡抽取）     借助Maven入手Spring Boot第一個程式