03-25Spring Cloud 入门 之 Zuul 篇（五）

一、前言

随着业务的扩展，微服务会不对增加，相应的其对外开放的 API 接口也势必增多，这不利于前端的调用以及不同场景下数据的返回，因此，我们通常都需要设计一个 API 网关作为一个统一的 API 入口，来组合一个或多个内部 API。

二、简单介绍

# 2.1 API 网关使用场景

1. 黑白名单： 实现通过 IP 地址控制请求的访问
2. 日志：实现访问日志的记录，进而实现日志分析，处理性能指标等
3. 协议适配：实现通信协议的校验、适配转换的功能
4. 身份认证：对请求进行身份认证
5. 计流限流：可以设计限流规则，记录访问流量
6. 路由：将请求进行内部（服务）转发

# 2.2 API 网关的实现

业界常用的 API 网关有很多方式，如：Spring Cloud Zuul、 Nginx、Tyk、Kong。本篇介绍的对象正是 Spring Cloud Zuul 。

Zuul 是 Netflix 公司开源的一个 API 网关组件，提供了认证、鉴权、限流、动态路由、监控、弹性、安全、负载均衡、协助单点压测等边缘服务的框架。

Spring Cloud Zuul 是基于 Netflix Zuul 的微服务路由和过滤器的解决方案，也用于实现 API 网关。其中，路由功能负责将外部请求转发到具体的微服务实例上，是实现外部访问统一入门的基础。而过滤功能是负责对请求的处理过程进行干预，是实现请求校验、服务聚合等功能的基础。

Spring Cloud Zuul 和 Eureka 进行整合时，Zuul 将自身注册到 Eureka 服务中，同时从 Eureka 中获取其他微服务信息，以便请求可以准确的通过 Zuul 转发到具体微服务上。

三、实战演练

本次测试案例基于之前发表的文章中介绍的案例进行演示，不清楚的读者请先转移至 《Spring Cloud 入门 之 Hystrix 篇（四）》 进行浏览。

当前的项目列表如下：

创建一个为名 gateway-server 的 Spring Boot 项目。

# 3.1 添加依赖

1. <!-- eureka 客户端 -->
2. <dependency>
3. <groupId>org.springframework.cloud</groupId>
4. <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
5. </dependency>
6. <!-- zuul 网关 -->
7. <dependency>
8. <groupId>org.springframework.cloud</groupId>
9. <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
10. </dependency>

# 3.2 配置文件

1. server:
2. port: 9600
3. spring:
4. application:
5. name: gateway
6. eureka:
7. instance:
8. instance-id: gateway-9600
9. prefer-ip-address: true
10. client:
11. service-url:
12. defaultZone: http://localhost:9000/eureka/ # 注册中心访问地址

# 3.3 启动 Zuul

在启动类上添加 @EnableZuulProxy 注解：

