微服务05_统一网关Gateway

BigTree的学习之路

已于 2022-04-19 20:26:14 修改

阅读量627

点赞数

分类专栏：微服务技术栈文章标签： java springboot

于 2022-03-25 22:25:28 首次发布

本文链接：https://blog.csdn.net/weixin_43989347/article/details/123739957

版权

微服务技术栈专栏收录该内容

28 篇文章 8 订阅

订阅专栏

微服务05_统一网关Gateway

一、为什么需要网关
二、gateway快速入门
三、路由断言工厂Routte Predicate Factory
四、过滤器工厂
五、全局过滤器【自定义处理逻辑】
- - 测试：
  - 过滤器顺序
六、跨域问题
- - 什么是跨域问题

微服务中有许多服务，每个服务都有专属的数据库来完成自己的业务，并且可以在注册中心完成注册和配置管理。
当微服务内部有相互调用关系时，就可以利用feign组件来完成相互调用。
当外部来请求调用时呢？
网关。一切请求先到网关，再到微服务

一、为什么需要网关

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

Gateway 网关是我们服务的守门神，所有微服务的统一入口。一切请求先到网关，再到微服务。

网关的核心功能特性：

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

网关的作用：

对用户请求做身份认证、权限校验。
【目的是让不让请求去访问微服务】
将用户请求路由到微服务，并实现负载均衡。
【如果通过，则告达路径。如果一个服务多个实例，则作负载均衡】
对用户请求做限流
【当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。】

网关技术实现：
在springCloud中网关的实现包括两种：
gateway
zuul
Zuul是基于Servlet的实现，属于阻塞式编程。
而springCloudGateway则是基于spring5提供的WebFlux，属于响应式编程的实现，具备更好的性能。

二、gateway快速入门

网关搭建步骤：
1.创建 SpringBoot 工程 gateway，引入nacos/gateway的依赖
2.配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：
1.路由id：路由的唯一表示
2.路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
3.路由断言（predicates）：判断路由的规则。符合则转发到路由目的地
4.路由过滤器（filters）：对请求或响应做处理（未学习）

在这里插入图片描述

1.创建module，引入依赖

网关是一个独立的服务，因此搭建网关第一件事就是：创建新module，做一个独立的服务。
引入spring-cloudGateway依赖和nacos的服务发现依赖。
SpringCloudGateway会提供网关的各种功能。
nacos服务发现依赖，因为网关本身也是微服务，它也需要把自己注册到nacos服务，或者去nacos拉取服务。

