第十九章 springboot + hystrix（1）

hystrix是微服務中用於做熔斷、降級的工具。

作用：防止因為一個服務的調用失敗、調用延時導致多個請求的阻塞以及多個請求的調用失敗。

1、pom.xml（引入hystrix-core包）

         <!-- hystrix -->   
        <dependency>
            <groupId>com.netflix.hystrix</groupId>
            <artifactId>hystrix-core</artifactId>
            <version>1.5.2</version>
        </dependency>

2、application.properties

#hystrix
hystrix.timeoutInMillions = 3000

說明：設置hystrix屬性，如上是"服務調用超時時間"，其他屬性設置見：https://github.com/Netflix/Hystrix/wiki/Configuration

3、HyStrixProperties

package com.xxx.firstboot.hystrix;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
@Component
@ConfigurationProperties(prefix = "hystrix")
public class HyStrixProperties {
    private int timeoutInMillions;
}

4、MyHyStrixCommand

package com.xxx.firstboot.hystrix;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.netflix.hystrix.HystrixCommand;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response;

public class MyHystrixCommand extends HystrixCommand<Response> {
    private static final Logger LOGGER = LoggerFactory.getLogger(MyHystrixCommand.class);
    private String url;

    public MyHystrixCommand(Setter setter, String url) {
        super(setter);
        this.url = url;
    }

    @Override
    protected Response run() throws Exception {
        LOGGER.info("服務正被調用，當前線程：'{}'", Thread.currentThread().getName());
        Request request = new Request.Builder().url(url).build();
        return new OkHttpClient().newCall(request).execute();
    }

    @Override
    public Response getFallback() {
        LOGGER.error("服務調用失敗,service:'{}'");
        return null;
    }
}

說明：

• 該類是最關鍵的一個類。
• 繼承HystrixCommand<T>
• 添加構造器，注意：無法添加無參構造器，因此該類無法作為spring的bean來進行管理
• 程序開始時執行run()，當執行發生錯誤或超時時，執行getFallback()

5、HyStrixUtil

package com.xxx.firstboot.hystrix;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import com.netflix.hystrix.HystrixCommand.Setter;
import com.netflix.hystrix.HystrixCommandGroupKey;
import com.netflix.hystrix.HystrixCommandKey;
import com.netflix.hystrix.HystrixCommandProperties;
import com.squareup.okhttp.Response;

@Component
public class HystrixUtil {

    @Autowired
    private HyStrixProperties hp;
    
    public Response execute(String hotelServiceName, 
                            String hotelServiceMethodGetHotelInfo, 
                            String url) throws InterruptedException, ExecutionException {
        Setter setter = Setter.withGroupKey(HystrixCommandGroupKey.Factory.asKey(hotelServiceName));//被調用服務
        setter.andCommandKey(HystrixCommandKey.Factory.asKey(hotelServiceMethodGetHotelInfo));//被調用服務的一個被調用方法
        setter.andCommandPropertiesDefaults(HystrixCommandProperties.Setter().withExecutionTimeoutInMilliseconds(hp.getTimeoutInMillions()));
        return new MyHystrixCommand(setter, url).execute();//同步執行
//        Future<Response> future = new MyHystrixCommand(setter, url).queue();//異步執行
//        return future.get();//需要時獲取
    }

}

說明：

• hystrix的執行方式
  • 同步執行：超時時間起作用
  • 異步執行：超時時間不起作用（1.4.0之前的版本，在調用get()的時候開始計時起作用）
• hystrix的隔離級別
  • HystrixCommandGroupKey：這個的名稱設置為一個被調用的服務，eg.hotelService，所有這個服務下的方法都用同一個線程池（前提是沒有配置ThreadPoolKey）
  • HystrixCommandKey：這個名稱通常是被調用服務的一個方法的名字（實際上就是被調用服務某一個controller中的一個對外方法），eg.getHotelInfo()
  • ThreadPoolKey：這個用的很少，除非一個被調用服務中的有些被調用方法快、有的被調用方法慢，這樣的話，就需要分別使用一個ThreadPoolKey，為每一個方法單獨分配線程池

6、application.properties

service.hotel.name = hotelService
service.hotel.method.getHotelInfo = getHotelInfo 

說明：定義被調用服務的服務名和被調用方法名，當然服務名也可以使用被調用服務的controller的簡單類名。

7、HystrixController

package com.xxx.firstboot.web;

import java.io.IOException;
import java.util.concurrent.ExecutionException;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.squareup.okhttp.Response;
import com.xxx.firstboot.hystrix.HystrixUtil;

@RestController
@RequestMapping("/hystrix")
public class HystrixController {

    @Value("${service.hotel.url}")
    private String HOTEL_URL;

    @Value("${service.hotel.name}")
    private String hotelServiceName;
    
    @Value("${service.hotel.method.getHotelInfo}")
    private String hotelServiceMethodGetHotelInfo;
    
    @Autowired
    private HystrixUtil hystrixUtil;

    @RequestMapping(value = "/firstHystrix", method = RequestMethod.GET)
    public String getHotelInfo(@RequestParam("id") int id, @RequestParam("name") String name) {
        String url = String.format(HOTEL_URL, id, name);
        Response response = null;
        try {
            response = hystrixUtil.execute(hotelServiceName, hotelServiceMethodGetHotelInfo, url);
            if (response != null) {
                return response.body().string();
            }
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (ExecutionException e) {
            e.printStackTrace();
        } finally {
            if (response != null && response.body() != null) {
                try {
                    response.body().close();// 資源關閉
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return "獲取酒店信息失敗";
    }

}

說明：

• 使用@value做屬性注入，假設我們是在consul上配置了application.properties內容，當修改了屬性文件的內容后，該服務也必須重啟，因為@value只讀一次（沒測過，同事說的）
• 使用spring的Environment進行注入，當修改了屬性文件的內容后，服務不需要重啟，會每五分鍾重新刷一次（沒測過，同事說的）
• 使用boot構建一個屬性收集類，如上邊的HyStrixProperties類，不知道是否需要重啟（沒測過）

有測過的朋友和我講一下，我有時間也會測一下。

下邊是被調用服務的代碼：

8、HotelController

@RestController
@RequestMapping("/hotel")
@Api("HotelController相關api")
public class HotelController {
    @ApiOperation("獲取酒店Hotel信息：getHotelInfo")
    @RequestMapping(value="/getHotelInfo",method=RequestMethod.GET)
    public Hotel getHotelInfo(@RequestParam("id") int id, @RequestParam("name") String name) {
//        try {
//            TimeUnit.MILLISECONDS.sleep(2000);//用於測試超時
//        } catch (InterruptedException e) {
//            e.printStackTrace();
//        }
        return new Hotel(id, name);
    }
}

測試：啟動被調用服務-->啟動調用服務

 

參考：

http://blog.csdn.net/xiaoyu411502/article/details/50601687 官方的中文總結

https://stonetingxin.gitbooks.io/hystrix/content/ 基本上是官方的中文翻譯

https://github.com/Netflix/Hystrix/wiki/Configuration hystrix配置介紹

http://blog.vicoder.com/hystrix-configuration/ 配置介紹

http://www.insaneprogramming.be/blog/2014/08/19/hystrix-spring-boot/ boot集成hystrix