Spring Cloud微服务学习系列12 Gateway网关

最新推荐文章于 2023-08-08 15:30:19 发布

一只胡说八道的猴子

最新推荐文章于 2023-08-08 15:30:19 发布

阅读量531

点赞数

分类专栏： SpringCloud

本文链接：https://blog.csdn.net/pjh88/article/details/119577890

版权

SpringCloud 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

Spring Cloud Gateway网关

简介

Spring Cloud Gateway是Spring官网基于Spring 5.0、 Spring Boot 2.0、Project Reactor等技术开发的网关服务。

网关的主要作用：

Spring Cloud Gateway基于Filter链提供网关基本功能：安全、监控／埋点、限流等**。**
Spring Cloud Gateway为微服务架构提供简单、有效且统一的API路由管理方式。

3.Spring Cloud Gateway是替代Netflix Zuul的一套解决方案。

4.Spring Cloud Gateway组件的核心是一系列的过滤器，通过这些过滤器可以将客户端发送的请求转发（路由）到对应的微服务。 Spring Cloud Gateway是加在整个微服务最前沿的防火墙和代理器，隐藏微服务结点IP端口信息，从而加强安全保护。Spring Cloud Gateway本身也是一个微服务，需要注册到Eureka服务注册中心。

**
**网关的核心功能是：**过滤和路由（将客户端的请求转发到各个微服务）

加入GetWay之后的架构

不管是来自于客户端（PC或移动端）的请求，还是服务内部调用。一切对服务的请求都可经过网关，然后再由网关来实现鉴权、动态路由等等操作。Gateway就是我们服务的统一入口

核心概念介绍

路由（route）路由信息的组成：由一个ID、一个目的URL、一组断言工厂、一组Filter组成。如果路由断言为真，说明请求URL和配置路由匹配。
断言（Predicate） Spring Cloud Gateway中的断言函数输入类型是Spring 5.0框架中的ServerWebExchange。Spring Cloud Gateway的断言函数允许开发者去定义匹配来自于Http Request中的任何信息比如请求头和参数。
过滤器（Filter）一个标准的Spring WebFilter。 Spring Cloud Gateway中的Filter分为两种类型的Filter，分别是Gateway Filter和Global Filter。过滤器Filter将会对请求和响应进行修改处理。

快速入门

步骤解析

1.新建工程
2.编写启动类
3.编写配置
4.编写路由规则
5.启动测试

1.新建工程导入jar包

<dependencies>
    <!--gateway相关-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!--eureka相关-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
</dependencies>

2.编写启动类

package com.pjh;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class GateWayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GateWayApplication.class);
    }
}

3.编写配置

server:
  port: 10010 #端口
spring:
  application:
    name: gateway-service #注册到eureka的服务名
eureka:
  client:
    service-url:
      defaultZone: http://localhost:10086/eureka #eureka注册中心的地址与端口
  instance:
    prefer-ip-address: true

4.编写路由规则

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          # 代理的服务地址
          uri: http://127.0.0.1:8088
          # 路由断言： 可以匹配映射路径
          predicates:
            - Path=/user/**

eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

5.启动测试

成功调用User-Service的方法查询数据库

面向服务路由

什么是面向服务路由

在刚才的路由规则，把路径的服务地址写死了，如果一个服务有多个实例的化，应该根据服务的名称去Eureka注册中心查找服务对应的所有实例的列表，然后进行动态路由

修改配置文件，通过配置名称获取

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          #lb表示从eureka中获取具体的服务
          uri: lb://producer-service #http://127.0.0.1:8088
          #路由断言，可以配置映射路径
          predicates:
            #添加请求路径前缀
            - Path=/user/**
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

测试

解释

路由配置中所用的协议为lb时（以uri：lb://producer-service为例），gataway将使用LoadBalance将使用user-service通过eureka解析为实际的主机和端口并，进行ribbon负载均衡

路由前缀

路由前缀的作用及其目的：

目标：

可以对请求到网关服务的地址添加或去除前缀
**

分析：

提供服务的地址：http://127.0.0.1:9091/user/8

添加前缀：对请求地址添加前缀路径之后再作为代理的服务地址；

http://127.0.0.1:10010/8 --> http://127.0.0.1:9091/user/8 添加前缀路径/user

去除前缀：将请求地址中路径去除一些前缀路径之后再作为代理的服务地址；

http://127.0.0.1:10010/api/user/8 --> http://127.0.0.1:9091/user/8 去除前缀路径/api

作用:

客户端的请求地址与微服务的服务地址如果不一致的时候，可以通过配置路径过滤器实现路径前缀的添加和去除。

添加前缀

概念：

对请求地址添加前缀路径之后再作为代理的服务地址；

例

比如在浏览器中输入的是http://127.0.0.1:10010/8
如果你设置的自动添加前缀的内容为 /user
网关在调用微服务的时候会自动加上**/user**
即地址变为： http://127.0.0.1:9091/user/8

