SpringCloud Gateway的基本入门和注意点详解

目录
  • 1.gateway和zuul
  • 2.使用gateway的路由功能
    • 1. 搭载springcloud gateway
    • 2.简单使用gateway
      • 1.application配置

1.gateway和zuul

Spring Cloud Finchley版本的gateway比zuul 1.x系列的性能和功能整体要好,且使用 Gateway 做跨域相比应用本身或是 Nginx 的好处是规则可以配置的更加灵活.

这两者相同的地方就是都是作为网关,处理前段的请求,可以进行路由到对应的服务或者url,也可以针对权限做过滤处理,也可以对其他服务响应的结果做处理

截至目前SpringCloud gateway最新版本是2.1.0 RC3,可见官方网站SpringCloud gateway,每个版本增加的功能都比较多,改动的地方也比较多,前几个版本有比较坑的地方,建议使用最新版本

2.使用gateway的路由功能

1. 搭载springcloud gateway

准备一个spring cloud工程,包括eureka-server注册中心,service-client服务提供者,端口8090

service-client提供一个接口:

@RestController
@Slf4j
public class ProducerController {
  @RequestMapping("/hi")
  public String hi(@RequestParam String name) {
    log.info("[client服务] [hi方法]收到请求");
    return "hi " + name + ",i am from service-client";
  }
}

再建一个spring cloud工程,service-gateway网关,端口8088

pom的依赖:

 <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.4.RELEASE</version>
    <relativePath/>
 </parent>
 <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>
<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>

application启动类:

package com.zgd.springcloud.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
/**
 * service-gateway 客户端
 * @author zgd
 */
@EnableEurekaClient
@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

这样基本的框架就搭好了,先启动eureka-server注册中心,再启动service-client和service-gateway

直接调用 localhost:8090/hi?name=zgd,可以收到

hi zgd,i am from service-client

2.简单使用gateway

GateWay大体可以分为路由工厂Route Predicate Factories,网关过滤器工厂GatewayFilter Factories,全局过滤器工厂Global Filters处理请求。

对于路由转发,Spring Cloud gateway内置了很多校验条件谓语(predicate)来实现路由功能。

比如

  • 根据时间来路由: After Route Predicate Factory某个时间点之后请求路由,Before Route Predicate Factory某个时间点之前请求路由,Between Route Predicate Factory两者时间之间
  • 通过请求路径来路由: Path Route Predicate Factory
  • 根据请求头来路由
  • 根据cookie来路由
  • 根据域名来路由

有两种方式配置,一种是配置文件application的方式,一种是代码配置

1.application配置

a. 路由到其他地址

