path: /userService/**

feign-service:

path: /feignService/**

访问http://localhost:8801/userService/user/1可以发现请求路由到了 user-service 上了；

访问http://localhost:8801/feignService/user/1可以发现请求路由到了 feign-service 上了。

默认路由规则

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

默认路由规则

zuul:

routes:

给服务配置路由

user-service:

path: /user-service/**

feign-service:

path: /feign-service/**

访问http://localhost:8801/user-service/user/1同样可以路由到了 user-service 上了；

访问http://localhost:8801/feign-service/user/1同样可以路由到了 feign-service 上了。

如果不想使用默认的路由规则，可以添加以下配置来忽略默认路由配置：

zuul:

#关闭默认路由配置

ignored-services: user-service,feign-service

负载均衡功能

多次调用http://localhost:8801/user-service/user/1进行测试，可以发现运行在 8201 和 8202 的 user-service 服务交替打印如下信息。

2019-12-27 21:31:33.240 INFO 13164 --- [nio-8202-exec-1] c.j.s.controller.UserController : 根据 id 获取用户信息，用户名称为：jourwon

2019-12-27 21:31:43.262 INFO 13164 --- [nio-8202-exec-2] c.j.s.controller.UserController : 根据 id 获取用户信息，用户名称为：jourwon

配置访问前缀

我们可以通过以下配置来给网关路径添加前缀，此处添加了/proxy 前缀，这样我们需要访问http://localhost:8801/proxy/user-service/user/1才能访问到 user-service 中的接口。

zuul:

#给网关路由添加前缀

prefix: /proxy

Header 过滤及重定向添加 Host

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

zuul:

#配置过滤敏感的请求头信息，设置为空就不会过滤

sensitive-headers: Cookie,Set-Cookie,Authorization

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

zuul:

#设置为 true 重定向是会添加 host 请求头

add-host-header: true

查看路由信息

我们可以通过 SpringBoot Actuator 来查看 Zuul 中的路由信息。

在 pom.xml 中添加相关依赖：

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-actuator</artifactId>

</dependency>

修改 application.yaml 配置文件，开启查看路由的端点：

management:

endpoints:

web:

exposure:

include: 'routes'

通过访问http://localhost:8801/actuator/routes查看简单路由信息：

通过访问http://localhost:8801/actuator/routes/details查看详细路由信息：

过滤器

路由与过滤是 Zuul 的两大核心功能，路由功能负责将外部请求转发到具体的服务实例上去，是实现统一访问入口的基础，过滤功能负责对请求过程进行额外的处理，是请求校验过滤及服务聚合的基础。

过滤器类型

Zuul 中有以下几种典型的过滤器类型。

• pre：在请求被路由到目标服务前执行，比如权限校验、打印日志等功能；

• routing：在请求被路由到目标服务时执行，这是使用 Apache HttpClient 或 Netflix Ribbon 构建和发送原始 HTTP 请求的地方；

• post：在请求被路由到目标服务后执行，比如给目标服务的响应添加头信息，收集统计数据等功能；

• error：请求在其他阶段发生错误时执行。

过滤器的生命周期

下图描述了一个 HTTP 请求到达 API 网关后，如何在各种不同类型的过滤器中流转的过程。

自定义过滤器

接下来我们自定义一个过滤器来演示下过滤器的作用。

添加 PreLogFilter 类继承 ZuulFilter

这是一个前置过滤器，用于在请求路由到目标服务前打印请求日志。

@Component

public class PreLogFilter extends ZuulFilter {

private static final Logger LOGGER = LoggerFactory.getLogger(PreLogFilter.class);

/**

• 过滤器类型，有 pre、routing、post、error 四种。

*/

@Override

public String filterType() {

return "pre";

}

/**

• 过滤器执行顺序，数值越小优先级越高。

*/

@Override

public int filterOrder() {

return 0;

}

/**

• 是否进行过滤，返回 true 会执行过滤。

*/

@Override

public boolean shouldFilter() {

return true;

}

/**

• 自定义的过滤器逻辑，当 shouldFilter()返回 true 时会执行。

*/

@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();

LOGGER.info("Remote host:{},method:{},uri:{}", remoteHost, method, requestURI);

return null;

}

}

过滤器功能演示

添加过滤器后，我们访问http://localhost:8801/user-service/user/1测试下，会打印如下日志。

2019-12-27 21:45:43.445 INFO 15116 --- [nio-8801-exec-4] c.j.springcloud.filter.PreLogFilter : Remote host:0:0:0:0:0:0:0:1,method:GET,uri:/proxy/user-service/user/1

核心过滤器

| 过滤器名称 | 过滤类型 | 优先级 | 过滤器的作用 |

| :-- | :-- | :-- | :-- |

| 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 | 利用请求上下文的响应信息来组织请求成功的响应内容。 |

禁用过滤器

我们可以对过滤器进行禁用的配置，配置格式如下：

zuul:

filterClassName:

filter:

disable: true

以下是禁用 PreLogFilter 的示例配置：

zuul:

PreLogFilter:

pre:

disable: true

Ribbon 和 Hystrix 的支持

由于 Zuul 自动集成了 Ribbon 和 Hystrix，所以 Zuul 天生就有负载均衡和服务容错能力，我们可以通过 Ribbon 和 Hystrix 的配置来配置 Zuul 中的相应功能。

可以使用 Hystrix 的配置来设置路由转发时 HystrixCommand 的执行超时时间：

hystrix:

用于控制 HystrixCommand 的行为

command:

default:

execution:

isolation:

thread:

配置 HystrixCommand 执行的超时时间，执行超过该时间会进行服务降级处理

timeoutInMilliseconds: 1000

可以使用 Ribbon 的配置来设置路由转发时请求连接及处理的超时时间：

ribbon:

服务请求连接超时时间（毫秒）

ConnectTimeout: 1000

服务请求处理超时时间（毫秒）

ReadTimeout: 3000

常用配置