spring cloud zuul的回退

ゞ浴缸里的玫瑰 2024-02-19 18:44 62阅读 0赞

当我们使用 **@EnableZuulProxy** 注解来开启zuul的路由时，默认在@EnableZuulProxy注解上就**包含**了**@EnableCircuitBreaker**注解，即开启了断路器功能。那么在zuul无法访问到某个微服务时，如何进行回退呢？

## **需求：** ##

现在我们有2个微服务，product-provider(商品微服务) product-consumer-8201(商品消费微服务)，现在我们使用 zuul 来路由访问这2个微服务，对 product-provider 微服务来进行回退处理，另外一个不做处理，看返回的结果是什么。

## 实现： ##

### 一、编写网关回退代码 ###

**对product-provider回退,对 product-consumer-8201不进行回退**

package com.huan.study.zuul.fallback;
    
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.google.common.collect.Maps;
    import com.netflix.hystrix.exception.HystrixTimeoutException;
    import lombok.extern.slf4j.Slf4j;
    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.InputStream;
    import java.util.Map;
    
    /**
     * <pre>
     * 服务回退
     * 	建议实现  FallbackProvider 接口，这个接口可以拿到发生回退的原因，可以根据具体的异常返回不同的信息到前台
     * 	         ZuulFallbackProvider 这个接口，已经被标记成过时了，不要在使用。
     * </pre>
     *
     * @author huan.fu
     * @date 2018/6/13 - 11:50
     */
    @Component
    @Slf4j
    public class ProductProviderFallbackProvider implements FallbackProvider {
    
    	@Override
    	public String getRoute() {
    		// 返回 null 或者 * 表示为所谓路由的服务提供一个默认的回退实现
    		return "product-provider";
    	}
    
    	@Override
    	public ClientHttpResponse fallbackResponse(final Throwable cause) {
    		log.info("zuul error:", cause);
    		if (cause instanceof HystrixTimeoutException) {
    			return response(HttpStatus.GATEWAY_TIMEOUT);
    		} else {
    			return fallbackResponse();
    		}
    	}
    
    	@Override
    	public ClientHttpResponse fallbackResponse() {
    		return response(HttpStatus.INTERNAL_SERVER_ERROR);
    	}
    
    	private ClientHttpResponse response(final HttpStatus status) {
    		return new ClientHttpResponse() {
    			@Override
    			public HttpStatus getStatusCode() {
    				return status;
    			}
    
    			@Override
    			public int getRawStatusCode() {
    				return status.value();
    			}
    
    			@Override
    			public String getStatusText() {
    				return status.getReasonPhrase();
    			}
    
    			@Override
    			public void close() {
    			}
    
    			@Override
    			public InputStream getBody() throws JsonProcessingException {
    				Map<String, Object> ret = Maps.newHashMap();
    				ret.put("msg", "商品服务不可用");
    				ret.put("code", -999999);
    				return new ByteArrayInputStream(new ObjectMapper().writeValueAsBytes(ret));
    			}
    
    			@Override
    			public HttpHeaders getHeaders() {
    				HttpHeaders headers = new HttpHeaders();
    				headers.setContentType(MediaType.APPLICATION_JSON);
    				return headers;
    			}
    		};
    	}
    }

**注意：**

**1、需要实现回退接口： FallbackProvider，而不要实现 ZuulFallbackProvider 接口**

**2、FallbackProvider可以拿到发生回退的异常信息，根据异常信息可以给前台返回不同信息**

**3、ZuulFallbackProvider这个接口现在已经过时了**

**4、这个类需要被 Spring 管理即可**

**5、getRoute() 方法中返回的服务Id的值，即需要为那个服务发生回退，如果要为所有的服务发生回退那么可以写 null 或 写 \* 号。**

### 二、pom文件中网关路由的配置 ###

# 服务网关配置
    zuul:
      ignored-services: "*" # 忽略所有的微服务
      routes:
        product-route-name:
          path: /product/**
          serviceId : product-provider
        product-consumer-8201: /product-consumer/**

### 三、运行结果 ###

![aHR0cDovL2RsMi5pdGV5ZS5jb20vdXBsb2FkL2F0dGFjaG1lbnQvMDEzMC8wNTM5L2FlYzlmMDRjLTNhOWItMzZiOC1iYzg0LWJmZTdiMTcwMjI5NS5naWY][]  
可以看到，当只启动网关和注册中心时，product-provider和product-consumer-8201不启动时，访问 product-provider时发生了回退，访问 product-consumer-8201时发生了异常，即没有回退。

## 完整代码 ##

zuul 网关回退代码： [https://gitee.com/huan1993/spring-cloud-parent/tree/master/zuul/product-gateway-fallbackprovider-8206][https_gitee.com_huan1993_spring-cloud-parent_tree_master_zuul_product-gateway-fallbackprovider-8206]

[aHR0cDovL2RsMi5pdGV5ZS5jb20vdXBsb2FkL2F0dGFjaG1lbnQvMDEzMC8wNTM5L2FlYzlmMDRjLTNhOWItMzZiOC1iYzg0LWJmZTdiMTcwMjI5NS5naWY]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/c0bac63bc70c4955af84bda132d3a1df.png
[https_gitee.com_huan1993_spring-cloud-parent_tree_master_zuul_product-gateway-fallbackprovider-8206]: https://gitee.com/huan1993/spring-cloud-parent/tree/master/zuul/product-gateway-fallbackprovider-8206