Spring Cloud --- zuul API网关

╰+攻爆jí腚メ 2022-11-26 01:58 215阅读 0赞

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70_pic_center]

### 文章目录 ###

*  一、zuul API网关
 *   *  1.1 API网关作用：
     *  1.2 新建项目
     *  1.3 访问测试
 *  二、zuul 请求过滤
 *   *  2.1 定义过滤器，继承 ZuulFilter
     *  2.2 访问测试
 *  三、zuul集成ribbon
 *   *  3.1 zuul + ribbon 负载均衡
     *  3.2 zuul + ribbon 重试
     *  3.3 zuul + hystrix 降级
     *   *  3.3.1 创建降级类
     *  3.4 降低 hystrix 超时时间，以便测试降级
     *  3.5 重新启动服务，测试
 *  四、zuul + hystrix 数据监控
 *   *  4.1 暴露 hystrix.stream 监控端点
     *  4.2 zuul + turbine 聚合监控
     *  4.3 访问测试
     *  4.4 熔断测试
 *  五、Zuul 和 Feign
 *  六、zuul Cookie过滤

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70_pic_center 1]

# 一、zuul API网关 #

zuul API 网关，为微服务应用提供统一的对外访问接口。  
zuul 还提供过滤器，对所有微服务提供统一的请求校验。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70]

## 1.1 API网关作用： ##

1.  统一的调用入口
2.  调用过滤，统一的权限校验
3.  集成 ribbon
4.  集成 hystrix

## 1.2 新建项目 ##

1.  新建 sp11-zuul项目  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 1]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 2]
2.  添加依赖  
    需要添加 sp01-commons 依赖

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.2.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>cn.tedu</groupId>
        <artifactId>sp11-zuul</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>sp11-zuul</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Hoxton.SR6</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>cn.tedu</groupId>
                <artifactId>sp01-commons</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${ spring-cloud.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>

1.  application.yml配置  
    zuul 路由配置可以省略，缺省以服务 id 作为访问路径

spring:
      application:
        name: zuul
        
    server:
      port: 3001
    
    eureka:
      client:
        service-url:
          defaultZone: http://eureka1:2001/eureka, http://eureka2:2002/eureka
    
    zuul:
      routes:
        item-service: /item-service/** user-service: /user-service/** order-service: /order-service/**

1.  主程序添加注解

package cn.tedu.sp11;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    
    @EnableZuulProxy
    @EnableDiscoveryClient
    @SpringBootApplication
    public class Sp11ZuulApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(Sp11ZuulApplication.class, args);
        }
    }

## 1.3 访问测试 ##

*  [http://eureka1:2001][http_eureka1_2001]
 *  [http://localhost:7001/item-service/35][http_localhost_7001_item-service_35]
 *  `http://localhost:7001/item-service/decreaseNumber`  
    使用postman，POST发送以下格式数据：  
    `[{"id":1, "name":"abc", "number":23},{"id":2, "name":"def", "number":11}]`
 *  [http://localhost:7001/user-service/7][http_localhost_7001_user-service_7]
 *  [http://localhost:7001/user-service/7/score?score=100][http_localhost_7001_user-service_7_score_score_100]
 *  [http://localhost:7001/order-service/123abc][http_localhost_7001_order-service_123abc]
 *  [http://localhost:7001/order-service/][http_localhost_7001_order-service]

--------------------

# 二、zuul 请求过滤 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 3]

## 2.1 定义过滤器，继承 ZuulFilter ##

添加过滤器，继承 `ZuulFilter`，按照规则实现过滤方法。不用做任何配置，只需要添加 `@Component`注解。

在 sp11-zuul 项目中新建过滤器类

package cn.tedu.sp11.filter;
    
    import cn.tedu.web.util.JsonResult;
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import com.netflix.zuul.exception.ZuulException;
    import org.apache.commons.lang.StringUtils;
    import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
    import org.springframework.stereotype.Component;
    
    import javax.servlet.http.HttpServletRequest;
    
    @Component
    public class AccessFilter extends ZuulFilter { 
    
        /** * 过滤器类型：前置，后置，路由，错误 * @return */
        @Override
        public String filterType() { 
            return FilterConstants.PRE_TYPE;
        }
    
        /** * 过滤器添加的顺序号 * 返回6，表示加到第6个位置 * @return */
        @Override
        public int filterOrder() { 
            return 6;
        }
    
        /** * 针对当前请求进行判断，判断当前请求是否要执行这个过滤器的过滤代码 * 1)如果访问item-service，要检查权限 * 2)如果访问其他服务，则不检查权限，直接访问 * @return */
        @Override
        public boolean shouldFilter() { 
            RequestContext ctx = RequestContext.getCurrentContext();
            //获得当前请求的服务id
            String serviceId = (String) ctx.get(FilterConstants.SERVICE_ID_KEY);
            if (serviceId.equals("item-service")) { 
                return true;//要执行过滤权限
            }
            return false;//跳过过滤代码不执行
        }
    
        /** * 过滤代码，对用户权限进行检查 * @return * @throws ZuulException */
        @Override
        public Object run() throws ZuulException { 
            //http://localhost:3001/item-service/245t243t2?token=k4jh3424g2
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request =ctx.getRequest();
            String token = request.getParameter("token");
    
            if (StringUtils.isEmpty(token)){ 
                //没有token，阻止继续调用
                ctx.setSendZuulResponse(false);
    
                //发送提示，提示用户没有登录
                ctx.setResponseStatusCode(JsonResult.NOT_LOGIN);
                //向客户端的响应
                ctx.setResponseStatusCode(200);
                ctx.setResponseBody(JsonResult.err().code(JsonResult.NOT_LOGIN).msg("not login!!!").toString());
            }
            return null;//zuul,过度设计，返回值在现在的版本中没有使用
        }
    }

