【微服务 SpringCloudAlibaba】实用篇 · Gateway服务网关

微服务（8）

微服务（8）

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

1. 为什么需要网关

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

网关的核心功能特性：

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

架构图：

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

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

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

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

• gateway
• zuul

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

2. gateway快速入门

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

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

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

创建服务：

引入依赖：

<!--网关-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

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);
	}
}

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就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

同理，orderservice可以这样配：

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

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

4）重启测试

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

5）网关路由的流程图

整个访问的流程如下：

1. 指定了nacos的地址，所以是知道在哪里拉取服务列表并做负载均衡的
2. 加了路由目标就知道拉取哪些服务，lb代表负载均衡，后面再加上服务名
3. predicate指定了，这里有一种路径断言，例如：Path=/user/**，如果是user开头的路由，就断定是要定向到user-service这个路由，也就是lb://userservice
   • Predicate这个函数式接口就是条件，其实断言就是条件啦，满足某个条件就可以定向
   • Path就必须有，否则压根就不知道什么路由可以定向到哪些服务

总结：

网关搭建步骤：

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

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

路由配置包括：

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

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

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

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

接下来，就重点来学习路由断言和路由过滤器的详细知识

3. 断言工厂

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

例如Path=/user/**是按照路径匹配，这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

Spring Cloud Gateway

• 这是官网可以去了解一下这些断言工厂

如果路由没有一个满足所有断言条件的route，就会404

例如时间路由断言：

断言：

1. /order开头
2. 指定时区的时间之前发来的请求

满足这两个条件的路由会被定向到指定的route

重启gateway服务后：

反之，如果是这个After，就需要某个时间之后才能访问：

• 这个值的格式一定要严格满足官方提供的要求！
• 例如Path=…，Before=…之类的，不能自定义XX=…，而是只能有官方给的几个断言工程
• 至于=后面的值，例如时间要符合时间格式…

但其实，我们只需要掌握Path这种路由工程就可以了😊~

• 我把刚才多加的predicate条件注释掉了，继续我们后面的学习

注意：通过断言规则可以模拟出类似于拦截的效果，但是不要误解成是对该路由的拦截，而是满足断言规则才会定向到该路由，如果每个route都不满足，那么就404，找不到向谁请求

你可能会觉得单单从Path就可以找到了呀，但是他的机制就是这样的，遵循约定，不必纠结！

4. 过滤器工厂

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

3.4.1.路由过滤器的种类

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

Spring Cloud Gateway

• 官方地址，用到啥学啥_(¦3」∠)_

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! # 添加请求头

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

一样的，过滤器工程XX=…，必须是官方给出的，按照具体的含义，例如这里是增加请求头=a,b

• 也就是添加key为a，value为b的请求头（这是约定，不要跳纠结为啥）

你会发现用代理看请求结构的时候，并没有这个，这个是经过我们的gateway服务才加上去的，所以这里没有，我们可以这样子去检验是否有这个请求头：

访问一下看控制台：

4.3 默认过滤器

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项,是default-filters，不是filters
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

但是你会发现，order访问不了了

不过访问order也会打印：

这代表,向网关发送的请求请求头是带这两个请求头的，但是orderservice向userservice发请求，是不经过网关的，所以没有Name这个请求头~

既然服务a发请求给服务b不需要通过网关，在这里你也可以得到一些结论：

并不是必须访问网关才能访问我们的服务，访问网关可以通过断言规则定向到我们的接口罢了；

如果请求不是通过访问网关定向到对应路由的，那么自然也没有经过过滤器，也就不会进行过滤

例如我加了一个predicate为假的在orderservice对应的“routes.predicates”里

通过访问网关不能定向到对应的接口

但是直接访问接口可以，并且这个接口不需要authorization参数的值，证明GlobalFilter没生效

若是直接访问这个order/101接口，则会因为请求头缺少Truth/Name而报异常，这说明路由过滤器和DefaultFilter都没有生效

4.4 总结

过滤器的作用是什么？

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

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

defaultFilters的作用是什么？

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

5. 全局过滤器

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

5.1 全局过滤器作用

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

配置文件配置的方式，肯定不能完成我们的一些实际上更具体的需求逻辑，这些过滤逻辑需要我们写代码去完善

定义方式是实现GlobalFilter接口。

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

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

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

5.2 自定义全局过滤器

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

• 参数中是否有authorization，

• authorization参数值是否为admin

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

实现：

在gateway中定义一个过滤器：

package cn.itcast.gateway;

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

//@Order(-1)//过滤器有很多，通过这里设置的值来决定哪个过滤器先过滤，值越小，优先级越高！
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1. 获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> queryParams = request.getQueryParams();
        // 2. 获取参数中的某个参数
        String auth = queryParams.getFirst("authorization");
        // 3. 判断参数值是否等于admin，判断是否放行
        if("admin".equals(auth)) {
            // 是
            return chain.filter(exchange);//代表放行
        }
        // 否
//        exchange.getResponse().setStatusCode(HttpStatus.valueOf(401));// 401 restful里代表未登录
        // 设置状态（方便前端你选人用户感知，bug排查...）
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);// 401 restful里代表未登录
        return exchange.getResponse().setComplete();//代表终结（不放行）
    }

    // 实现Ordered的这个方法，获取优先级的时候就可以通过这个方法获取order值（其实注解实现的也是这个逻辑吧）
    @Override
    public int getOrder() {
        return -1;
    }
}

5.3 过滤器执行顺序

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

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

路由过滤器和DefaultFilter，你会发现，他们的值: 过滤器列表其实是同一套东西的（重合）

两种过滤器本质内核是一样的，对应的“同类”过滤器(例如AddRequestHeader过滤器)，路由过滤器和DefaultFilter都由同一个过滤器工厂生成GatewayFilter：

而我们的GlobalFilter则会被框架内的某个适配器适配成GatewayFilter：

• 了解大概的那个意思就行，看不懂代码无所谓

排序的规则是什么呢？

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增（配置中不同的过滤器配置分开计数）。

当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。，两个GF的order相同的话，前后随机

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

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

重启后访问一下：

加上querystring：（?authorization=admin）

6. 跨域问题

6.1 什么是跨域问题

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

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

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

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

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

6.2 模拟跨域问题

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <meta http-equiv="X-UA-Compatible" content="ie=edge" />
        <title>Document</title>
    </head>
    <body>
        <h1>Test</h1>
    </body>
    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
    <script>
        axios
            .get("http://localhost:10010/user/1?authorization=admin")
            .then((resp) => console.log(resp.data))
            .catch((err) => console.log(err));
    </script>
</html>

VSCode打开，下载Live Server插件，点击VSCode右下角的Go Live，我分配的端口是5500，在浏览器访问一下：

可以在浏览器控制台看到下面的错误：

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

6.3 解决跨域问题

这个需要放行的是http://localhost:5500，我们必须分毫不差地放行“http://localhost:5500”，而不是这些：

1. 127.0.0.1:5500
2. localhost:5500
3. http://127.0.0.1:5500

跨域检查是强区分这些的~

还有，如果80端口发出的跨域请求，那么应该是http://localhost，而不是http://localhost:80，等等…

• 反正就是报错要我们放行什么就放行什么，不是放行什么“等价”的地址

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

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 每次跨域检测，发的就是options请求，这里解决的是options请求被拦截问题，默认是false
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:5500"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期，如果检验通过，浏览器会缓存了这次跨域检验，这段时间对该网关的跨域请求将会被直接放行

跨域问题解决😊：

文章到此结束！谢谢观看
可以叫我 小马，我可能写的不好或者有错误，但是一起加油鸭🦆！

代码：云服务: 云服务相关代码 (gitee.com)文章来源地址https://www.toymoban.com/news/detail-789002.html

到了这里，关于【微服务 SpringCloudAlibaba】实用篇 · Gateway服务网关的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！