<!--网关-->
<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.添加依赖

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/** # 路径断言，判断路径是否是/usrs开头，如果是负责规则，那么将带入路由地址uri
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

测试：

我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。请求从网关路由到了具体微服务
上面的例子中，我们将 /user/** 开头的请求，代理到 lb://userservice，其中 lb 是负载均衡(LoadBalance)，根据服务名拉取服务列表，实现负载均衡。
重启网关，访问 http://localhost:10010/user/1 时，符合 /user/** 规则，请求转发到 uri：http://userservice/user/1

三、路由断言工厂Routte Predicate Factory

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

PredicateFactory的作用是什么？
路由工厂的作用是：读取用户配置的断言规则，而后进行解析成对应的判断条件。用户请求进来了，进行判断

Path=/user/**是什么含义？对请求路径做判断，只要是user开头就是符合条件。

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

我们只需要掌握Path这种路由工程就可以了。

官方文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

名称	说明	示例
After	是某个时间点后的请求	- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before	是某个时间点之前的请求	- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between	是某两个时间点之前的请求	- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie	请求必须包含某些cookie	- Cookie=chocolate, ch.p
Header	请求必须包含某些header	- Header=X-Request-Id, \d+
Host	请求必须是访问某个host（域名）	- Host=.somehost.org,.anotherhost.org
Method	请求方式必须是指定方式	- Method=GET,POST
Path	请求路径必须符合指定规则	- Path=/red/{segment},/blue/**
Query	请求参数必须包含指定参数	- Query=name, Jack或者- Query=name
RemoteAddr	请求者的ip必须是指定范围	- RemoteAddr=192.168.1.1/24
Weight	权重处理

四、过滤器工厂

GatewayFilter 是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理。
在这里插入图片描述
过滤器的作用：

对路由的请求和相应做加工处理，比如添加请求头
配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？
对所有路由都生效的过滤器

4.1.路由过滤器的种类【只是配置过滤器】

官方文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量

下面我们以 AddRequestHeader 为例：
在这里插入图片描述

添加过滤器

需求：给所有进入 userservice 的请求添加一个请求头：sign=xn2001.com is eternal只需要修改 gateway 服务的 application.yml文件，添加路由过滤即可。

filters:

AddRequestHeader=Truth, bigTree # 添加请求头
上面add…der= key,value 形式。

spring:
  cloud:
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
          filters:
            - AddRequestHeader=sign, xn2001.com is eternal # 添加请求头

如何验证，我们修改 userservice 中的一个接口。
RequestHeader：spring会帮我们自动获取请求头为名：“Truth” ，required=false。意思：不传值也可以。

@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "sign", required = false) String sign) {
    log.warn(sign);
    return userService.queryById(id);
}

重启两个服务，访问：http://localhost:10010/user/1
可以看到控制台打印出了这个请求头。
从而：可以看到user-service看到能拿到请求都了
在这里插入图片描述

默认全局过滤器。

当然，Gateway 也是有全局过滤器的，如果要对所有的路由都生效，则可以将过滤器工厂写到 default-filters 下：
再从重启服务测试时，发现user-service 和order-service都是可以访问到的
在这里插入图片描述

五、全局过滤器【自定义处理逻辑】

上面介绍的过滤器工厂，网关提供了 31 种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。
比如说：该请求的身份是什么。有无权限。

全局过滤器的作用：对所有路由都生效的过滤器，并且可以自定义处理逻辑

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

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

参数中是否有 authorization权限
authorization 参数值是否为 admin

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

exchange：请求上下文。请求进入网关开始，一直到结束为止。整个流程中都可以共享exchange对象。可以拿到请求、相应相关的信息，以及可以存取东西。
chain：过滤器链。用来把请求委托给下一个过滤器。用于放行：调用过滤器链往后走。
返回值：返回表示当前过滤器业务结束

//@Order(-1) //顺序注解,过滤器的顺序。值越低越优先
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {

    // 测试：http://localhost:10010/order/101?authorization=admin
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 获取第一个 authorization 参数
        String authorization = exchange.getRequest().getQueryParams().getFirst("authorization");
        if ("admin".equals(authorization)){
            // 放行
            return chain.filter(exchange);
        }
        // 设置拦截状态码信息.   401= UNAUTHORIZED
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 设置拦截.
        return exchange.getResponse().setComplete();
    }

    // 设置过滤器优先级，值越低优先级越高
    // 也可以使用 @Order 注解
    @Override
    public int getOrder() {
        return 0;
    }
}

测试：

在这里插入图片描述

全局过滤器的作用是什么？
对所有的路由都生效的过滤器，并且可以自定义处理逻辑

实现全局过滤器的步骤？
1.实现Globalfiter接口
2.添加@Order注解或实现Ordered接口
3.编写处理逻辑

过滤器顺序

请求进入网关会碰到三类过滤器：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排序，组织过滤器链

六、跨域问题

什么是跨域问题

跨域：域名不一致就是跨域，主要包括两方面域名和端口不同：

域名不同： 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

在 Gateway 网关中解决跨域问题还是比较方便的。

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题。询问请求正常发送了。
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 allowedOrigins: “*” 允许所有网站
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期。有效期范围内不在发起询问，而是直接放行

BigTree的学习之路

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
微服务05_统一网关Gateway

微服务05_统一网关Gateway一、为什么需要网关二、gateway快速入门1.创建module，引入依赖2.添加依赖测试：三、路由断言工厂Routte Predicate Factory四、过滤器工厂4.1.路由过滤器的种类【只是配置过滤器】添加过滤器默认全局过滤器。五、全局过滤器【自定义处理逻辑】测试：过滤器顺序六、跨域问题什么是跨域问题一、为什么需要网关Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boo
复制链接

扫一扫