Gateway

目录

Gateway服务网关

为什么需要网关

gateway快速入门

第一步:创建工程gateway,并导入网关依赖和nacos客户端依赖

第二步:在application.yml配置文件下编写连接nacos的配置,并写gateway网关路由配置

第三步:测试

网关路由的流程图

总结:

Gateway断言工厂

GateWay过滤器工厂

[​编辑 路由过滤器的种类](#编辑 路由过滤器的种类)

请求头过滤器

默认过滤器(对所有的微服务请求都生效)

总结

全局过滤器

全局过滤器作用

自定义全局过滤器

测试

过滤器执行顺序

使用gateway解决前端和后端跨域问题


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,属于响应式编程的实现,具备更好的性能。

gateway快速入门

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

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

第一步:创建工程gateway,并导入网关依赖和nacos客户端依赖

这里导入nacos客户端依赖的目的是需要将这个gateway工程注册到nacos 才能拉取nacos下的各种服务实例的ip端口

html 复制代码
 <dependencies>
<!--        导入gateway依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
<!--        导入nacos客户端依赖,将其注册到nacos下才可以拉取nacos下的各种微服务-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>

第二步:在application.yml配置文件下编写连接nacos的配置,并写gateway网关路由配置

html 复制代码
spring:
  application:
    name: gateway #微服务名字
  cloud:
    nacos: #注册到nacos
      server-addr: localhost:80 #后缀默认会加上/nacos
    gateway:
      routes:
        - id: userservice #路由id,自定义,唯一即可
#          uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://user-service # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** #访问端口10010以/user开头的所有路径都会代理到lb://user-service

        - id: orderservice
          uri: lb://order-service
          predicates:
            - Path=/order/**

server:
  port: 10010

访问10010端口时,符合Path规则的路径都会代理去uri地址,lb是负载均衡,后面跟着服务的名称,gateway会让ribbon会根据服务的名字去nacos拉取对应的服务实例,然后根据IRule规则来决定要使用哪一个实例的ip端口

第三步:测试

访问10010端口,然后以/user路径开头,gateway就会反向代理到uri地址(lb://user-service)

网关路由的流程图

总结:

网关搭建步骤:

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

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

路由配置包括:

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

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

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

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

Gateway断言工厂

我们在配置文件中写的断言规则只是字符串,这些字符串会被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 权重处理

GateWay过滤器工厂

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

路由过滤器的种类

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

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

请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求:给所有进入userservice的请求添加一个请求头:Truth=i am hhh

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

注意:filters关键字必须与user-service的id同级,这样才让所有访问user-service服务的请求中往请求头中加上Truth请求头

html 复制代码
spring:
  application:
    name: gateway #微服务名字
  cloud:
    nacos: #注册到nacos
      server-addr: localhost:80 #后缀默认会加上/nacos
    gateway:
      routes:
        - id: userservice #路由id,自定义,唯一即可
#          uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://user-service # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** #访问端口10010以/user开头的所有路径都会代理到lb://user-service
          filters: #过滤器
            - AddRequestHeader=Truth,i am hhh #给所有访问user-service服务的请求都加上请求头(key为Truth,value为...)

        - id: orderservice
          uri: lb://order-service
          predicates:
            - Path=/order/**
server:
  port: 10010

验证

java 复制代码
    @Autowired
    private DateTimeFormatVO dateformat;
    @GetMapping("/now")
    public String nowTime(@RequestHeader("Truth")String header){
        System.out.println(header);
        System.out.println(dateformat.getCommonProperties());
        //获取当前时间并格式化成特定字符串形式返回
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat.getFormat()));
    }

默认过滤器(对所有的微服务请求都生效)

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

default-filters必须与routies同级,这样才是对所有的微服务生效

java 复制代码
spring:
  application:
    name: gateway #微服务名字
  cloud:
    nacos: #注册到nacos
      server-addr: localhost:80 #后缀默认会加上/nacos
    gateway:
      routes:
        - id: userservice #路由id,自定义,唯一即可
#          uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://user-service # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** #访问端口10010以/user开头的所有路径都会代理到lb://user-service

      default-filters: #给所有的微服务都加上这个过滤器群
        - AddRequestHeader=Truth,i am Default
#          filters: #过滤器
#            - AddRequestHeader=Truth,i am hhh #给所有访问user-service服务的请求都加上请求头(key为Truth,value为...)

        - id: orderservice
          uri: lb://order-service
          predicates:
            - Path=/order/**

      

server:
  port: 10010

总结

过滤器的作用是什么?

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

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

defaultFilters的作用是什么?

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

全局过滤器

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

全局过滤器作用

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

自定义全局过滤器的 定义方式是实现GlobalFilter接口。

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

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

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

自定义全局过滤器

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

  • 参数中是否有authorization,

  • authorization参数值是否为admin

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

实现:

在gateway中定义一个过滤器:

java 复制代码
package cn.itcast.demo.filter;

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

/**
 * 设置全局过滤器,实现GlobalFilter接口
 * 判断authorization参数值是否为admin
 */
@Component
@Order(-1)//配置过滤器优先级,数字越小优先级越高
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        //authorization请求参数值
        String authorization = params.getFirst("authorization");
        if("admin".equals(authorization)){
           return chain.filter(exchange);//放行
        }
        //拦截
        //禁止访问,设置403状态码
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        //直接拦截返回,不执行下面的拦截器
        return exchange.getResponse().setComplete();
    }
}

