Spring Cloud Gateway初识及相关配置

最新推荐文章于 2024-04-23 10:45:54 发布

codingTop

最新推荐文章于 2024-04-23 10:45:54 发布

阅读量569

点赞数

分类专栏： SpringCloud SoringBoot 文章标签：网关 java spring spring boot

本文链接：https://blog.csdn.net/weixin_44297716/article/details/105335121

版权

SoringBoot 同时被 2 个专栏收录

20 篇文章 0 订阅

订阅专栏

SpringCloud

12 篇文章 2 订阅

订阅专栏

Spring Cloud Gateway

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

务。

Spring Cloud Gateway基于Filter链提供网关基本功能：安全、监控／埋点、限流等。

Spring Cloud Gateway为微服务架构提供简单、有效且统一的API路由管理方式。

Spring Cloud Gateway是替代Netflflix Zuul的一套解决方案。

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

网关的核心功能是：过滤和路由

Spring Cloud Gateway的核心就是一系列的过滤器，可以将客户端的请求转发到不同的微服务。主要作用：过滤和路由。
$C:\Users\86132\AppData\Roaming\Typora\typora-user-images$

核心概念

路由（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将会对请求和响应进行修改处理。

一丶入门demo

需求：通过网关系统heima-gateway将包含有 /user 的请求路由到 http://127.0.0.1:9091/user/用户id

创建工程；

添加启动器依赖；

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

编写启动引导类和配置文件；

server:
  port: 10010
spring:
  application:
    name: api-gateway
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true

修改配置文件，设置路由信息；

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

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

启动测试：http://127.0.0.1:10010/user/8 --> http://127.0.0.1:9091/user/8

面向服务的路由

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