spring:
  cloud:
    gateway:
      #可以根据请求参数,cookie,host,请求时间,请求头等进行校验判断路由, 下面根据先后顺序转发
      routes:
        - id: host_route
          uri: http://httpbin.org:80/get
          predicates:
            - Path=/zzzgd/** # 请求地址携带zzzgd的,则转发

在spring.cloud.gateway.routes中,我们可以根据不同的谓语配置不同的路由,根据配置的先后顺序来跳转,越在前面优先级越高.

其中id,区分不同的路由规则,不可重复,uri,指需要跳转的地址,Predicates就是上面说的谓语了,可以配置多个,使用正则匹配. 这里我们配置的是如果请求地址携带zzzgd则会跳转到我们配置的uri

配置好gateway,重新启动,然后我们调用localhost:8088(网关的地址和端口)/zzzgd/abc,这个地址是没有任何匹配的接口的,按理来说会返回404,但是配置了网关就返回了这些信息,这个是我们配置的uri所返回的:

{
  "args": {
    "name": "zgd"
  },
  "headers": {
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
    "Accept-Encoding": "gzip, deflate, br",
    "Accept-Language": "zh-CN,zh;q=0.9",
    "Connection": "close",
    "Cookie": "SL_G_WPT_TO=zh; SL_GWPT_Show_Hide_tmp=undefined; SL_wptGlobTipTmp=undefined",
    "Forwarded": "proto=http;host=\"localhost:8088\";for=\"0:0:0:0:0:0:0:1:55782\"",
    "Host": "httpbin.org",
    "Upgrade-Insecure-Requests": "1",
    "User-Agent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
    "X-Forwarded-Host": "localhost:8088"
  },
  "origin": "0:0:0:0:0:0:0:1, 119.147.213.42",
  "url": "http://localhost:8088/get?name=zgd"
}

上面的是根据地址来路由,还有下面多种路由配置:

根据域名来转发路由:

routes:
 - id: host_route
   uri: http://httpbin.org:80/get
   predicates:
     - Host=**.csdn.** # 请求域名携带csdn的,则转发
 - id: query_route
   uri: http://httpbin.org:80/get
   predicates:
     - Query=username, zzz* # 请求参数含有username,且值满足zzz开头的,则转发(对值的匹配可以省略)
 - id: header_route
   uri: http://httpbin.org:80/get
   predicates:
     - Header=request, \d+ # 如果请求头含有request,且为数字,则转发
 - id: cookie_route
      uri: http://httpbin.org:80/get
      predicates:
        - Cookie=name, zzzgd # 如果携带cookie,参数名为name,值为zzzgd,则转发
    - id: path_route
      uri: http://httpbin.org:80/get
      predicates:
        - Path=/zzzgd/** # 请求地址携带zzzgd的,则转发
    # 路由到其他服务,url需要用[lb://]+[serviceId]
    - id: service_client
      uri: lb://service-client
      predicates:
        - Path=/to_client/** # 如果请求地址满足/to_client/**,则转发到 service-client 服务
      filters:
        - StripPrefix=1 # 去除请求地址中的to_client
    - id: after_route
      uri: http://httpbin.org:80/get
      predicates:
        - After=2019-01-01T17:42:47.789-07:00[America/Denver] # 如果请求时间大于该时间,则转发

b. 根据服务名路由到其他服务

我们知道,zuul是可以根据服务在eureka的serviceId,来将请求路由到不同的服务上,这也是网关最大的作用之一,gateway也可以

gateway可以通过开启以下配置来打开根据服务的serviceId来匹配路由,默认是大写:

# 配置gateway路由
spring:
  cloud:
    gateway:
      discovery:
        locator:
          # 是否可以通过其他服务的serviceId来转发到具体的服务实例。默认为false
          # 为true,自动创建路由,路由访问方式:http://Gateway_HOST:Gateway_PORT/大写的serviceId/**,其中微服务应用名默认大写访问
          enabled: true

开启配置,重启gateway,访问 localhost:8088/SERVICE-CLIENT/hi?name=zgd,

正常返回了service-client的结果.

如果需要小写serviceId,则配置spring.cloud.gateway.locator.lowerCaseServiceId:true

注意事项

不管小写大写,不能使用下划线,否则会报:

org.springframework.cloud.gateway.support.NotFoundException: Unable to find instance for localhost

所以服务的spring.application.name必须用中划线而不是下划线

如果开启了lowerCaseServiceId,则只能用小写,不能识别大写,如果不开启,只能识别大写

除了上面这种自动设置路由服务,也可以手动设置,在routes中配置

这里使用的是gateway的其中一个过滤器工厂,去除请求地址前缀的过滤器

# 路由到其他服务,url需要用[lb://]+[serviceId]
- id: service_client
  uri: lb://service-client
  predicates:
    - Path=/to_client/** # 如果请求地址满足/to_client/**,则转发到 service-client 服务
  filters:
    - StripPrefix=1 # 去除请求地址中的to_client

这里的uri不是一个具体的地址了,而是lb://开头,加上serviceId

然后比如上面这个配置,我们 再调用 localhost:8088/to_client/hi?name=zgd

可以看到也正常收到了service-client的返回.说明我们调用到了这个服务.

这里需要注意的一点,如果不加上filters.- StripPrefix=1,那么则无法请求到hi这个接口。因为这个to_client相当于是服务名,只是为了网关的路由加上去的,对于服务提供者service-client来说,不需要这段地址,所以需要去掉

还有其他的predicate,可以参考官方文档

过滤

这个filters也是gateway的一个重要功能,过滤.

gateway内置的过滤器工厂有下面这些:

除了上面用到的

  • 路径前缀去除过滤器,还有
  • 添加请求参数过滤器
  • 添加请求头过滤器
  • 添加响应头过滤器
  • 移除响应头过滤器

它可以修改我们请求的路径,请求的参数,增加请求头,或者响应头等等

可以参考官方文档

举个例子,我们将application配置如下:

spring:
  cloud:
    gateway:
  routes:
   - id: query_route
    uri: http://httpbin.org:80/get
    predicates:
    - Query=username, zzz* # 请求参数含有username,且值满足zzz开头的,则转发(对值的匹配可以省略)
    filters:
    - AddRequestHeader=X-Request-Foo, Bar
    - AddRequestParameter=age, 18

请求 localhost:8088/?username=zzzzzzz

它返回了它所受到的请求,将会看到返回数据中已经添加了一个age=18的请求参数,且请求头也多了X-Request-Foo=Bar

b.代码配置

为了方便在java开发,gateway也提供了代码的方式配置,比如我们注释掉上面的application配置,然后建一个配置类

/**
 * @Author: zgd
 * @Date: 2019/1/8 19:09
 * @Description:
 */
@Configuration
public class GateWayConfig {
  @Bean
  public RouteLocator routeLocator(RouteLocatorBuilder builder) {
    return builder.routes()
            .route(r -> r.path("/fluent/**").and().query("name")
                    .uri("http://httpbin.org:80/get"))
            .build();
  }
}

