SpringCloud08_Gateway服务网关

79 阅读6分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第21天,点击查看活动详情


⭐️前面的话⭐️

✉️坚持和努力一定能换来诗与远方!
💭推荐书籍:📚《王道408》,📚《深入理解 Java 虚拟机-周志明》,📚《Java 核心技术卷》
💬算法刷题:✅力扣🌐牛客网
🎈Github
🎈码云Gitee


八、Gateway服务网关

 # 在SpringCloud中网关的实现包括两种:zuul和gateway
 ​
 Zuul是基于Servlet的实现,属于阻塞式编程。
 而 SpringCloudGateway 则是基于Spring5中提供的WebFlux,属于 [ 响应式编程 ]的实现,具备更好的性能。
 ​
 ​

1 为什么需要网关

2 gateway快速入门(搭建服务网关)

1)创建新的module,引入 SpringCloudGateway 的依赖和nacos的服务发现依赖:

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

2)编写路由配置及nacos地址

 server:
   port: 10010
 spring:
   application:
     name: gateway
   cloud:
     nacos:
       server-addr: nacos:8848 # nacos地址
     gateway:
       routes: # 网关路由配置
         - id: user-service # 路由id,自定义,必须唯一
           uri: lb://userservice # 路由的目标地址  lb就是负载均衡,后面跟服务名称
           predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
             - Path=/user/** # 路径断言,这个是按照路径匹配,判断路径是否是以/user开头,如果是则符合
         - id: order-service
           uri: lb://orderservice
           predicates:
             - Path=/order/**

 # 网关搭建步骤:
 创建项目,引入nacos服务发现和gateway依赖
 配置application.yml,包括服务基本信息、nacos地址、路由
 ​
 # 路由配置包括:
 路由id:路由的唯一标示
 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
 路由断言(predicates):判断路由的规则,
 路由过滤器(filters):对请求或响应做处理

3 断言工厂

predicates:路由断言,判断请求是否符合要求,符合则转发到路由目的地

 # 断言
 我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
 ​
 例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.
 PathRoutePredicateFactory类来处理的
 ​
 像这样的断言工厂在SpringCloudGateway还有十几个
 ​
 # PredicateFactory的作用是什么?
 - 读取用户定义的断言条件,对请求做出判断
 ​
 # Path=/user/**是什么含义?
 - 路径是以/user开头的就认为是符合的 

Spring提供了11种基本的Predicate工厂,要用哪个去官方查一查文档,看怎么写

docs.spring.io/spring-clou…

这一块参考官网进行配置就可以:

 spring:
   cloud:
     gateway:
       routes:
       - id: after_route
         uri: https://example.org
         predicates:
         - After=2017-01-20T17:42:47.789-07:00[America/Denver]

4 全局过滤器

 # 过滤器的作用是什么?
 - 对路由的请求或响应做加工处理,比如添加请求头
 - 配置在路由下的过滤器只对当前路由的请求生效
 ​
 # default Filters的作用是什么?
 - 对所有路由都生效的过滤器
 ​
 # 全局过滤器的作用是什么?
 对所有路由都生效的过滤器,并且可以自定义处理逻辑
 ​
 # 实现全局过滤器的步骤?
 - 实现GlobalFilter接口
 - 添加@Order注解或实现Ordered接口
 - 编写处理逻辑

4.1 路由过滤器 GatewayFilter

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

4.2 过滤器工厂 GatewayFilterFactory

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

4.3 案例:请求添加请求头

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

实现方式:在gateway中修改application.yml文件,给userservice的路由添加过滤器:

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

4.4 全局过滤器 GlobalFilter(实现 GlobalFilter接口)

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。

区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现 GlobalFilter接口。

4.5 案例:定义全局过滤器,拦截并判断用户身份

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

  • 参数中是否有authorization,
  • authorization参数值是否为admin

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

自定义类,实现GlobalFilter接口,添加@Order注解:

 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.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> params = request.getQueryParams();
         // 2.获取参数中的 authorization 参数
         String auth = params.getFirst("authorization");
         // 3.判断参数值是否等于 admin
         if ("admin".equals(auth)) {
             // 4.是,放行
             return chain.filter(exchange);
         }
         // 5.否,拦截
         // 5.1.设置状态码
         exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
         // 5.2.拦截请求
         return exchange.getResponse().setComplete();
     }
 ​
     @Override
     public int getOrder() {
         return -1;
     }
 }

打印结果

4.6 过滤器执行顺序

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

请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter合并到一个过滤器链(集合)中(设计模式之适配器模式),排序后依次执行每个过滤器

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

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

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

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

可以参考下面几个类的源码来查看:

路由过滤器、defaultFilter、全局过滤器的执行顺序?

  • order值越小,优先级越高
  • 当order值一样时,顺序是defaultFilter最先,然后是局部的路由过滤器,最后是全局过滤器

5 跨域问题处理

跨域:域名或端口不一致就是跨域

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

解决方案:CORS

网关处理跨域采用的同样是CORS方案,并且只需要简单配置即可实现:

 # CORS跨域要配置的参数包括哪几个?
 ​
 - 允许哪些域名跨域?
 - 允许哪些请求头?
 - 允许哪些请求方式?
 - 是否允许使用cookie?
 - 有效期是多久?