当前位置:   article > 正文

Gateway服务网关的配置_gateway routes 配置

gateway routes 配置

Gateway介绍;

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

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

网关的核心功能特性

  • 请求路由

  • 权限控制

  • 限流

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

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

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

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

  • gateway

  • zuul

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

具体操作:

1,创建gateway服务,引入依赖

依赖:

  1. <!--网关-->
  2. <dependency>
  3. <groupId>org.springframework.cloud</groupId>
  4. <artifactId>spring-cloud-starter-gateway</artifactId>
  5. <version>2.2.1.RELEASE</version>
  6. </dependency>
  7. <!--nacos服务发现依赖-->
  8. <dependency>
  9. <groupId>com.alibaba.cloud</groupId>
  10. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  11. </dependency>

2,编写启动类

启动类:

  1. @SpringBootApplication
  2. public class GatewayApplication {
  3. public static void main(String[] args) {
  4. SpringApplication.run(GatewayApplication.class, args);
  5. }
  6. }

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

在application.yml配置文件中写:

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

注意:如果可以启动,但是访问不了地址,很有可能是服务的名字有问题!!!配置了nacos集群容易出现此问题。

路由配置包括:

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

  2. 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡

  3. 路由断言(predicates):判断路由的规则,

  4. 路由过滤器(filters):对请求或响应做处理

断言工厂:

就是可以写多个条件。

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

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

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

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

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

我们只需要掌握Path这种路由工程就可以了。要学习别的路由工程看这个大佬写的:Spring Cloud Gateway之路由断言工厂篇_the query route predicate factory-CSDN博客

路由过滤器:

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

也可以叫网关过滤器

路由过滤器的种类

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

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

操作步骤filters:

下面我们以AddRequestHeader 为例。

需求:给所有进入userservice的请求添加一个请求头:Truth,I am the best!

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

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

演示:给userservice的服务的接口添加获取请求头并打印:

注意:这里是@RequestHeader注解!

调用此接口时,即可打印出来:

默认过滤器default-filters:

上面的例子因为过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效,

要想对全局有效,使用默认过滤器:

全局过滤器GlobalFilters:

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

使用方法:

定义方式是实现GlobalFilter接口:

创建一个类AuthorizeFilter实现接口GlobalFilter:

别忘了加上@Component注解!!!!交给Spring管理。。。。

     * @param exchange 请求上下文,里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束

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

  • 参数中是否有authorization,

  • authorization参数值是否为admin

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

  1. @Override
  2. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  3. //1,获取请求参数
  4. ServerHttpRequest request = exchange.getRequest();
  5. MultiValueMap<String, String> params = request.getQueryParams();
  6. //2,获取参数中的authorization
  7. String auth = params.getFirst("authorization");
  8. //3,判断参数值是否等于admin
  9. if("admin".equals(auth)){
  10. //4,是,放行
  11. return chain.filter(exchange);
  12. }
  13. //5,否,拦截
  14. //5.1 设置状态码401
  15. exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
  16. //5.2 拦截请求
  17. return exchange.getResponse().setComplete();
  18. }

还需要写此过滤的顺序,两种方式:

第一种:

第二种:实现接口Ordered,重写方法;

过滤器执行顺序;

请求进入网关会碰到三类过滤器:当前路由的过滤器、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排序,组织过滤器链

跨域问题:

什么是跨域问题:

跨域:域名不一致就是跨域,主要包括:

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

解决方案:CORS,详情查看跨域资源共享 CORS 详解 - 阮一峰的网络日志

解决跨域问题

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

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

                
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/盐析白兔/article/detail/830971
推荐阅读
相关标签
  

闽ICP备14008679号