网关Gateway

1)概念

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

2)核心功能特性

  • 请求路由:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
  • 权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截
  • 限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
  • 安全认证

3)SpringCloud中的网关种类

  • gateway:基于spring5提供的WebFulx,属于响应式编程,高性能
  • zuul:阻塞式编程,性能差

image.png

4)gateway使用

  1. gateway三大技术点: **断言 , 过滤, 路由**
  2. 搭建网关步骤
  3. **1.导包(导入依赖)**
  1. <!--网关-->
  2. <dependency>
  3. <groupId>org.springframework.cloud</groupId>
  4. <artifactId>spring-cloud-starter-gateway</artifactId>
  5. </dependency>
  6. <!--nacos服务发现依赖-->
  7. <dependency>
  8. <groupId>com.alibaba.cloud</groupId>
  9. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  10. </dependency>

2.配置(编写基础配置和路由规则)

配置的主要包括 ——— 基本信息 ,nacos地址 , 断言 , 过滤 , 路由

关键是配置 ——路由

  1. 路由id:路由的唯一标示
  2. 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
  3. 路由断言(predicates):判断路由的规则,
  4. 路由过滤器(filters):对请求或响应做处理

创建application.yml文件,内容如下:

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

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

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

  1. 代码(编写启动类)
  1. package com.gateway;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication
  5. public class GatewayApplication {
  6. public static void main(String[] args) {
  7. SpringApplication.run(GatewayApplication.class, args);
  8. }
  9. }

5)断言工厂

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

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

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

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

主要掌握Path这种路由工程。

名称 说明 示例
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 权重处理

断言工厂路由工程有很多类型,不会写没事,下面是SpringGateway官方文档,都有例子,复制就可以
https://cloud.tencent.com/developer/article/1403887?from=15425

6)过滤器工厂

1.概述:过滤器的作用是什么?

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

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

defaultFilters的作用是什么?

① 对所有路由都生效的过滤器,和 routes同级(全局过滤器)

2.过滤器种类

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

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

例如:添加一请求头过滤器

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

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

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

默认过滤器

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. default-filters: # 默认过滤项
  10. - AddRequestHeader=Truth, Itcast is freaking awesome!

全局过滤器

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

实现方式:

1———现GlobalFilter接口。

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

2——-重写filter方法

3——在filter中编写自定义逻辑,可以实现下列功能:

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

代码示例

  1. package cn.itcast.gateway.filters;
  2. import org.springframework.cloud.gateway.filter.GatewayFilterChain;
  3. import org.springframework.cloud.gateway.filter.GlobalFilter;
  4. import org.springframework.core.annotation.Order;
  5. import org.springframework.http.HttpStatus;
  6. import org.springframework.stereotype.Component;
  7. import org.springframework.web.server.ServerWebExchange;
  8. import reactor.core.publisher.Mono;
  9. @Order(-1)//排序规则
  10. @Component
  11. public class AuthorizeFilter implements GlobalFilter {
  12. @Override
  13. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  14. // 1.获取请求参数
  15. MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
  16. // 2.获取authorization参数
  17. String auth = params.getFirst("authorization");
  18. // 3.校验
  19. if ("admin".equals(auth)) {
  20. // 放行
  21. return chain.filter(exchange);
  22. }
  23. // 4.拦截
  24. // 4.1.禁止访问,设置状态码
  25. exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
  26. // 4.2.结束处理
  27. return exchange.getResponse().setComplete();
  28. }
  29. }

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排序,组织过滤器链

网关处理跨域采用CORS方案

image.png