启动,访问

http://localhost:8088/fluent/1/?name=bb

成功!

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

(0)

相关推荐

  • SpringCloud gateway request的body验证或修改方式

    SpringCloud gateway request的body验证或修改 后续版本新增了以下过滤器 org.springframework.cloud.gateway.filter.headers.RemoveHopByHopHeadersFilter 默认会把以下头部移除(暂不了解这做法的目的) - connection - keep-alive - te - transfer-encoding - trailer - proxy-authorization - proxy-authenti

  • 解决SpringCloud Gateway配置自定义路由404的坑

    目录 问题背景 问题现象 解决过程 1 检查网关配置 2 跟源码,查找可能的原因 3 异常原因分析 解决方法 心得 问题背景 将原有项目中的websocket模块迁移到基于SpringCloud Alibaba的微服务系统中,其中网关部分使用的是gateway. 问题现象 迁移后,我们在使用客户端连接websocket时报错: io.netty.handler.codec.http.websocketx.WebSocketHandshakeException: Invalid subprotoc

  • SpringCloud gateway跨域配置的操作

    gateway跨域配置 gateway允许跨域的配置和zuul的不一样,记录一下. 版本 <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.6.RELEASE</version> <relativePath/> <!--

  • 使用SpringCloudApiGateway之支持Cors跨域请求

    问题背景 公司的项目需要前后端分离,vue+java,这时候就需要支持Cors跨域请求了.最近对zuul进行升级,假如说zuul是1.0的话,api gateway就是2.0的网关,支持ws等,基于NIO,各方面还是强大的. 解决方案 新建一个Configuration类即可 import org.springframework.cloud.client.discovery.DiscoveryClient; import org.springframework.cloud.gateway.dis

  • springboot集成springCloud中gateway时启动报错的解决

    在项目中引入springcloud中的gateway时报以下错误 Description: Parameter 0 of method modifyRequestBodyGatewayFilterFactory in org.springframework.cloud.gateway.config.GatewayAutoConfiguration required a bean of type 'org.springframework.http.codec.ServerCodecConfigur

  • Nginx+SpringCloud Gateway搭建项目访问环境

    目录 安装Nginx 准备SpringBoot应用 添加网关 现如今的项目开发基本都是微服务方式,导致一个系统中会有很多的服务,每个模块都对应着不同的端口,为了方便访问,通常会让某个服务绑定一个域名,比如商品服务:product.xxx.com:订单服务:order.xxx.com,此时可以使用Nginx来搭建一个域名访问环境,基于前后端分离开发的项目经常会遇到跨域问题,使用Nginx也能轻松解决. 安装Nginx 首先拉取nginx的镜像: docker pull nginx:1.10 然后随

  • Java之Springcloud Gateway内置路由案例讲解

    Spring Cloud Gateway路由匹配是Spring WebFlux基础功能的一部分,在Spring Cloud Gateway中内置了很多路由断言工厂类.不同的断言工厂类针对HTTP请求的不同属性.多个断言工厂类可以使用逻辑"and"进行组合使用. 4.1 After Route Predicate Factory        这个Predicate工厂的实现类是AfterRoutePredicateFactory,使用一个时间参数,如果当前请求的时间在配置的赶时间之后,

  • SpringCloud Gateway的基本入门和注意点详解

    目录 1.gateway和zuul 2.使用gateway的路由功能 1. 搭载springcloud gateway 2.简单使用gateway 1.application配置 1.gateway和zuul Spring Cloud Finchley版本的gateway比zuul 1.x系列的性能和功能整体要好,且使用 Gateway 做跨域相比应用本身或是 Nginx 的好处是规则可以配置的更加灵活. 这两者相同的地方就是都是作为网关,处理前段的请求,可以进行路由到对应的服务或者url,也可

  • Python入门_条件控制(详解)

    条件控制其实就是if...else...(如果...条件是成立的,就做...:反之,就做...)的使用,其基本结构是: 具体看下面这个例子: def account_login(): # 定义函数 password = input('请输入密码:') # 输入密码 if password == '12345': # 如果输入密码是12345,则登录成功 print('登录成功') else: print('密码有误,请重新输入') # 否则提示密码有误,请重新输入 account_login()

  • C语言入门之基础知识详解

    一.思维导图 内容不限于此思维导图 二.环境搭建 对于老手,自动跳过这一趴吧,或者也可以看一下我有没有啥纰漏,毕竟小白需要这一趴. 编译器很多,大部分老师会在学生学习C语言的时候推荐使用VC,不带语言提示器的那种,说是可以提高学生的编码能力.我也不知道到底是不是这么一回事儿.我推荐使用VS,这样学的快,函数记不住的问题很严重吗?项目的车轮碾压过去,再记不住也得记住吧!!! 更何况这个系列到后面是会有需要用文本文件编程写项目的阶段. 下载VS2019社区版,不要标新立异选那些最新版的,出了问题到时

  • Python入门之基础语法详解

    一.我的经历及目标 在学习python之前:我学习过C/C++,在学校期间做过很多的项目,已经有两年多了,算是对C/C++非常的熟悉了,精通不敢说,但是对于面向过程和面向对象有很深刻的认识,做过很多的开发,学习数据库,MFC, QT, linux下利用C/C++进行服务器的开发,QT环境下进行模拟QQ的开发- 听说python挺火的,我也来尝试一门新的语言,python和c有80%的相似性,毕竟是用C来开发的语言,但是是面向过程的一门语言,有C++的继承等相似的特性,感觉更有信心学会它了,毕竟可

  • C语言入门篇--关键字static详解

    目录 1.修饰局部变量 1.1作用 1.2举例 (1)不加static (2)加static (3)静态局部变量的初始化只会进行一次 2.修饰全局变量 2.1作用 2.2举例 (1)不加static (2)加static 3.修饰函数 3.1作用 3.2举例 (1)不加static (2)加static 1.修饰局部变量 1.1作用 ststic修饰局部变量,会改变局部变量的生命周期,不改变作用域: 生命周期:和全局变量一样具有全局性,但在内存中的位置没有改变,还在在静态存储区中. 作用域:作用

  • Django零基础入门之模板变量详解

    引言: 我们在页面上会看到,谁登录的就会显示谁的信息,那么这个页面上的变量信息是怎样实现的呢? 这就是本文要讲述的内容--Django中的模板变量! 1.模板变量! 可以在前端页面中使用模板变量来取数据库中的数据,实现前端页面数据动态显示. (1)模板变量使用规则:(在HTML模板中使用!) 语法: {{ 变量名 }} 命名由字母和数字以及下划线组成,不能有空格和标点符号 可以使用字典.类对象.方法.函数.列表.字符串 不要和python或django关键字重名 注意: 如果data是一个字典,

  • Django零基础入门之常用过滤器详解

    引言: 前面讲过了Django中使用模板变量.使用很简单,那么有没有什么关于模板变量的骚操作呢? 答案是肯定有的,这就是本文要讲的--过滤器! 1.过滤器 (1)纯干货讲解: 作用: 对变量进行过滤.在真正渲染出来之前,过滤器会根据功能处理好变量,然后得出结果后再替换掉原来的变量展示出来. 语法:{{ fruits|lower }} 管道符号进行链式调用(可以理解为嵌套使用!),比如实现一个功能,先把所有字符变成小写,再把第一个字符转换成大写. 语法:{{fruits|lower|capfirs

  • SpringCloud实现文件上传功能的方法详解

    目录 图片上传 搭建项目 编写上传功能 图片上传 刚才的新增实现中,我们并没有上传图片,接下来我们一起完成图片上传逻辑. 文件的上传并不只是在品牌管理中有需求,以后的其它服务也可能需要,因此我们创建一个独立的微服务,专门处理各种上传. 搭建项目 创建SpringCloud项目 添加依赖 我们需要EurekaClient和web依赖: <?xml version="1.0" encoding="UTF-8"?> <project xmlns=&quo

  • Python入门之列表用法详解

    目录 列表是什么 列表的CRUD 创建列表 访问列表中的值 更新列表 删除元素 拼接列表 列表相乘 判断 遍历列表 列表常用方法 获取列表长度 列表后面添加元素 指定位置添加元素 删除元素 返回的是某个元素在列表里面的个数 合并列表 返回的是元素在列表中的第一个位置 排序 将列表进行翻转 清除列表 浅拷贝列表 深拷贝列表 列表是什么 列表是元素的集合,存储在一个变量中. 列表中存储的元素类型没有限制,根据需要动态分配和回收内存 列表中的每个元素都会分配一个数字用来表示它的位置(索引),第一个索引

  • Python入门之字符串操作详解

    目录 字符串 字符串常用操作 拼接字符串 字符串复制 计算字符串的长度 截取字符串和获取单个字符 字符串包含判断 常用字符串方法 把字符串的第一个字符大写 统计字符串出现的次数 检查字符串开头 检查字符串结尾 大写转小写 小写转大写 大小写翻转 标题化字符串 空格删除 合并字符串 分割字符串 将字符串按照行分割 判断字符串只是数字 判断是空字符 字符串填充 字符串搜索 字符串替换 格式化字符串 字符串编码转换 字符串 字符串常用操作 拼接字符串 拼接字符串需要使用‘+’运算符可完成对多个字符串的

随机推荐