配置文件配置

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          #lb表示从eureka中获取具体的服务
          uri: lb://producer-service #http://127.0.0.1:8088
          #路由断言，可以配置映射路径
          predicates:
            #添加请求路径前缀这里不可以包含自动添加的前缀，否则断言失败
            - Path=/**
          filters:
            - PrefixPath=/user

eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

去除前缀

概念

将请求地址中路径去除一些前缀路径之后再作为代理的服务地址

例：

比如你在浏览器中访问的地址为：http://127.0.0.1:10010/api/user/8

设置去除一个前缀之后网关调用微服务的地址为http://127.0.0.1:9091/user/8
**
以上面例子为例
**
通过 StripPrefix=1 来指定了路由要去掉的前缀个数。如：路径 /api/user/1 将会被代理到 /user/1 也就是：

StripPrefix=1 http://localhost:10010/api/user/8 --》http://localhost:9091/user/8

StripPrefix=2 http://localhost:10010/api/user/8 --》http://localhost:9091/8

配置文件配置

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          #lb表示从eureka中获取具体的服务
          uri: lb://producer-service #http://127.0.0.1:8088
          #路由断言，可以配置映射路径
          predicates:
            #去除前缀 - Path=/api/user/** 这里的请求路径应该设置为未去除前缀之前的路径
            - Path=/**
          filters:
            #这里等于1表示过滤一个前缀等于2则表示过滤两个前缀
            - StripPrefix=1

eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

过滤器

简介

Gateway作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作往往是通过网关提供的过滤器来实现的。前面的路由前缀章节中的功能也是使用过滤器实现的。Gateway自带过滤器有几十个，常见自带过滤器有：

配置全局默认过滤器

这些自带的过滤器可以和使用路由前缀章节中的用法类似，也可以将这些过滤器配置成不只是针对某个路由；而是可以对所有路由生效，也就是配置默认过滤器：
了解如下：

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          #lb表示从eureka中获取具体的服务
          uri: lb://producer-service #http://127.0.0.1:8088
          #路由断言，可以配置映射路径
          predicates:
            #添加请求路径前缀这里不可以包含自动添加的前缀，否则断言失败
            #去除前缀 - Path=/api/user/** 这里的请求路径应该设置为未去除前缀之前的路径
            - Path=/**
          filters:
            - PrefixPath=/user
            #这里等于1表示过滤一个前缀等于2则表示过滤两个前缀
            #- StripPrefix=1
      default-filters:
        # 响应头过滤器，对输出的响应设置其头部属性名称为X-Response-Default-MyName，值为test；
        #如果有多个参数多则重写一行设置不同的参数
        - AddResponseHeader=X-Response-Default-MyName, test

eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

上诉配置后使用开发者工具发现响应头中多了一个键值对：

过滤器类型：

Gateway实现方式上，有两种过滤器；

1. 局部过滤器：

通过 spring.cloud.gateway.routes.filters 配置在具体路由下，只作用在当前路由
上；自带的过滤器都可以配置或者自定义按照自带过滤器的方式。如果配置spring.cloud.gateway.default-filters 上会对所有路由生效也算是全局的过滤器；但是这些过滤器
的实现上都是要实现GatewayFilterFactory接口。

2. 全局过滤器：

不需要在配置文件中配置，作用在所有的路由上；实现 GlobalFilter 接口即可

执行生命周期

基本介绍

Spring Cloud Gateway 的 Filter 的生命周期也类似Spring MVC的拦截器有两个：“pre” 和 “post”。“pre”和 “post” 分别会在请求被执行前调用和被执行后调用。

这里的 pre 和 post 可以通过过滤器的 GatewayFilterChain 执行filter方法前后来实现。

使用场景

常见的应用场景如下：

**请求鉴权：**一般 GatewayFilterChain 执行filter方法前，如果发现没有访问权限，直接就返回空。

**异常处理：**一般 GatewayFilterChain 执行filter方法后，记录异常并返回。

服务调用时长统计： GatewayFilterChain 执行filter方法前后根据时间统计。

自定义过滤器

自定义局部过滤器

目标：

按照默认过滤器编写并配置一个自定义局部过滤器，该过滤器可以通过配置文件中的参数名称获取请求的参数值
**

分析：

需求：在过滤器（MyParamGatewayFilterFactory）中将http://localhost:10010/api/user/8?name=itcast中的参数name的值获取到并输出到控制台；并且参数名是可变的，也就是不一定每次都是name；需要可以通过配置过滤器的时候做到配置参数名。

实现步骤：

配置过滤器；
编写过滤器；
测试

1.配置过滤器；

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          #lb表示从eureka中获取具体的服务
          uri: lb://producer-service #http://127.0.0.1:8088
          #路由断言，可以配置映射路径
          predicates:
            #添加请求路径前缀这里不可以包含自动添加的前缀，否则断言失败
            #去除前缀 - Path=/api/user/** 这里的请求路径应该设置为未去除前缀之前的路径
            - Path=/**
          filters:
            - PrefixPath=/user
            #这里的FilterTest是所配置过滤器类名FilterTestGatewayFilterFactory的前半部分
            - FilterTest=age
            #这里等于1表示过滤一个前缀等于2则表示过滤两个前缀
            #- StripPrefix=1
      default-filters:
        # 响应头过滤器，对输出的响应设置其头部属性名称为X-Response-Default-MyName，值为test；
        #如果有多个参数多则重写一行设置不同的参数
        - AddResponseHeader=X-Response-Default-MyName, test

eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

2.编写过滤器；

package com.pjh.Filter;

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;

import javax.print.DocFlavor;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@Component/*添加bean注解*/
public class FilterTestGatewayFilterFactory extends AbstractGatewayFilterFactory<FilterTestGatewayFilterFactory.Config> {
   /*构造方法*/
    public FilterTestGatewayFilterFactory(){
       super(Config.class);
   }
    /*指定对应的参数名称*/
   static final String PARAM_NAME = "param";
    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest();
            if (request.getQueryParams().containsKey(config.param)){
                request.getQueryParams().get(config.param)
                        .forEach(value -> System.out.printf("----------局部过滤器-----%s = %s-----",
                                config.param, value));

                     }
            return chain.filter(exchange);
        };
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList(PARAM_NAME);
    }

    public static class  Config{
        /*对应在配置过滤器的时候指定的参数*/
        private String param;

        public String getParam() {
            return param;
        }

        public void setParam(String param) {
            this.param = param;
        }
    }


}

