---

---

八、Gateway 服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

8.1 为什么需要网关

Gateway网关是我们服务的守门神，所有微服务的统一入口

网关的核心功能特性：

• 请求路由
• 权限控制
• 限流

架构图：

权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

---

在SpringCloud中网关的实现包括两种：

• gateway
• zuul

Zuul是基于Servlet的实现，属于阻塞式编程。而Spring Cloud Gateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

返回顶部

---

8.2 Gateway快速入门

下面，我们就演示下网关的基本路由功能。基本步骤如下：

1. 创建SpringBoot工程gateway，引入网关依赖
2. 编写启动类
3. 编写基础配置和路由规则
4. 启动网关服务进行测试

1）创建gateway服务，引入依赖

创建服务：

引入依赖：

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-gatewayartifactId>
dependency>

<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>
1
2
3
4
5
6
7
8
9
10

---

2）编写启动类

package cn.itcast.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class GatewayApplication {

	public static void main(String[] args) {
		SpringApplication.run(GatewayApplication.class, args);
	}
}
1
2
3
4
5
6
7
8
9
10
11
12

---

3）编写基础配置和路由规则

创建application.yml文件，内容如下：

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡 (loadBalance)，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

本例中，我们将 /user/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

---

4）重启测试

重启网关，访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://userservice/user/1，得到了结果：

可以看到我们只是配置了网关的服务，在模块gateway中并没有多余的服务，也就是说通过网关我们将请求路由到了具体的微服务上面。

---

5）网关路由的流程图

整个访问的流程如下：

总结

网关搭建步骤：

1. 创建项目，引入nacos服务发现和gateway依赖

2. 配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

1. 路由id：路由的唯一标识

2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

3. 路由断言（predicates）：判断路由的规则，

4. 路由过滤器（filters）：对请求或响应做处理

返回顶部

---

8.3 断言工厂

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件

例如Path=/user/是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

当我们指定断言时间在2031年之后才有效，此时访问不到信息：

当我们指定断言时间在2031年之前才有效，此时可以访问到信息：

返回顶部

---

8.4 过滤器工厂

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：

8.4.1 路由过滤器的种类

Spring提供了31种不同的路由过滤器工厂。例如：

返回顶部

---

8.4.2 请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

spring:
  cloud:
    gateway:
      routes:
        - id: user-service 
         uri: lb://userservice 
         predicates: 
           - Path=/user/** 
         filters: # 过滤器
           - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
1
2
3
4
5
6
7
8
9
10

当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。

来到我们的userservice中，在UserController中进行改写来获取我们的请求头信息：

/**
 * 路径： /user/110
 *
 * @param id 用户id
 * @return 用户
 */
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id
        , @RequestHeader(value = "Truth", required = false) String truth) {
    System.out.println("truth:" + truth);  // 打印输出请求头信息
    return userService.queryById(id);
}
1
2
3
4
5
6
7
8
9
10
11
12

重新启动服务后，我们发送一个请求，然后检查控制台日志，查看输出的请求头：

返回顶部

---

8.4.3 默认过滤器

如果要对所有的路由都生效，则可以将过滤器工厂写到default下，配置如下：

spring:
  cloud:
    gateway:
      routes:
      	- id: user-service 
         uri: lb://userservice 
         predicates: 
      	   - Path=/user/**
      	- id: order-service 
         uri: lb://orderservice 
         predicates: 
      	   - Path=/order/**   
      default-filters: # 默认过滤项
    	- AddRequestHeader=Truth, 黑马程序 is freaking awesome! 
1
2
3
4
5
6
7
8
9
10
11
12
13
14

同样的我们修改OrderController的内容，如下：

@GetMapping("{orderId}")
public Order queryOrderByUserId(@PathVariable("orderId") Long orderId,
                                @RequestHeader("Truth") String truth) {
    System.out.println("truth:" + truth);
    // 根据id查询订单并返回
    return orderService.queryOrderById(orderId);
}
1
2
3
4
5
6
7

然后重启服务，进行orderservice、userservice的访问：

可以看到，我们一次user访问，输出了结果（乱码），order也输出了结果，但是多了一个truth：null。经过如下图的测试分析，原因很可能在第四步使用Feign远程调用的时候，没有参数truth声明导致的空值：

---

也就是在这里没有声明：@RequestHeader(value = "Truth", required = false) String truth，因为路由都是/user/{id}，所以还会再走UserController的queryById方法输出一次，没有就是null：

这里我们做个测试：修改上图的代码添加truth参数，进行测试。结果真的输出了我们自定义的truth值。

可以看到，当我们全局的配置名和局部具体服务的请求过滤器名称相同时，会使用我们具体到服务的过滤器：

---

8.4.4 总结

一、过滤器的作用是什么？

​ ① 对路由的请求或响应做加工处理，比如添加请求头

​ ② 配置在路由下的过滤器只对当前路由的请求生效

二、defaultFilters的作用是什么？

​ ① 对所有路由都生效的过滤器

返回顶部

---

8.5 全局过滤器

上一节学习的过滤器，网关提供了31种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。

8.5.1 全局过滤器作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口:

public interface GlobalFilter {
    /**
     *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
1
2
3
4
5
6
7
8
9
10

在filter中编写自定义逻辑，可以实现下列功能：

• 登录状态判断
• 权限校验
• 请求限流等

返回顶部

---

8.5.2 自定义全局过滤器

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

• 参数中是否有authorization，

• authorization参数值是否为admin

如果同时满足则放行，否则拦截

实现：在gateway中定义一个过滤器

package cn.itcast.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.获取authorization参数
        String auth = params.getFirst("authorization");
        // 3.校验
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

重启网关服务，我们直接访问是401，当我们添加参数?authorization=admin后，就可以成功访问了：

返回顶部

---

8.5.3 过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：

排序的规则是什么呢？

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。

• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定

• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。

  

• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

详细内容，可以查看源码：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator

• #getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler

• #handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

返回顶部

---

8.6 跨域问题

8.6.1 什么是跨域问题

跨域：域名不一致就是跨域，主要包括

• 域名不同： www.taobao.com 和 www.taobao.org和 www.jd.com 和 miaosha.jd.com

• 域名相同，端口不同：localhost:8080 和 localhost:8081

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CORS，这个以前应该学习过，这里不再赘述了。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html

---

8.6.2 模拟跨域问题

页面文件：

放入tomcat或者nginx这样的web服务器中，启动并访问。可以在浏览器控制台看到下面的错误：

从localhost:8090访问localhost:10010，端口不同，显然是跨域的请求。

返回顶部

---

8.6.3 解决跨域问题

在gateway服务的application.yml文件中，添加下面的配置：

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

配置好后，我们重启gateway服务，进入浏览器刷新一下就可以看到ajax跨域请求的信息了：

返回顶部

---