SpringCloud06之仪表监测及路由网关配置(基于IDEA)

上一期博客我们介绍了熔断器的应用，主要讲解了Hystrix在Ribbon以及Feign中的用法。博客链接为https://blog.csdn.net/chenpeixing361/article/details/95641411。这一期博客我们主要介绍两方面内容，一方面是熔断器仪表盘的监测，另一方面是使用路由网关统一访问接口。接下来我们以实际的代码向大家具体说明用法。

我们在之前的feign项目的pom.xml文件中添加如下代码：

<!-- 添加Hystrix仪表盘功能 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix-dashboard</artifactId>
        </dependency>

然后我们在Application类中添加注解@EnableHystrixDashboard,表明该类添加了熔断器仪表盘，代码如下：

package com.chen.hello.spring.cloud.web.admin.fegin;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
@EnableHystrixDashboard
public class WebAdminFeginApplication {
    public static void main(String[] args) {
        SpringApplication.run(WebAdminFeginApplication.class,args);
    }
}

由于SpringBoot2.x开启Hystrix Dashboard与Spring Boot1.x的方式不同，我们需要另外创建hystrix.stream的Servlet配置，新建config包，然后新建HystrixDashboardConfiguration类，其代码如下：

package com.chen.hello.spring.cloud.web.admin.fegin.config;

import com.netflix.hystrix.contrib.metrics.eventstream.HystrixMetricsStreamServlet;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class HystrixDashboardConfiguration {

    @Bean
    public ServletRegistrationBean getServlet() {
        HystrixMetricsStreamServlet streamServlet = new HystrixMetricsStreamServlet();
        ServletRegistrationBean registrationBean = new ServletRegistrationBean(streamServlet);
        registrationBean.setLoadOnStartup(1);
        registrationBean.addUrlMappings("/hystrix.stream");
        registrationBean.setName("HystrixMetricsStreamServlet");
        return registrationBean;
    }
}

接下来我们对熔断器仪表盘进行测试，我们需要先后开启8761,8764和8765三个端口，然后输入网址http://localhost:8765/hystrix,测试截图如下：

然后我们输入网址以及标题，截图如下：

然后我们点击Monitor Stream,进入下一个界面，我们访问http://localhost:8765/hi?message=HelloFeign,此时熔断器会起作用，因为服务没有开启，多刷新几次后，熔断器仪表盘会有所记录，截图如下：

可见我们刷新了8次，成功率为100%。

接下来我们配置路由网关统一访问接口，新建子项目hello-spring-cloud-zuul,其pom.xml文件代码如下：

<?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.chen</groupId>
        <artifactId>hello-spring-cloud-dependencies</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <relativePath>../hello-spring-cloud-dependencies/pom.xml</relativePath>
    </parent>

    <artifactId>hello-spring-cloud-zuul</artifactId>
    <packaging>jar</packaging>

    <name>hello-spring-cloud-zuul</name>
    <inceptionYear>2019-Now</inceptionYear>

    <dependencies>
        <!-- Spring Boot Begin -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot End -->

        <!-- Spring Cloud Begin -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <!-- 添加API网关Zuul -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <!-- Spring Cloud End -->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.chen.spring.cloud.zuul.ZuulApplication</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

接着我们新建application.yml文件，配置端口信息并且用api网关聚合之前的ribbon以及feign服务，并配置各自的path和serviceId，其中/api/a/**中的**表示通配符，代码如下：

spring:
  application:
    name: hello-spring-cloud-zuul

server:
  port: 8769

eureka:
  client:
    service-url:
      default-zone: http://localhost:8761/eureka/

#api网关聚合两个服务
zuul:
  routes:
    api-a:
      path: /api/a/**
      serviceId: hello-spring-cloud-web-admin-ribbon
    api-b:
      path: /api/b/**
      serviceId: hello-spring-cloud-web-admin-feign

然后和之前的步骤大同小异，我们新建ZuulApplication类，并添加@EnableZuulProxy注解，表示加入了Zuul网关的代理，当然该应用类仍然是Eureka服务的客户端，即消费者身份，所以添加@EnableEurekaClient是必须的。代码如下：

package com.chen.spring.cloud.zuul;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class,args);
    }
}

好了，到这儿基本结束了，我们依次开启8761,8763,8764,8765和8769共5个端口，界面截图如下：

然后我们打开浏览器依次访问http://localhost:8769/api/a/hi?message=HelloZuul和http://localhost:8769/api/b/hi?message=HelloZuul,运行截图如下：

有时候会出现网络不稳定的情况，会出现请求失败的情况，所以我们需要配置网关路由失败时的回调，新建provider包，并创建WebAdminFeignFallbackProvder类，其代码如下：

package com.chen.spring.cloud.zuul.provider;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cloud.netflix.zuul.filters.route.FallbackProvider;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.stereotype.Component;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;

/**
 * 路由hello-spring-cloud-web-admin-feign失败时的回调
 */
@Component
public class WebAdminFeignFallbackProvider implements FallbackProvider {

    @Override
    public String getRoute() {
        return "hello-spring-cloud-web-admin-feign";
    }

    /**
     * 如果请求失败,则返回指定的信息给调用者
     * @param route 路由
     * @param cause
     * @return
     */
    @Override
    public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
        return new ClientHttpResponse() {
            /**
             * 网关向api服务请求失败了,但是消费者客户端向网关发起的请求是成功的，
             * 不应该把api的404,500等问题抛给客户端，
             * 网关和api服务集群对于客户端来说是黑盒。
             * @return
             * @throws IOException
             */
            @Override
            public HttpStatus getStatusCode() throws IOException {
                return HttpStatus.OK;
            }

            @Override
            public int getRawStatusCode() throws IOException {
                return HttpStatus.OK.value();
            }

            @Override
            public String getStatusText() throws IOException {
                return HttpStatus.OK.getReasonPhrase();
            }

            @Override
            public void close() {

            }

            @Override
            public InputStream getBody() throws IOException {
                ObjectMapper objectMapper = new ObjectMapper();
                Map<String,Object> map = new HashMap<>();
                map.put("status",200);
                map.put("message","无法连接,请检查您的网络!");
                return new ByteArrayInputStream(objectMapper.writeValueAsString(map).getBytes("UTF-8"));

            }

            @Override
            public HttpHeaders getHeaders() {
                HttpHeaders headers = new HttpHeaders();
                //和getBody中的编码内容一致
                headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
                return headers;
            }
        };
    }
}

如果出现网络故障问题，那么界面会显示一个json字符串，status值为200，表示请求成功；message值为“无法连接，请检查您的网络!”，表明网络故障问题。

好了，本期博客的讲解就到这里了，我们下期再见！