## 2.2 访问测试 ##

*  没有token参数不允许访问  
    [http:/localhost:7001/item-service/35][http_localhost_7001_item-service_35 1]
 *  有token参数可以访问  
    [http://localhost:7001/item-service/35?token=1234][http_localhost_7001_item-service_35_token_1234]

# 三、zuul集成ribbon #

*  默认启用负载均衡
 *  重试默认不启用，zuul不推荐启用重试
 *  如果启用重试功能，添加以下配置：
    
     *  添加 spring-retry 依赖
     *  zuul.retryable=true
     *  配置参数
        
         *  MaxAutoRetries
         *  MaxAutoRetriesNextServer
         *  ReadTimeout

ribbon:
      ReadTimeout: 1000
      MaxAutoRetries: 1
      MaxAutoRetriesNextServer: 2

## 3.1 zuul + ribbon 负载均衡 ##

zuul 已经集成了 ribbon，默认已经实现了负载均衡

## 3.2 zuul + ribbon 重试 ##

**（1）pom.xml 添加 spring-retry 依赖**

*  需要 spring-retry 依赖

<dependency>
    	<groupId>org.springframework.retry</groupId>
    	<artifactId>spring-retry</artifactId>
    </dependency>

**（2）配置 zuul 开启重试，并配置 ribbon 重试参数**

*  需要开启重试，默认不开启

spring:
      application:
        name: zuul
    
    server:
      port: 7001
    
    eureka:
      client:
        service-url:
          defaultZone: http://eureka1:2001/eureka, http://eureka2:2002/eureka
    
    zuul:
      routes:
        item-service: /item-service/** user-service: /user-service/** order-service: /order-service/** retryable: true ribbon: ConnectTimeout: 1000 ReadTimeout: 1000 MaxAutoRetriesNextServer: 2 MaxAutoRetries: 1

## 3.3 zuul + hystrix 降级 ##

0配置，已经启用了 hystrix

降级代码：

*  实现 FallbackProvider 接口，实现降级代码
 *  只需要添加 `@Component` 注解

>  *  **单独用hystrix**  
>     @HystrixCommand(fallbackMethod=“方法名”)
>  *  **feign添加hystrix降级**  
>     @FeignClient(name="",fallback=降级类.class)
>  *  **zuul+hystrix**  
>     实现 FallbackProvider 接口，实现降级代码，只需要添加 `@Component` 注解

### 3.3.1 创建降级类 ###

*  getRoute() 方法中指定应用此降级类的服务id，星号或null值可以通配所有服务

**（1）ItemServiceFallback商品降级**

package cn.tedu.sp11.fallback;
    
    import cn.tedu.web.util.JsonResult;
    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;
    
    @Component
    public class ItemFallback implements FallbackProvider { 
        /** * 当前降级类，对哪个服务有效 * 如果返回“item-service”，那么当前降级类只对商品服务有效 * 如果返回“*”，那么对所有服务都有效 * @return */
        @Override
        public String getRoute() { 
            return "item-service";
            //星号和null都表示所有微服务失败都应用当前降级类
            //return "*";
            //return null;
        }
    
    
        @Override
        public ClientHttpResponse fallbackResponse(String route, Throwable cause) { 
            return response();
        }
    
        private ClientHttpResponse response() { 
            return new ClientHttpResponse() { 
                //下面三个方法都是协议号
                @Override
                public HttpStatus getStatusCode() throws IOException { 
                    //{200，"ok"}
                    return HttpStatus.OK;
                }
                @Override
                public int getRawStatusCode() throws IOException { 
                    //{200}
                    return HttpStatus.OK.value();
                }
                @Override
                public String getStatusText() throws IOException { 
                    //ok
                    return HttpStatus.OK.getReasonPhrase();
                }
    
                @Override
                public void close() { 
                }
                //协议体
                @Override
                public InputStream getBody() throws IOException { 
                    //JsonResult:{code:400,msg:"获取商品列表失败！",data:null}
                    String r = JsonResult.err().msg("not login").toString();
                    ByteArrayInputStream input = new ByteArrayInputStream(r.getBytes());
                    return input;
                }
                //协议头
                @Override
                public HttpHeaders getHeaders() { 
                    //Content-Type:application/json
                    HttpHeaders headers = new HttpHeaders();
                    headers.setContentType(MediaType.APPLICATION_JSON);
                    return headers;
                }
            };
        }
    }