因为已经配置了Eureka客户端，可以从Eureka获取服务的地址信息。修改 heima-gateway\src\main\resources\application.yml 文件如下

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          # 代理的服务地址
         # uri: http://127.0.0.1:9091
         # 代理的服务地址；lb表示从eureka中获取具体服务
         uri: lb://user-service
          # 路由断言： 可以匹配映射路径
          predicates:
            - Path=/user/**

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

路由配置中uri所用的协议为lb时（以uri: lb://user-service为例），gateway将使用 LoadBalancerClient把

user-service通过eureka解析为实际的主机和端口，并进行ribbon负载均衡。lb 之后编写的服务名必须要在eureka中注册才能使用
启动测试：再次启动 heima-gateway ，这次gateway进行代理时，会利用Ribbon进行负载均衡访问：

http://localhost:10010/user/8 日志中可以看到使用了负载均衡器

二丶路由前缀处理

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

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

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

server: 
	port: 10010 
spring: 
	application:
    	name: api-gateway
#通过 PrefixPath=/xxx 来指定了路由要添加的前缀。
#也就是：
#PrefixPath=/user http://localhost:10010/8 --》http://localhost:9091/user/8
#PrefixPath=/user/abc http://localhost:10010/8 --》http://localhost:9091/user/abc/8
#以此类推。


	cloud:
    	gateway:
        	routes: 
    		# 路由id，可以随意写
            	- id: user-service-route
                # 代理的服务地址；lb表示从eureka中获取具体服务
                uri: lb://user-service 
                # 路由断言，可以配置映射路径
                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/8 --> http://127.0.0.1:9091/user/8 添加前缀路径/user

去除前缀：将请求地址中路径去除一些前缀路径之后再作为代理的服务地址；在gateway中可以通过配置路由的过滤器StripPrefifix，实现映射路径中地址的去除；

server:
	port: 10010 
spring:
	application:	
    	name: api-gateway 
    cloud:
    	gateway:
        	routes: 
        		# 路由id，可以随意写 
        		- id: user-service-route
                # 代理的服务地址；lb表示从eureka中获取具体服务 
                uri: lb://user-service 
                # 路由断言，可以配置映射路径 
                predicates: - Path=/api/user/** 
                filters:
                	# 表示过滤1个路径，2表示两个路径，以此类推 
                	- StripPrefix=1 
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 去除前缀路径/api，通过 StripPrefix=1 来指定了路由要去掉的前缀个数。如：路径 /api/user/1 将会被代理到 /user/1 。

三丶过滤器

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

Gateway自带过滤器有几十个，常见自带过滤器有：（可在依赖中GatawayFilterFactory中查看）
在这里插入图片描述

（详细说明官网中可查看）

3.1配置全局默认过滤器：

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

server: 
	port: 10010
spring: 
	application: 
		name: api-gateway 
	cloud: 
		gateway: 
			# 默认过滤器，对所有路由生效
			default-filters: 
			# 响应头过滤器，对输出的响应设置其头部属性名称为X-Response-Default-MyName，值为hanpi； 如果有多个参数多则重写一行设置不同的参数 ,也可以添加请求头方法雷同，第一个值为属性名，第二个为属性值
				- AddResponseHeader=X-Response-Default-MyName, hanpi 
			routes: 
				# 路由id，可以随意写 
				- id: user-service-route
                	# 代理的服务地址；lb表示从eureka中获取具体服务 
                	uri: lb://user-service
                    # 路由断言，可以配置映射路径 
                    predicates: - Path=/api/user/** 
                    filters:、
                    	# 表示过滤1个路径，2表示两个路径，以此类推 
                    	- StripPrefix=1

上述配置后，再访问 http://localhost:10010/api/user/8 的话；那么可以从其响应中查看到如下信息：[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传在这里插入图片描述

3.2 过滤器类型

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

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

3.3 执行生命周期

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

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

3.4使用场景

常见的应用场景如下：

请求鉴权：一般 GatewayFilterChain 执行fifilter方法前，如果发现没有访问权限，直接就返回空。
异常处理：一般 GatewayFilterChain 执行fifilter方法后，记录异常并返回。
服务调用时长统计： GatewayFilterChain 执行fifilter方法前后根据时间统计。

3.5 自定义局部过滤器

注意：自定义过滤器的命名应该为：***GatewayFilterFactory

按照默认过滤器编写并配置一个自定义局部过滤器，该过滤器可以通过配置文件中的参数名称获取请求的参数值。在过滤器（MyParamGatewayFilterFactory）中将http://localhost:10010/api/user/8?name=itcast中的参数name的值获取到并输出到控制台；并且参数名是可变的，也就是不一定每次都是name；需要可以通过配置过滤器的时候做到配置参数名。

配置：

 server:
 	port: 10010 
 spring:
 	application:
    	name: api-gateway 
    cloud:
    	gateway:
        	routes: 
        		# 路由id，可以随意写 
        		- id: user-service-route
                # 代理的服务地址；lb表示从eureka中获取具体服务 
                uri: lb://user-service
                # 路由断言，可以配置映射路径 
                predicates: - Path=/api/user/** 
                filters:
                	#key都取自于过滤器前边部分
                	# 表示过滤1个路径，2表示两个路径，以此类推
                    - StripPrefix=1 
                    # 自定义过滤器 
                    - MyParam=name 
eureka:
	client: 
		service-url:
        	defaultZone: http://127.0.0.1:10086/eureka 
        	instance: prefer-ip-address: true 2

代码编写：（可参考源码实现过滤器进行编写）

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 java.util.Arrays;
import java.util.List;

@Component
public class MyParamGatewayFilterFactory extends AbstractGatewayFilterFactory<MyParamGatewayFilterFactory.Config> {
	//值与配置类中的param一致
    static final String PARAM_NAME = "param";

    public MyParamGatewayFilterFactory() {
        super(Config.class);
    }

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

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            // http://localhost:10010/api/user/8?name=itcast   config.param ==> name
            //获取请求参数中param对应的参数名 的参数值
            ServerHttpRequest request = exchange.getRequest();
            if(request.getQueryParams().containsKey(config.param)){
                request.getQueryParams().get(config.param).
                  //函数式变成循环遍历，%s与后边参数对应
                        forEach(value -> System.out.printf("------------局部过滤器--------%s = %s------", config.param, value));
            }
            return chain.filter(exchange);
        };
    }


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

        public String getParam() {
            return param;
        }

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

3.6自定义全局过滤器

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

默认是全局过滤器，不用配置（默认过滤器对所有路由都生效），全局过滤器实现GlobalFilter接口就可以

代码编写测试：

@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("--------------全局过滤器MyGlobalFilter------------------");
        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;
    }
}

四丶Gateway其他配置说明

4.1Gateway网关的负载均衡和熔断参数配置，跨域请求配置

Gateway网关一般直接给终端请求使用；Feign一般用在微服务之间调用。

server:
  port: 10010
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      routes:
        # 路由id，可以任意
        - id: user-service-route
          # 代理的服务地址
          #uri: http://127.0.0.1:9091
          # lb表示从eureka中获取具体服务
          uri: lb://user-service
          # 路由断言： 可以匹配映射路径
          predicates:
            #- Path=/user/**
            #- Path=/**
            - Path=/api/user/**
          filters:
            # 添加请求路径的前缀
            #- PrefixPath=/user
            #1表示过滤1个路径，2表示两个路径，以此类推
            - StripPrefix=1
            - MyParam=name
      # 默认过滤器，对所有路由都生效
      default-filters:
        - AddResponseHeader=X-Response-Foo, Bar
        - AddResponseHeader=abc-myname,heima
        #跨域配置
      globalcors:
        corsConfigurations:
          '[/**]':
            #allowedOrigins: * # 这种写法或者下面的都可以，*表示全部
            allowedOrigins:
              - "http://docs.spring.io"
            allowedMethods:
              - GET
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    prefer-ip-address: true
hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 6000
ribbon:
  ConnectTimeout: 1000
  ReadTimeout: 2000
  MaxAutoRetries: 0
  MaxAutoRetriesNextServer: 0

4.2 跨域说明

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

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

如：从在http://localhost:9090中的js访问 http://localhost:9000的数据，因为端口不同，所以也是跨域请求。

配置如上
上述配置表示：可以允许来自 http://docs.spring.io 的get请求方式获取服务数据。

allowedOrigins 指定允许访问的服务器地址，如：http://localhost:10000 也是可以的。

‘[/**]’ 表示对所有访问到网关服务器的请求地址

官网具体说明：https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.1.1.RELEASE/multi/multi__cors_confifiguration.html

五丶Gateway高可用

5.1高可用

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

5.2Gateway和Feign的区别

Gateway 作为整个应用的流量入口，接收所有的请求，如PC、移动端等，并且将不同的请求转发至不同的处理微服务模块，其作用可视为nginx；大部分情况下用作权限鉴定、服务端流量控制
Feign 则是将当前微服务的部分服务接口暴露出来，并且主要用于各个微服务之间的服务调用

五丶Gateway高可用

5.1高可用

5.2Gateway和Feign的区别

Gateway 作为整个应用的流量入口，接收所有的请求，如PC、移动端等，并且将不同的请求转发至不同的处理

微服务模块，其作用可视为nginx；大部分情况下用作权限鉴定、服务端流量控制

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

codingTop

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring Cloud Gateway初识及相关配置

Spring Cloud GatewaySpring Cloud Gateway是Spring官网基于Spring 5.0、 Spring Boot 2.0、Project Reactor等技术开发的网关服务。Spring Cloud Gateway基于Filter链提供网关基本功能：安全、监控／埋点、限流等。Spring Cloud Gateway为微服务架构提供简单、有效且统一的API...
复制链接

扫一扫