Spring Gateway基本使用示例小结

 更新时间:2023年11月09日 10:00:41   作者:Y-wee  
Springcloud Gateway使用了Webflux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架,具体一些特征,本文结合实例代码对Spring Gateway使用给大家介绍的非常详细,感兴趣的朋友一起看看吧

Spring Gateway基本使用

spring gateway官方文档:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/

Springcloud Gateway使用了Webflux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架,具有以下特性:

  • 基于Spring Framework 5,Project Reactor和Spring Boot2.0进行构建
  • 动态路由,能够匹配任何请求属性
  • 可以对路由指定Predicate(断言)和Filter(过滤器)
  • 集成Hystrix的断路器功能
  • 集成Spring Cloud服务发现功能
  • 易于编写的Predicate(断言)和Filter(过滤器)
  • 请求限流功能
  • 支持路径重写

spring gateway的三个重要概念

  • Route(路由)

路由时构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由

  • Predicate(断言)

返回布尔值,判断匹配条件是否符合要求

  • Filter(过滤)

指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改

代码实战

导入依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

注意:spring gateway的webflux模块和web模块冲突,不能导入以下两个依赖,不然启动会报错

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

编写配置文件

server:
  port: 9527
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        # 路由的ID,没有固定规则但要求唯一,建议配合服务名
        - id: payment-routh1
          # 匹配后提供服务的路由地址
          uri: http://localhost:8001
          # 断言,路径相匹配的进行路由
          predicates:
            - Path=/payment/get/**
        - id: payment_routh2
          uri: http://localhost:8001
          predicates:
            - Path=/payment/query/**
eureka:
  instance:
    hostname: gateway-9527
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://127.0.0.1:7001/eureka

访问:http://localhost:9527/payment/get/** 自动转发到地址: http://localhost:8001/payment/get/**

访问:http://localhost:9527/payment/query/** 自动转发到地址: http://localhost:8001/payment/query/**

编码方式配置路由

上面通过配置文件配置了路由相关设置,通过编码方式也可以实现路由配置

编写配置类

package com.yl.gateway.config;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * 路由配置
 *
 * @auther Y-wee
 */
@Configuration
public class GateWayConfig {
    /**
     * 配置一个id为service_route的路由:
     * 当访问地址http://localhost:9527/guonei时自动转发到地址:http://news.baidu.com/guonei
     * 当访问地址http://localhost:9527/guonji时自动转发到地址:http://news.baidu.com/guonji
     *
     * @param routeLocatorBuilder
     * @return
     */
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
        // 路由构建对象
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        // 配置路由
        routes.route("service_route1",
                r -> r.path("/guonei")
                        .uri("http://news.baidu.com/guonei")).build();
        routes.route("service_route2",
                r -> r.path("/guoji")
                        .uri("http://news.baidu.com/guoji")).build();
        return routes.build();
    }
}

配置动态路由

默认情况下Gateway会根据注册中心注册的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能

修改配置文件

server:
  port: 9527
spring:
  application:
    name: gateway
  cloud:
    gateway:
      discovery:
        locator:
          # 开启从注册中心动态创建路由的功能,利用微服务名进行路由
          enabled: true
      routes:
        - id: payment-routh1
          # 匹配后提供服务的路由地址(lb相当于@LoadBalanced,PAYMENT是被调用的服务名)
          uri: lb://PAYMENT
          predicates:
            - Path=/payment/get/**
        - id: payment_routh2
          uri: lb://PAYMENT
          predicates:
            - Path=/payment/query/**
eureka:
  instance:
    hostname: gateway-9527
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://127.0.0.1:7001/eureka

自定义全局过滤器

实现GlobalFilter,Ordered接口

package com.yl.gateway.filter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.Date;
/**
 * 自定义全局过滤器
 *
 * @auther Y-wee
 */
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    /**
     * 自定义过滤逻辑
     *
     * @param exchange
     * @param chain
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("come in MyLogGateWayFilter:  " + new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if (uname == null) {
            log.info("用户名为null,非法用户,o(╥﹏╥)o");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }
    /**
     * 此过滤器的优先级顺序,数值越低优先级越高
     *
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

到此这篇关于Spring Gateway基本使用的文章就介绍到这了,更多相关Spring Gateway使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈如何在项目中使用Spring Cloud Alibaba Sentinel组件

    浅谈如何在项目中使用Spring Cloud Alibaba Sentinel组件

    随着微服务的流行,服务和服务之间的稳定性变得越来越重要。本文主要介绍了使用Spring Cloud Alibaba Sentinel组件,感兴趣的可以了解一下
    2021-07-07
  • @ConfigurationProperties遇到的坑及解决

    @ConfigurationProperties遇到的坑及解决

    这篇文章主要介绍了解决@ConfigurationProperties遇到的坑,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Springboot实现接口传输加解密的步骤详解

    Springboot实现接口传输加解密的步骤详解

    这篇文章主要给大家详细介绍了Springboot实现接口传输加解密的操作步骤,文中有详细的图文解释和代码示例供大家参考,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2023-09-09
  • Java如何生成带网站链接(URL)的二维码

    Java如何生成带网站链接(URL)的二维码

    自从微信扫描出世,二维码扫描逐渐已经成为一种主流的信息传递和交换方式,这篇文章主要给大家介绍了关于Java如何生成带网站链接(URL)的二维码的相关资料,文中通过图文实例代码介绍的非常详细,需要的朋友可以参考下
    2021-07-07
  • SpringBootTest测试时不启动程序的问题

    SpringBootTest测试时不启动程序的问题

    这篇文章主要介绍了SpringBootTest测试时不启动程序的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • Java深入探索线程安全和线程通信的特性

    Java深入探索线程安全和线程通信的特性

    这篇文章主要介绍了Java线程安全和线程通信的特性,线程安全是多线程编程时的计算机程序代码中的一个概念。在拥有共享数据的多条线程并行执行的程序中,线程安全的代码会通过同步机制保证各个线程都可以正常且正确的执行,不会出现数据污染等意外情况
    2022-05-05
  • 使用spring boot 整合kafka,延迟启动消费者

    使用spring boot 整合kafka,延迟启动消费者

    这篇文章主要介绍了使用spring boot 整合kafka,延迟启动消费者的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Spring Boot 中的 @Field 注解的原理解析

    Spring Boot 中的 @Field 注解的原理解析

    本文详细介绍了 Spring Boot 中的 @Field 注解的原理和使用方法,通过使用 @Field 注解,我们可以将 HTTP 请求中的参数值自动绑定到 Java 对象的属性上,简化了开发过程,提高了开发效率,感兴趣的朋友跟随小编一起看看吧
    2023-07-07
  • SpringBoot加载应用事件监听器代码实例

    SpringBoot加载应用事件监听器代码实例

    这篇文章主要介绍了SpringBoot加载应用事件监听器代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • jar包双击执行程序的方法

    jar包双击执行程序的方法

    这篇文章主要介绍了jar包双击执行程序的方法,可实现双击jar包直接执行Java程序的功能,具有一定的参考借鉴价值,需要的朋友可以参考下
    2014-12-12

最新评论