**（2）OrderServiceFallback订单降级**

package cn.tedu.sp11.fallback;
    
    import cn.tedu.web.util.JsonResult;
    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.IOException;
    import java.io.InputStream;
    
    @Slf4j
    @Component
    public class OrderFallback implements FallbackProvider { 
        @Override
        public String getRoute() { 
            return "order-service";
            //return null;
        }
    
        @Override
        public ClientHttpResponse fallbackResponse(String route, Throwable cause) { 
            return response();
        }
    
        private ClientHttpResponse response() { 
            return new ClientHttpResponse() { 
                @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 { 
                    log.info("fallback body");
                    String s = JsonResult.err().msg("后台服务错误").toString();
                    return new ByteArrayInputStream(s.getBytes("UTF-8"));
                }
    
                @Override
                public HttpHeaders getHeaders() { 
                    HttpHeaders headers = new HttpHeaders();
                    headers.setContentType(MediaType.APPLICATION_JSON);
                    return headers;
                }
            };
        }
    }

## 3.4 降低 hystrix 超时时间，以便测试降级 ##

为了方便测试，把 hystrix 超时时间改小：

hystrix:
      command:
        default:
          execution:
            isolation:
              thread:
                timeoutInMilliseconds: 500

## 3.5 重新启动服务，测试 ##

