SpringCloud之熔斷監控Hystrix Dashboard的實現

這篇文章主要介紹了SpringCloud之熔斷監控Hystrix Dashboard的實現,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨着小編來一起學習學習吧

前言

SpringCloud 是微服務中的翹楚,最佳的落地方案。

SpringCloud 中的 Hystrix 組件可以實現熔斷,而在實際情況中,一般還需要直觀地看到各個服務的調用情況,

這時,就用到了 SpringCloud 另一個組件:Hystrix Dashboard。

Hystrix Dashboard 是一款針對於 Hystrix 進行實時監控的工具,還提供了友好的圖形化界面。

源碼

GitHub地址:https://github.com/intomylife/SpringCloud

  • JDK 1.8.0 +
  • Maven 3.0 +
  • SpringBoot 2.0.3
  • SpringCloud Finchley.RELEASE

開發工具

IntelliJ IDEA

正文

commons 工程

commons 工程 - POM 文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
 
  <!-- 三座標 -->
  <groupId>com.zwc</groupId>
  <artifactId>springcloud-dashboard-commons</artifactId>
  <version>1.0</version>
 
  <!-- 工程名稱和描述 -->
  <name>springcloud-dashboard-commons</name>
  <description>公用工程</description>
 
  <!-- 打包方式 -->
  <packaging>jar</packaging>
 
  <!-- 在 properties下聲明相應的版本信息,然後在dependency下引用的時候用 ${} 就可以引入該版本jar包了 -->
  <properties>
    <!-- 編碼 -->
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <!-- jdk -->
    <java.version>1.8</java.version>
 
    <!-- SpringBoot -->
    <platform-bom.version>Cairo-SR3</platform-bom.version>
 
    <!-- SpringCloud -->
    <spring-cloud-dependencies.version>Finchley.RELEASE</spring-cloud-dependencies.version>
  </properties>
 
  <!-- 加入依賴 -->
  <dependencies>
 
  </dependencies>
 
  <!-- 依賴 jar 包版本管理的管理器 -->
  <!-- 如果 dependencies 裏的 dependency 自己沒有聲明 version 元素,那麼 maven 就此處來找版本聲明。 -->
  <!-- 如果有,就會繼承它;如果沒有就會報錯,告訴你沒有版本信息 -->
  <!-- 優先級:如果 dependencies 裏的 dependency 已經聲明瞭版本信息,就不會生效此處的版本信息了 -->
  <dependencyManagement>
    <dependencies>
      <!-- SpringBoot -->
      <dependency>
        <groupId>io.spring.platform</groupId>
        <artifactId>platform-bom</artifactId>
        <version>${platform-bom.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <!-- SpringCloud -->
      <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>${spring-cloud-dependencies.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
 
  <!-- 插件依賴 -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
 
</project>

配置一些共用依賴

commons 工程 - 項目結構

service 工程

  ① 此工程下有三個模塊:一個註冊中心以及服務 A、B

  ② A 提供服務並且調用服務 B 以及 B 提供服務

registry-service(註冊中心)

registry-service - POM 文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
 
  <!-- 繼承父 -->
  <parent>
    <groupId>com.zwc</groupId>
    <artifactId>springcloud-dashboard-service</artifactId>
    <version>1.0</version>
  </parent>
 
  <!-- 三座標 -->
  <groupId>com.zwc</groupId>
  <artifactId>springcloud-dashboard-registry-service</artifactId>
  <version>1.0</version>
 
  <!-- 工程名稱描述 -->
  <name>springcloud-dashboard-registry-service</name>
  <description>註冊中心</description>
 
  <!-- 打包方式 -->
  <packaging>jar</packaging>
 
  <!-- 在 properties下聲明相應的版本信息,然後在dependency下引用的時候用 ${} 就可以引入該版本jar包了 -->
  <properties>
 
  </properties>
 
  <!-- 加入依賴 -->
  <dependencies>
    <!-- commons工程 依賴 -->
    <dependency>
      <groupId>com.zwc</groupId>
      <artifactId>springcloud-dashboard-commons</artifactId>
      <version>1.0</version>
    </dependency>
 
    <!-- 服務註冊中心 -->
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    </dependency>
  </dependencies>
 
  <!-- 插件依賴 -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
 
</project>

主要是加入 spring-cloud-starter-netflix-eureka-server 依賴

registry-service - application.yml 配置文件

# 端口
server:
 port: 8761
 
# 應用名稱
spring:
 application:
  name: eureka-server
 
eureka:
 instance:
  # 使用 ip 代替實例名
  prefer-ip-address: true
  # 實例的主機名
  hostname: ${spring.cloud.client.ip-address}
  # 實例的 ID 規則
  instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
 client:
  # 是否向註冊中心註冊自己
  registerWithEureka: false
  # 是否向註冊中心獲取註冊信息
  fetchRegistry: false
  serviceUrl:
   # 註冊中心地址
   defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

這裏使用了默認的 8761 端口,當然也可以更改,不過在發現調用服務端的註冊中心地址端口要與它一致

registry-service - 啓動類

package com.zwc;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
 
@SpringBootApplication
@EnableEurekaServer
public class SpringcloudDashboardRegistryServiceApplication {
 
  public static void main(String[] args) {
    SpringApplication.run(SpringcloudDashboardRegistryServiceApplication.class, args);
  }
 
}

在啓動類中添加 @EnableEurekaServer 註解表示此工程是註冊中心registry-service - 啓動項目

. 項目啓動成功後訪問 http://localhost:8761/ 即可看到 eureka-server 主頁面

服務工程 A(提供者和消費者)

服務工程 A - POM 文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
 
  <!-- 繼承父 -->
  <parent>
    <groupId>com.zwc</groupId>
    <artifactId>springcloud-dashboard-a-service</artifactId>
    <version>1.0</version>
  </parent>
 
  <!-- 三座標 -->
  <groupId>com.zwc</groupId>
  <artifactId>springcloud-dashboard-a-service-core</artifactId>
  <version>1.0</version>
 
  <!-- 工程名稱描述 -->
  <name>springcloud-dashboard-a-service-core</name>
  <description>服務工程 - A 核心</description>
 
  <!-- 打包方式 -->
  <packaging>jar</packaging>
 
  <!-- 在 properties下聲明相應的版本信息,然後在dependency下引用的時候用 ${} 就可以引入該版本jar包了 -->
  <properties>
 
  </properties>
 
  <!-- 加入依賴 -->
  <dependencies>
    <!-- commons工程 依賴 -->
    <dependency>
      <groupId>com.zwc</groupId>
      <artifactId>springcloud-dashboard-commons</artifactId>
      <version>1.0</version>
    </dependency>
 
    <!-- api工程 依賴 -->
    <dependency>
      <groupId>com.zwc</groupId>
      <artifactId>springcloud-dashboard-a-service-api</artifactId>
      <version>1.0</version>
    </dependency>
 
    <!-- 提供者消費者 -->
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!-- feign -->
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <!-- actuator -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!-- hystrix -->
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
    </dependency>
    <!-- dashboard -->
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
    </dependency>
  </dependencies>
 
  <!-- 插件依賴 -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
 
</project>
  • 加入 spring-cloud-starter-netflix-eureka-client 依賴:提供和註冊服務
  • 加入 Feign 的起步依賴 spring-cloud-starter-openfeign:消費服務
  • 加入依賴 spring-boot-starter-actuator:開啓並配置端點
  • 加入依賴 spring-cloud-starter-netflix-hystrix:熔斷器
  • 加入依賴 spring-cloud-starter-netflix-hystrix-dashboard:熔斷監控

服務工程 A - application.yml 配置文件

# 端口
server:
 port: 8090
 
# 應用名稱
spring:
 application:
  name: dashboard-a
 
eureka:
 instance:
  # 使用 ip 代替實例名
  prefer-ip-address: true
  # 實例的主機名
  hostname: ${spring.cloud.client.ip-address}
  # 實例的 ID 規則
  instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
 client:
  serviceUrl:
   # 註冊中心地址
   defaultZone: http://${eureka.instance.hostname}:8761/eureka/
 
management:
 endpoints:
  web:
   exposure:
    # 開啓監控端點
    include: hystrix.stream
   base-path: /
  • 注意此處配置註冊中心地址的端口爲 8761 也就是上面註冊中心工程配置的端口
  • spring.application.name:應用名稱,被消費者調用時需要用到,它在消費的同時也可以被消費
  • 另一個服務工程 B 配置與此類似,只是端口不一樣,不再贅述
  • 在 2.0 後需要主動開啓端點 hystrix.stream,否則 404

服務工程 A -  application.properties(注意)

# 開啓斷路器
feign.hystrix.enabled=true
  • 斷路器要主動開啓,服務調用失敗時纔會熔斷
  • 此處有一個坑,把此配置寫到 yml 中熔斷不會生效
  • application.properties 和 bootstrap.yml 二選一就行

服務工程 A -  bootstrap.yml(注意)

feign:
 hystrix:
  # 開啓斷路器
  enabled: true
  • 斷路器要主動開啓,服務調用失敗時纔會熔斷
  • 此處有一個坑,把此配置寫到 application.yml 中熔斷不會生效
  • application.properties 和 bootstrap.yml 二選一就行

服務工程 A - controller 前端控制器(提供服務)

package com.zwc.a.controller;
 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/*
 * @ClassName ASayHelloController
 * @Desc TODO  Say Hello
 * @Date 2019/5/20 23:24
 * @Version 1.0
 */
@RestController
public class ASayHelloController {
 
  /*
   * @ClassName ASayHelloController
   * @Desc TODO  讀取配置文件中的端口
   * @Date 2019/5/20 23:24
   * @Version 1.0
   */
  @Value("${server.port}")
  private String port;
 
  /*
   * @ClassName ASayHelloController
   * @Desc TODO  Say Hello
   * @Date 2019/5/20 23:24
   * @Version 1.0
   */
  @RequestMapping("/a")
  public String a(){
    return "Hello!I'm a. port:" + port;
  }
 
}

提供一個服務:輸出 Hello 和端口

服務工程 A - 服務調用

package com.zwc.a.api.feign;
 
import com.zwc.a.api.impl.FeignApiFallBack;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
 
/*
 * @ClassName FeignApi
 * @Desc TODO  使用 Feign 調用 b - 接口
 * @Date 2019/5/20 23:21
 * @Version 1.0
 */
@FeignClient(value = "dashboard-b" , fallback = FeignApiFallBack.class)
public interface FeignApi {
 
  /*
   * @ClassName FeignApi
   * @Desc TODO  通過 dashboard-b 服務名調用 b() 方法
   * @Date 2019/5/20 23:21
   * @Version 1.0
   */
  @RequestMapping("/b")
  String b();
 
}
  • 通過 @FeignClient 註解中 value = "dashboard-b" 來指定調用哪個服務
  • dashboard-b 就是提供者的 spring.application.name:應用名稱
  • 通過 @FeignClient 註解中 fallback = FeignApiFallBack.class 來指定熔斷時調用的方法
  • FeignApiFallBack 就是此類(FeignApi)的實現類,對應的實現方法就是此類的熔斷時調用的方法
  • b():此方法是 B 工程中提供的服務,在這裏定義成接口
  • 注意要與提供者具有相同返回值,相同方法名以及相同參數

服務工程 A - Fallback(FeignApiFallBack)

package com.zwc.a.api.impl;
 
import com.zwc.a.api.feign.FeignApi;
import org.springframework.stereotype.Component;
 
/*
 * @ClassName FeignApi
 * @Desc TODO  fallback
 * @Date 2019/5/20 23:21
 * @Version 1.0
 */
@Component
public class FeignApiFallBack implements FeignApi {
 
  /*
   * @ClassName FeignApiFallBack
   * @Desc TODO  調用 dashboard-b 服務中的 b() 方法失敗時執行
   * @Date 2019/5/20 23:31
   * @Version 1.0
   */
  @Override
  public String b() {
    return "Hello!aUseB fail";
  }
}

使用 @Component 註解把此類交給 Spring 管理

實現了 FeignApi 接口,提供熔斷時對應的方法

服務工程 A - controller 前端控制器(消費服務)

package com.zwc.a.controller;
 
import com.zwc.a.api.feign.FeignApi;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/*
 * @ClassName AUseBFeignController
 * @Desc TODO  使用 Feign 調用 b - 前端控制器
 * @Date 2019/5/20 23:23
 * @Version 1.0
 */
@RestController
public class AUseBFeignController {
 
  @Autowired(required = false)
  private FeignApi feignApi;
 
  /*
   * @ClassName FeignController
   * @Desc TODO  通過 dashboard-b 服務名調用 b() 方法
   * @Date 2019/5/20 23:13
   * @Version 1.0
   */
  @RequestMapping("/aUseB")
  public String aUseB(){
    return feignApi.b();
  }
 
}

使用 @Autowired 註解裝配 Bean,通過此 Bean 中的方法調用服務

此類對外暴露接口,調用的實則是提供者的服務

服務工程 A - 啓動類

package com.zwc;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.hystrix.EnableHystrix;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.cloud.openfeign.EnableFeignClients;
 
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
@EnableHystrix
@EnableHystrixDashboard
public class SpringcloudDashboardAServiceCoreApplication {
 
  public static void main(String[] args) {
    SpringApplication.run(SpringcloudDashboardAServiceCoreApplication.class, args);
  }
 
}
  • 添加 @EnableEurekaClient 註解表示此工程可以向註冊中心提供服務
  • 添加 @EnableFeignClients 註解表示開啓 Feign 功能進行遠程調用
  • 添加 @EnableHystrix 註解表示開啓熔斷器
  • 添加 @EnableHystrixDashboard 註解表示開啓熔斷監控

服務工程 A - 啓動項目

1. 項目啓動成功後訪問:http://localhost:8090/hystrix 可以看到

  

2. 在中間的輸入框中輸入:http://127.0.0.1:8090/hystrix.stream ,點擊 Monitor Stream 按鈕可以看到

  3. 此時還未調用服務,所以一直顯示 'Loading ...'

  4. 另起頁面訪問:http://localhost:8090/a (調用自己的服務)

  5. 輸出內容:'Hello!I'm a. port:8090'

  6. 這是熔斷監控頁面還是不會有所改變,因爲在調用別人的服務時纔會有相關數據

  7. 訪問地址:http://localhost:8090/aUseB (調用 B 工程的服務)

  8. 輸出內容:'Hello!aUseB fail' (此時因爲 B 工程還未啓動,所以調用了 fallback 中的方法)

  9. 再觀察步驟 2 中的熔斷監控頁面,可以看到

  

 10. 啓動服務工程 B,項目啓動成功後再次訪問:http://localhost:8090/aUseB (調用 B 工程的服務)

 11. 輸出內容:'Hello!I'm b. port:8091' (如果還未調用成功,等待一會再刷新試試)

 12. 再次觀察步驟 2 中的熔斷監控頁面,可以看到

 13. 紅色的百分比表示失敗率

 14. 左邊的六個數字對應着頁面右上角的六個狀態(Success、Short-Circuited..) 

service 工程 - 項目結構

把多工程項目使用 IntelliJ IDEA  打開

  • 把項目從 GitHub 中下載到你的本地
  • 打開 IntelliJ IDEA 
  • 點擊 File -> Open
  • 打開你下載到本地的項目目錄
  • springcloud-dashboard -> springcloud-dashboard-service(選擇打開此工程)
  • 打開 service 工程後
  • 再次點擊 File -> Project Structrue
  • 選擇 Modules,點擊 '+' 符號
  • 點擊 Import  Module
  • 還是打開你下載到本地的項目目錄
  • springcloud-dashboard -> springcloud-dashboard-commons -> pom.xml
  • 點擊 OK
  • 點擊 Next,Finish
  • 點擊 Apply,OK

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章