Spring Cloud 入门 ---- Zuul 路由网关【随笔】

Spring Cloud 入门 ---- Zuul 路由网关

简介

Spring Cloud Zuul 是 Spring Cloud Netflix 子项目的核心组件之一，可以作为微服务架构中的 API 网关使用，支持动态路由与过滤功能。API 网关为微服务架构中的服务提供了统一的访问入口，客户端通过 API 网关访问相关服务。API 网关的定义类似于设计模式中的门面模式，它相当于整个微服务架构中的门面，所有客户端访问都通过它来进行路由及过滤。它实现了请求路由、负载均衡、校验过滤、服务容错、服务聚合等功能。

官网：https://github.com/Netflix/zuul/wiki

Spring Cloud Netflix Zuul：https://docs.spring.io/spring-cloud-netflix/docs/2.2.5.RELEASE/reference/html/#router-and-filter-zuul

创建演示项目

为了避免创建太多重复的服务，我们沿用之前的 eureka-registry-center 注册中心集群，hystrix-provider-service 服务提供者集群，hystrix-consumer-service 服务消费者。

导入 pom 依赖

  <!--zuul-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>

添加 yml 配置

server:
  port: 6070

spring:
  application:
    name: routing-zuul-servie

eureka-connection:
  name: akieay
  password: 1qaz2wsx
eureka:
  client:
    #表示是否将自己注册进 Eureka Server服务 默认为true
    register-with-eureka: true
    #f是否从Eureka Server抓取已有的注册信息，默认是true。单点无所谓，集群必需设置为true才能配合ribbon使用负载均衡
    fetch-registry: true
    service-url: # 设置与 Eureka Server 交互的地址 查询服务与注册服务都需要这个地址
      #      defaultZone: http://localhost:7001/eureka
      defaultZone: http://${eureka-connection.name}:${eureka-connection.password}@eureka7001.com:7001/eureka,http://${eureka-connection.name}:${eureka-connection.password}@eureka7002.com:7002/eureka
  instance:
    instance-id: routing-zuul-6070
    ## 当调用getHostname获取实例的hostname时，返回ip而不是host名
    prefer-ip-address: true
    # Eureka客户端向服务端发送心跳的时间间隔，单位秒（默认30秒）
    lease-renewal-interval-in-seconds: 10
    # Eureka服务端在收到最后一次心跳后的等待时间上限，单位秒（默认90秒）
    lease-expiration-duration-in-seconds: 30