3.测试

自定义全局过滤器

目标：

定义一个全局过滤器检查请求中是否携带有token参数
**

分析：

需求：

编写全局过滤器，在过滤器中检查请求地址是否携带token参数。如果token参数的值存在则放行；如果token的参数值为空或者不存在则设置返回的状态码为：未授权也不再执行下去。

实现步骤：

编写全局过滤器；
测试

1.编写全局过滤器；

package com.pjh.Filter;
import org.apache.commons.lang.StringUtils;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("正在执行全局过滤器");
        String token = exchange.getRequest().getQueryParams().getFirst("token");
        //判断是否为空
        if (StringUtils.isBlank(token)){
            /*设置状态码为未授权*/
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        /*当有多个过滤器的时候值越小越先执行*/
        return 1;
    }
}

2.测试

没有带token参数的时候

带token参数的时候
**

负载均衡和熔断

Gateway中默认就已经集成了Ribbon负载均衡和Hystrix熔断机制。但是所有的超时策略都是走的默认值，比如熔断超时时间只有1S，很容易就触发了。因此建议手动进行配置

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          #lb表示从eureka中获取具体的服务
          uri: lb://producer-service #http://127.0.0.1:8088
          #路由断言，可以配置映射路径
          predicates:
            #添加请求路径前缀这里不可以包含自动添加的前缀，否则断言失败
            #去除前缀 - Path=/api/user/** 这里的请求路径应该设置为未去除前缀之前的路径
            - Path=/**
          filters:
            - PrefixPath=/user
            #这里的FilterTest是所配置过滤器类名FilterTestGatewayFilterFactory的前半部分
            #- FilterTest=age
            #这里等于1表示过滤一个前缀等于2则表示过滤两个前缀
            #- StripPrefix=1
      default-filters:
        # 响应头过滤器，对输出的响应设置其头部属性名称为X-Response-Default-MyName，值为test；
        #如果有多个参数多则重写一行设置不同的参数
        - AddResponseHeader=X-Response-Default-MyName, test
hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds=2000
ribbon.:
  ConnectTimeout: 1000 # 连接超时时长
  ReadTimeout: 2000 # 数据通信超时时长
  MaxAutoRetries: 0 # 当前服务器的重试次数
  MaxAutoRetriesNextServer: 0 # 重试多少次服务
  OkToRetryOnAllOperations: false # 是否对所有的请求方式都重试
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

Gateway跨域配置

一般网关是所有微服务的统一入口，必然在调用的时候会出现跨域问题

什么是跨域

在js请求访问中，如果访问的地址与当前服务器的域名、ip或者端口号不一致则称为跨域请求。若不解决则不能获取到对应地址的返回结果。

如：从在http://localhost:9090中的js访问 http://localhost:9000的数据，因为端口不同，所以也是跨域请求。
在访问Spring Cloud Gateway网关服务器的时候，出现跨域问题的话；可以在网关服务器中通过配置解决，允许哪些服务是可以跨域请求的；具体配置如下：

spring:
  cloud:
    gateway:
      globalcors:
        corsConfigurations:
          '[/**]':
           #allowedOrigins: * # 这种写法或者下面的都可以，*表示全部
            allowedOrigins:
            - "http://docs.spring.io"
            allowedMethods:
            - GET

上述配置表示：可以允许来自 http://docs.spring.io 的get请求方式获取服务数据。allowedOrigins 指定允许访问的服务器地址，如：http://localhost:10000 也是可以的。’[/**]’ 表示对所有访问到网关服务器的请求地址
官网具体说明：https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.1.1.RELEASE/multi/mul
ti__cors_configuration.html

Gateway高可用

启动多个Gateway服务，自动注册到Eureka，形成集群。如果是服务内部访问，访问Gateway，自动负载均衡，没问题。
但是，Gateway更多是外部访问，PC端、移动端等。它们无法通过Eureka进行负载均衡，那么该怎么办？
此时，可以使用其它的服务网关，来对Gateway进行代理。比如：Nginx

Gateway与Feign的区别

Gateway作为整个流量的入口，接受所有的请求，如PC，移动端等，并且将不同的请求发送至不同的微服务处理模块，其作用视为nginx，大部分情况下用做权限界定，服务端流量控制

Fegin则是将当前微服务的部分服务接口暴露出来，并且主要用于各个微服务之间的服务调用

一只胡说八道的猴子

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring Cloud微服务学习系列12 Gateway网关

Spring Cloud Gateway网关简介Spring Cloud Gateway是Spring官网基于Spring 5.0、 Spring Boot 2.0、Project Reactor等技术开发的网关服务。网关的主要作用：Spring Cloud Gateway基于Filter链提供网关基本功能：安全、监控／埋点、限流等**。**Spring Cloud Gateway为微服务架构提供简单、有效且统一的API路由管理方式。3.Spring Cloud Gateway是替代Netf
复制链接

扫一扫