[http://localhost:7001/item-service/35][http_localhost_7001_item-service_35]

# 四、zuul + hystrix 数据监控 #

## 4.1 暴露 hystrix.stream 监控端点 ##

*  zuul 已经包含 actuator 依赖

management:
      endpoints:
        web:
          exposure:
            include: hystrix.stream

*  启动服务,查看暴露的监控端点  
    [http://localhost:7001/actuator][http_localhost_7001_actuator]  
    [http://localhost:7001/actuator/hystrix.stream][http_localhost_7001_actuator_hystrix.stream]

## 4.2 zuul + turbine 聚合监控 ##

修改10项目，聚合zuul的监控数据

修改 turbine 项目，聚合 zuul 服务实例

spring:
      application:
        name: turbine
        
    server:
      port: 6001
      
    eureka:
      client:
        service-url:
          defaultZone: http://eureka1:2001/eureka, http://eureka2:2002/eureka
          
    turbine:
      app-config: order-service, zuul
      cluster-name-expression: new String("default")

![在这里插入图片描述][20200810182348974.png]  
使用hystrix仪表盘, 对 turbine 监控端点进行监控, 此端点聚合了订单服务和zull网关服务的监控数据

*  [http://localhost:6001/turbine.stream][http_localhost_6001_turbine.stream]

## 4.3 访问测试 ##

填入 zuul 的监控端点路径，开启监控

*  [http://localhost:4001/hystrix][http_localhost_4001_hystrix]

填入监控端点：

*  [http://localhost:7001/actuator/hystrix.tream][http_localhost_7001_actuator_hystrix.tream]
 *  [http://localhost:6001/turbine.stream][http_localhost_6001_turbine.stream]

必须通过zuul网关访问后台服务才会长生监控数据

*  [http://localhost:7001/item-service/35][http_localhost_7001_item-service_35]
 *  `http://localhost:7001/item-service/decreaseNumber`  
    使用postman，POST发送以下格式数据：  
    `[{"id":1, "name":"abc", "number":23},{"id":2, "name":"def", "number":11}]`
 *  [http://localhost:7001/user-service/7][http_localhost_7001_user-service_7]
 *  [http://localhost:7001/user-service/7/score?score=100][http_localhost_7001_user-service_7_score_score_100]
 *  [http://localhost:7001/order-service/123abc][http_localhost_7001_order-service_123abc]
 *  [http://localhost:7001/order-service/][http_localhost_7001_order-service]

## 4.4 熔断测试 ##

ab -n 20000 -c 50 http://localhost:3001/order-service/123abc

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 4]

# 五、Zuul 和 Feign #

都可以调用后台服务，都可以集成ribbon、hystrix

Feign

*  部署在微服务内部，服务和服务之间调用
 *  不推荐使用 hystrix
    
     *  每个 feign 调用位置都启用hystrix，会造成混乱
     *  一般是在最前面添加断路器，就像入户的电闸
     *  有特殊需求，可以启用hystrix

Zuul

*  部署在最前面，作为入口
 *  不推荐使用 ribbon 的重试
    
     *  在最前面进行重试，会造成后台服务压力翻倍增加
     *  重试功能尽量往后加

# 六、zuul Cookie过滤 #

zuul 会过滤敏感 http 协议头，默认过滤以下协议头：

*  Cookie
 *  Set-Cookie
 *  Authorization

可以设置 zuul 不过滤这些协议头（application.yml）

zuul:
      sensitive-headers:

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/452363ee9a18477b89dbf0a15c3d6b1f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221124/a49ca84f1d9844afa7fcef591fcbf62a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70]: /images/20221124/12a1f058ef404f9da5ae7b8ae3c19425.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 1]: /images/20221124/44c353163518417a80af7ec643969f44.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 2]: /images/20221124/cb71a630259841d99cfb5d0a73beae0a.png
[http_eureka1_2001]: http://eureka1:2001
[http_localhost_7001_item-service_35]: http://localhost:7001/item-service/35
[http_localhost_7001_user-service_7]: http://localhost:7001/user-service/7
[http_localhost_7001_user-service_7_score_score_100]: http://localhost:7001/user-service/7/score?score=100
[http_localhost_7001_order-service_123abc]: http://localhost:7001/order-service/123abc
[http_localhost_7001_order-service]: http://localhost:7001/order-service/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 3]: /images/20221124/3dc4df767c7e48458f3c0f553303902b.png
[http_localhost_7001_item-service_35 1]: http:/localhost:7001/item-service/35
[http_localhost_7001_item-service_35_token_1234]: http://localhost:7001/item-service/35?token=1234
[http_localhost_7001_actuator]: http://localhost:7001/actuator
[http_localhost_7001_actuator_hystrix.stream]: http://localhost:7001/actuator/hystrix.stream
[20200810182348974.png]: /images/20221124/ff162fde8cd24d7d97c35c3e6780e594.png
[http_localhost_6001_turbine.stream]: http://localhost:6001/turbine.stream
[http_localhost_4001_hystrix]: http://localhost:4001/hystrix
[http_localhost_7001_actuator_hystrix.tream]: http://localhost:7001/actuator/hystrix.tream
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTgwODgxNDAyNQ_size_16_color_FFFFFF_t_70 4]: /images/20221124/e0698db292cc4e5fbf7d1f394b005b1e.png