主启动

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ZuulApplication {

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

依次启动 注册中心，服务提供者集器，服务消费者，Zuul 网关服务，访问注册中心查看服务注册情况。

至此基础演示模块创建完成，接下来我们将演示 zuul 常用功能的使用案例。

Zuul 的基本功能

默认路由规则

Zuul 和 Eureka 结合使用，可以实现路由的自动配置，自动配置的路由以服务名称为匹配路径，相当于如下配置：

# 默认路由规则
zuul:
  routes:
    # 给服务配置路由
    HYSTRIX-PROVIDER-SERVICE:
      path: /hystrix-provider-service/**
    HYSTRIX-CONSUMER-SERVICE:
      path: /hystrix-consumer-service/**

如访问：http://localhost:6070/hystrix-provider-service/payment/hystrix/ok/16 与 http://localhost:6070/hystrix-consumer-service/consumer/payment/circuitBreaker/5 就相当于访问：http://localhost:8016/payment/hystrix/ok/16 与 http://localhost/consumer/payment/circuitBreaker/5 只不过服务提供者有两个节点。

若是不想使用默认的路由规则，可以添加以下的配置来关闭默认路由配置。

zuul:
  #关闭指定服务的默认路由配置
  ignored-services: hystrix-provider-service,hystrix-consumer-service
或
zuul:
  #关闭所有默认路由配置
  ignoredServices: '*'

配置路由规则

我们可以通过 yml 指定路由的配置规则，如下面我们将 /hps/** 的路由匹配到 HYSTRIX-PROVIDER-SERVICE 服务，将 /hcs//** 的路由匹配到 HYSTRIX-CONSUMER-SERVICE 服务。

zuul:
  routes:
    # 给服务配置路由
    HYSTRIX-PROVIDER-SERVICE:
      # 匹配路径
      path: /hps/**
    HYSTRIX-CONSUMER-SERVICE:
      path: /hcs/**

配置完成后重启服务，访问：http://localhost:6070/hps/payment/hystrix/ok/16 与 http://localhost:6070/hcs/consumer/payment/circuitBreaker/5，就相当于访问：http://localhost:8016/payment/hystrix/ok/16 与 http://localhost/consumer/payment/circuitBreaker/5 与上面的差不多，只不过访问路径中的 服务别名 替换成了我们 自定义路径。

查看路由信息

我们可以通过 Spring Boot Actuator 来查看 Zuul 中的路由信息。导入 pom 依赖

 <!--监控管理-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

修改 yml 暴露监控端点

# 暴露监控端点
management:
  endpoints:
    web:
      exposure:
        include: 'routes'

重启服务，并访问：http://localhost:6070/actuator/routes 查看路由简略信息。

访问：http://localhost:6070/actuator/routes/details 可查看路由详细信息。

负载均衡功能

多次调用 http://localhost:6070/hps/payment/hystrix/ok/16 可以发现，默认采用的是 轮询 的负载均衡策略轮流调用 8015 与 8016 服务提供者的服务。

配置访问前缀

与 gateway 一样 zuul 也可以给网关添加访问前缀，如下面我添加了 /proxy 前缀，这时所有的请求都需要把/proxy 添加在路径最前面，如：http://localhost:6070/proxy/hps/payment/hystrix/ok/16

zuul:
  #给网关路由添加前缀
  prefix: /proxy

Header 过滤及重定向添加 Host

Zuul 在请求路由时，默认会过滤掉一些敏感的请求头信息，以下配置可以防止路由时的Cookie及Authorization的丢失：

zuul:
  #配置过滤敏感的请求头信息，设置为空就不会过滤
  sensitive-headers: Cookie,Set-Cookie,Authorization 
或
zuul: 
  #配置忽略的请求头信息
  ignoredHeaders: Authorization

Zuul在请求路由时，不会设置最初的host头信息，以下配置可以解决：

zuul:
  #设置为true重定向是会添加host请求头
  add-host-header: true 

Zuul 常用的 Filter

Zuul的中心是一系列过滤器，它们能够在HTTP请求和响应的路由过程中执行一系列动作。Zuul 提供了一个框架来动态地读取、编译和运行这些过滤器。过滤器彼此之间并不直接通信——相反，它们通过每个请求唯一的 RequestContext 共享状态。虽然 Zuul 支持任何基于 jvm 的语言，但过滤器目前是用 Groovy 编写的。每个过滤器的源代码被写入到 Zuul 服务器上的一组指定目录中，这些目录定期轮询更改。更新后的过滤器从磁盘读取，动态编译到正在运行的服务器，Zuul 对每个后续请求调用过滤器。

官网：https://docs.spring.io/spring-cloud-netflix/docs/2.2.5.RELEASE/reference/html/#enablezuulproxy-vs-enablezuulserver

Zuul Filter 的主要特点

• Type：类型，通常定义在路由流中应用筛选器的阶段(尽管它可以是任何自定义字符串)；
• Execution Order：执行顺序:应用于类型中，定义跨多个过滤器的执行顺序；
• Criteria：标准，执行过滤器所需的条件；
• Action：动作，满足条件时要执行的动作。

过滤器的分类

• pre：在请求被路由到目标服务前执行，示例包括请求身份验证、选择原始服务器和记录调试信息；
• routing：在请求被路由到目标服务时执行，这是使用 Apache HttpClient 或 Netflix Ribbon 构建和发送原始 HTTP 请求的地方；
• post：在请求被路由到目标服务后执行，比如给目标服务的响应添加头信息，收集统计数据等功能；
• error：当在其他阶段发生错误时，执行错误过滤器。

Zuul 请求的生命周期

下图描述了 Zuul 请求的生命周期，如图所知当请求进入后，进入 “pre” 前置过滤器的调用链，按顺序调用所有的前置过滤器处理请求，然后进入"routing" 过滤器会在请求发送到目标服务的前后对请求/响应进行处理，最后执行的是 “post” 后置过滤器会按顺序对响应进入处理。

核心过滤器

过滤器名称	过滤类型	优先级	过滤器的作用
ServletDetectionFilter	pre	-3	检测当前请求是通过DispatcherServlet处理运行的还是ZuulServlet运行处理的。
Servlet30WrapperFilter	pre	-2	对原始的HttpServletRequest进行包装。
FormBodyWrapperFilter	pre	-1	将Content-Type为application/x-www-form-urlencoded或multipart/form-data的请求包装成FormBodyRequestWrapper对象。
DebugFilter	route	1	根据zuul.debug.request的配置来决定是否打印debug日志。
PreDecorationFilter	route	5	对当前请求进行预处理以便执行后续操作。
RibbonRoutingFilter	route	10	通过Ribbon和Hystrix来向服务实例发起请求，并将请求结果进行返回。
SimpleHostRoutingFilter	route	100	只对请求上下文中有routeHost参数的进行处理，直接使用HttpClient向routeHost对应的物理地址进行转发。
SendForwardFilter	route	500	只对请求上下文中有forward.to参数的进行处理，进行本地跳转。
SendErrorFilter	post	0	当其他过滤器内部发生异常时的会由它来进行处理，产生错误响应。
SendResponseFilter	post	1000	利用请求上下文的响应信息来组织请求成功的响应内容。

自定义过滤器

自定义一个前置过滤器，主要用来打印请求信息，该过滤器会在请求被路由到服务之前执行。

@Component
@Slf4j
public class CustomPreFilter extends ZuulFilter {

    /**
     * 过滤器类型：pre、routing、post、error
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 当前过滤器的执行顺序，数值越小优先级越高
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 是否进行过滤
     * @return true：进行过滤，false：不进行
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 自定义的过滤器逻辑，当 shouldFilter() 返回 true 时，会执行
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        String remoteHost = request.getRemoteHost();
        String method = request.getMethod();
        String requestURI = request.getRequestURI();
        StringBuffer requestURL = request.getRequestURL();
        log.info("remoteHost: " + remoteHost + " method: " + method + " requestURI: " + requestURI + " requestURL: " + requestURL);
        return null;
    }
}

访问：http://localhost:6070/proxy/hps/payment/hystrix/ok/16，即可看到控制台打印了该请求的信息。

remoteHost: 0:0:0:0:0:0:0:1 method: GET requestURI: /proxy/hps/payment/hystrix/ok/16 requestURL: http://localhost:6070/proxy/hps/payment/hystrix/ok/16

禁用过滤器

我们可以通过以下配置来禁用过滤器，格式：zuul.<SimpleClassName>.<filterType>.disable=true。

zuul:
  CustomPreFilter:
    pre:
      disable: true 

Zuul 对 Ribbon 和 Hystrix 的支持

Zuul 自动集成了 Ribbon 和 Hystrix ，所以 Zuul 天生就带有负载均衡和服务熔断的功能，我们可以通过修改 yml 来配置这些功能；如下面配置的 HystrixCommand 的执行超时 与 ribbon 的请求超时以及负载均衡策略随机策略。

hystrix:
  command: #用于控制HystrixCommand的行为
    default:
      execution:
        isolation:
          strategy: THREAD #控制HystrixCommand的隔离策略，THREAD->线程池隔离策略(默认)，SEMAPHORE->信号量隔离策略
          thread:
            timeoutInMilliseconds: 5000 #配置HystrixCommand执行的超时时间，执行超过该时间会进行服务降级处理

HYSTRIX-PROVIDER-SERVICE:
  ribbon:
    ConnectTimeout: 1000 #服务请求连接超时时间（毫秒）
    ReadTimeout: 3000 #服务请求处理超时时间（毫秒）
    OkToRetryOnAllOperations: true #对超时请求启用重试机制
    MaxAutoRetriesNextServer: 1 #切换重试实例的最大个数
    MaxAutoRetries: 1 # 切换实例后重试最大次数
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule #修改负载均衡算法

常用配置

以下列出了部分常用配置，更多请参考官网：https://docs.spring.io/spring-cloud-netflix/docs/2.2.5.RELEASE/reference/html/#router-and-filter-zuul

zuul:
  #关闭默认路由配置
  ignored-services: '*'
  #给网关路由添加前缀
  prefix: /proxy
  #配置过滤敏感的请求头信息，默认不会过滤
  sensitive-headers: Cookie,Set-Cookie,Authorization
  add-host-header: true #设置为true重定向是会添加host请求头
  retryable: true # 关闭重试机制
  routes:
    HYSTRIX-PROVIDER-SERVICE:
      path: /hps/**
    HYSTRIX-CONSUMER-SERVICE:
      path: /hcs/**
  # 控制过滤器是否启用
  CustomPreFilter:
    pre:
      disable: true