1. @EnableZuulProxy
2. @SpringBootApplication
3. public class GatewayApplication {
4. public static void main(String[] args) {
5. SpringApplication.run(GatewayApplication.class, args);

启动上边的所有项目，打开 Postman 请求订单下单接口，如下图：

图中，我们首先不经过网关直接访问 order-server 项目请求地址： http://localhost:8100/order/place

之后再修改成访问 gateway-server 项目的请求地址： http://localhost:9600/order/order/place

最终，响应结果都一样。

提示： http://localhost:9600/order/order/place 中第一个 order 表示的是注册在 Eureka 上的订单服务名称。

# 3.4 zuul 常用配置

修改路由：

1. zuul:
2. sensitive-headers: # 全局忽略敏感头，即允许接收 cookie 等请求头信息
3. routes:
4. extlight: # 任意名字，保证唯一即可
5. path: /extlight/** # 自定义，真正用到的请求地址
6. service-id: ORDER # 路由到的目标服务名称

将订单服务的路由名称改成 extlight。

使用 Postman 请求下单接口，运行结果：

请求成功。

禁用路由：

1. zuul:
2. ignored-patterns:
3. - /order/order/**

http://localhost:9600/order/order/place 无法被正常路由到订单服务，响应返回 404。

路由加前缀：

1. zuul:
2. prefix: /api

所有请求中的 path 需要添加 api 前缀。如: http://localhost:9600/extlight/order/place 需要改成 http://localhost:9600/api/extlight/order/place 。

设置敏感头：

1. zuul:
2. sensitive-headers: # 设置全局敏感头，如果为空，表示接收所有敏感头信息

或

1. zuul:
2. routes:
3. extlight: # 任意名字，保证唯一即可
4. path: /extlight/** # 自定义，真正用到的请求地址
5. service-id: ORDER # 路由到的目标服务名称
6. sensitive-headers: # 针对 /extlight/ 的请求设置敏感头信息

四、Zuul 自定义过滤器

Zuul 的核心技术就是过滤器，该框架提供了 ZuulFilter 接口让开发者可以自定义过滤规则。

我们以身份检验为例，自定义 ZuulFilter 过滤器实现该功能。

# 4.1 创建用户服务

新建名为 user-server 的项目。

添加依赖：

1. <!-- common api -->
2. <dependency>
3. <groupId>com.extlight.springcloud</groupId>
4. <artifactId>common-api</artifactId>
5. <version>${parent-version}</version>
6. </dependency>
7. <!-- springmvc -->
8. <dependency>
9. <groupId>org.springframework.boot</groupId>
10. <artifactId>spring-boot-starter-web</artifactId>
11. </dependency>
12. <!-- eureka 客户端 -->
13. <dependency>
14. <groupId>org.springframework.cloud</groupId>
15. <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
16. </dependency>

application.yml：

1. server:
2. port: 8200
3. spring:
4. application:
5. name: USER
6. eureka:
7. instance:
8. instance-id: user-api-8200
9. prefer-ip-address: true # 访问路径可以显示 IP
10. client:
11. service-url:
12. defaultZone: http://localhost:9000/eureka/ # 注册中心访问地址

登录接口：

1. @RestController
2. @RequestMapping("/user")
3. public class LoginController {
4. @PostMapping("/login")
5. public Result login(String username, String password, HttpServletResponse response) {
6. if ("admin".equals(username) && "admin".equals(password)) {
7. // 模拟生成 token，实际开发中 token 应存放在数据库或缓存中
8. String token = "123456";
9. Cookie cookie = new Cookie("token", token);
10. cookie.setPath("/");
11. cookie.setMaxAge(60 * 10);
12. response.addCookie(cookie);
13. return Result.success();
14. return Result.fail(401, "账号或密码错误");

user-server 启动类：

1. @EnableEurekaClient
2. @SpringBootApplication
3. public class UserServerApplication {
4. public static void main(String[] args) {
5. SpringApplication.run(UserServerApplication.class, args);

# 4.2 创建 ZuulFilter 过滤器

在 gateway-server 项目中，新建一个过滤器，需要继承 ZuulFilter 类 ：

1. @Component
2. public class AuthenticationFilter extends ZuulFilter {
3. /**
4. * 是否开启过滤
5. */
6. @Override
7. public boolean shouldFilter() {
8. RequestContext context = RequestContext.getCurrentContext();
9. HttpServletRequest request = context.getRequest();
10. boolean flag = request.getRequestURI().contains("/login");
11. // 如果是登录请求不进行过滤
12. if (flag) {
13. System.out.println("========不执行 zuul 过滤方法=======");
14. } else {
15. System.out.println("========执行 zuul 过滤方法=======");
16. return !flag;
17. /**
18. * 过滤器执行内容
19. */
20. @Override
21. public Object run() throws ZuulException {
22. RequestContext context = RequestContext.getCurrentContext();
23. HttpServletRequest request = context.getRequest();
24. String token = request.getParameter("token");
25. // 此处模拟获取数据库或缓存中的 token
26. String dbToken = "123456";
27. // 此处简单检验 token
28. if (token == null || "".equals(token) || !dbToken.equals(token)) {
29. context.setSendZuulResponse(false);
30. context.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
31. return null;
32. /**
33. * 过滤器类型
34. */
35. @Override
36. public String filterType() {
37. return "pre";
38. /**
39. * 过滤器执行顺序
40. */
41. @Override
42. public int filterOrder() {
43. return 0;

其中，filterType 有 4 种类型：

1. pre： 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
2. routing：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用 Apache HttpClient 或 Netfilx Ribbon 请求微服务。
3. post：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
4. error：在其他阶段发生错误时执行该过滤器。

其过滤顺序如下图：

# 4.3 测试过滤器

运行所有项目，测试操作步骤如下：

1. 请求用户服务的登录接口(http://localhost:9600/user/user/login)，请求不执行 zuul 过滤方法，并且请求响应返回的 cookie 包含 token
2. 请求订单服务的下单接口(http://localhost:9600/extlight/order/place)，但不携带 token，请求需要执行 zuul 过滤方法，请求响应 401 权限不足
3. 请求订单服务的下单接口(http://localhost:9600/extlight/order/place)，携带之前登录接口返回的 token，请求需要执行 zuul 过滤方法，校验通过后路由到订单服务执行之后的操作

测试效果图如下：

五、案例源码

Zuul demo 源码

六、参考资料

Announcing Zuul: Edge Service in the Cloud