测试

直接访问会被拒绝

加上请求参数之后才能访问

过滤器执行顺序

请求进入网关后会碰到三种过滤器类型:DefaultFilter,当前路由的过滤器,GlobaFilter

由断言工厂匹配到指定微服务的路由,然后将当前路由过滤器,DefaultFilter,GlobalFilter合并到一个过滤器链(集合),排序这些过滤器的顺序就依次执行每个过滤器

执行顺序

  • 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前
  • GlobalFilter通过实现Order接口,或者添加@Order注解来指定order值,由我们自定义
  • 路由过滤器和defaultFilter的order由spring指定,默认是按照声明顺序从1递增
  • 当过滤器的order值一样时,会按照defaultFilter>路由过滤器>GlobalFilter的顺序执行

测试

java 复制代码
@Configuration
@Slf4j
public class GlobalFilterConfig {
    @Bean
    @Order(-2)//order1越小执行顺序越靠前
    public GlobalFilter globalFilter1(){ //使用lambda表达式
        return (exchange, chain) -> {
            log.info("过滤器1执行");
            return chain.filter(exchange).then(Mono.fromRunnable(()->{
                log.info("过滤器1后执行阶段");
            }));
        };
    }
    @Bean
    @Order(-1)
    public GlobalFilter globalFilter2(){
        return (exchange, chain) -> {
            log.info("过滤器2执行");
            return chain.filter(exchange).then(Mono.fromRunnable(()->{
                log.info("过滤器2后执行阶段");
            }));
        };
    }
}

使用gateway解决前端和后端跨域问题

跨域问题的解决方法

跨域问题就是不同端口之间的访问存在的问题

  • 1.可以通过前端进行配置
  • 2.nginx实现反向代理可以天然的解决前端和后端的跨域问题
  • 3.使用gateway也可以设置哪些ip端口可以访问gateway反向代理的ip端口

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

相关推荐
轻口味3 分钟前
命名空间与模块化概述
开发语言·前端·javascript
苹果醋343 分钟前
React源码02 - 基础知识 React API 一览
java·运维·spring boot·mysql·nginx
C4rpeDime1 小时前
自建MD5解密平台-续
android
晓纪同学1 小时前
QT-简单视觉框架代码
开发语言·qt
威桑1 小时前
Qt SizePolicy详解:minimum 与 minimumExpanding 的区别
开发语言·qt·扩张策略
Hello.Reader1 小时前
深入解析 Apache APISIX
java·apache
飞飞-躺着更舒服1 小时前
【QT】实现电子飞行显示器(简易版)
开发语言·qt
明月看潮生1 小时前
青少年编程与数学 02-004 Go语言Web编程 16课题、并发编程
开发语言·青少年编程·并发编程·编程与数学·goweb
明月看潮生1 小时前
青少年编程与数学 02-004 Go语言Web编程 17课题、静态文件
开发语言·青少年编程·编程与数学·goweb
Java Fans1 小时前
C# 中串口读取问题及解决方案
开发语言·c#