SpringCloudGateway入门

2023-10-12 03:10
文章标签 java 入门 spring springcloudgateway

本文主要是介绍SpringCloudGateway入门，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1.什么是SpringCloudGateway?

Spring Cloud Gateway 网关是SpringCloud官方提供的；
原来有一个Zuul网关，是Netflix公司提供的，现在已经不维护了，后面Netflix公司又出来了一个Zuul2.0网关，但由于一直没有发布稳定版本，所以springcloud等不及了就自己推出一个网关，已经不打算整合zuul2.0了；
Spring Cloud Gateway 项目提供了一个用于在Spring MVC之上构建API网关的库，Spring Cloud Gateway旨在提供一种简单而高效的方法来将请求路由到API，并为它们提供跨领域的关注，例如：安全性，监视/度量和弹性等；

2.SpringCloudGateway有什么功能特性？

建立在Spring Framework 5，Project Reactor和Spring Boot 2.0之上；
能够匹配任何请求属性上的路由；
谓词和过滤器特定于路由；
Hystrix断路器集成；
Spring Cloud DiscoveryClient的集成；
易于编写的谓词和过滤器；
请求速率限制；
路径改写

3.SpringCloudGateway核心概念

  1. 路由：网关的基本组成部分，由一组路由配置组成。单个路由配置包含id、uri、谓词集合、过滤器集合组成。如果维词校验结果为true则住转发，否则拦截请求。
  2. 谓词：这是Java 8函数谓词，输入类型是Spring Framework ServerWebExchange，可以匹配HTTP请求中的所有内容，例如请求头或参数；
  3. 过滤器：这些是使用特定工厂构造的Spring Framework GatewayFilter实例，可以在发送给下游请求之前或之后修改请求和响应；

4.简单的网关demo

  1. 新建网关服务并设置依赖
 <artifactId>alan-gateway</artifactId><name>alan-gateway</name><description>测试网关服务，不需要spring-web服务</description><dependencies><!--spring-cloud-starter-gateway 网关--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId></dependency><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--lombok--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency></dependencies>
  1. 配置applicaytion.yml文件
server:port: 9999
spring:application:name: alan-gatewaycloud:nacos:discovery:server-addr: 192.168.144.100:80gateway:discovery:locator:# 启用DiscoveryClient网关集成，实现服务发现功能enabled: true# 路由集合routes:# 路由id- id: route0# 资源地址 lb表示开启负载均衡uri: lb://consumerpredicates:- Path=consumer/**
  1. 启动网关及consumer服务，请求网关。网关将请求转发到consumer服务上。
    在这里插入图片描述

5.SpringCloudGateway的工作原理

在这里插入图片描述

6.谓词工厂

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分，Spring Cloud Gateway包括许多内置的路由谓词工厂，所有这些谓词都与HTTP请求的不同属性匹配，可以将多个路由谓词工厂结合使用；
总共有11个路由谓词工厂：

  1. The After Route Predicate Factory
  2. The Before Route Predicate Factory
  3. The Between Route Predicate Factory
  4. The Cookie Route Predicate Factory
  5. The Header Route Predicate Factory
  6. The Host Route Predicate Factory
  7. The Method Route Predicate Factory
  8. The Path Route Predicate Factory
  9. The Query Route Predicate Factory
  10. The RemoteAddr Route Predicate Factory
  11. The Weight Route Predicate Factory
  • After路由谓词工厂：After route谓词工厂采用一个参数，即datetime（这是一个Java ZonedDateTime），该谓词匹配在指定日期时间之后发生的请求。
  • Before路由谓词工厂：Before路由谓词工厂采用一个参数，即datetime（这是一个Java ZonedDateTime），该谓词匹配在指定日期时间之前发生的请求
  • Between路由谓词工厂：路由谓词之间的工厂使用两个参数datetime1和datetime2，它们是java ZonedDateTime对象，该谓词匹配在datetime1之后和datetime2之前发生的请求，datetime2参数必须在datetime1之后
  • Cookie 路由谓词工厂：Cookie路由谓词工厂采用两个参数，即cookie名称和一个regexp（这是Java正则表达式），该谓词匹配具有给定名称且其值与正则表达式匹配的cookie
  • Header 路由谓词工厂：header 路由谓词工厂使用两个参数，header 名称和一个regexp（这是Java正则表达式），该谓词与具有给定名称的header 匹配，该header 的值与正则表达式匹配
  • Host 路由谓词工厂：host路由谓词工厂使用一个参数：主机名模式列表
  • Method 路由谓词工厂：方法路由谓词工厂使用方法参数，该参数是一个或多个参数：要匹配的HTTP方法
  • Path路由谓词工厂：路径路由谓词工厂使用两个参数：Spring PathMatcher模式列表和一个称为matchOptionalTrailingSeparator的可选标志
  • Query路由谓词工厂：查询路由谓词工厂采用两个参数：必需的参数和可选的regexp（这是Java正则表达式）
  • RemoteAddr 路由谓词工厂：RemoteAddr路由谓词工厂使用源列表（最小大小为1），这些源是标记（IPv4或IPv6）字符串，例如192.168.0.1/16（其中192.168.0.1是IP地址，而16是子网掩码））
  • RemoteAddr 路由谓词工厂：权重路由谓词工厂采用两个参数：group和weight（一个int），权重是按组计算的。

7.GatewayFilter工厂

路由过滤器允许以某种方式修改传入的HTTP请求或传出的HTTP响应，Spring Cloud Gateway包括许多内置的GatewayFilter工厂；

8.自定义谓词

TokenConfig

public class TokenConfig
{private String token;public String getToken() {return token;}public void setToken(String token) {this.token = token;}
}

TokenRoutePredicateFactory名字必须是XXXX+RoutePredicateFactory

@Component
public class TokenRoutePredicateFactory extends AbstractRoutePredicateFactory<TokenConfig> {public TokenRoutePredicateFactory() {super(TokenConfig.class);}@Overridepublic List<String> shortcutFieldOrder() {return Collections.singletonList("token");}@Overridepublic Predicate<ServerWebExchange> apply(TokenConfig tokenConfig) {// (T t) -> truereturn exchange -> {MultiValueMap<String, String> valueMap = exchange.getRequest().getQueryParams();boolean flag = false;List<String> list = new ArrayList<>();valueMap.forEach((k, v) -> {list.addAll(v);});for (String s : list) {if (StringUtils.equalsIgnoreCase(s, tokenConfig.getToken())) {flag = true;break;}}return flag;};}
}

谓词配置：

spring:application:name: alan-gatewaycloud:nacos:discovery:server-addr: 192.168.144.100:80gateway:discovery:locator:# 启用DiscoveryClient网关集成，实现服务发现功能enabled: true# 路由集合routes:# 路由id- id: route0# 资源地址 lb表示开启负载均衡uri: lb://consumerpredicates:- Token=123456

9.自定义过滤器

过滤器分为全局过滤器和普通过滤器，全局过滤器不需要在路由中显式配置自动生效。普通过滤器需要在路由中配置后才能生效。

  • 普通过滤器 继承AbstractNameValueGatewayFilterFactory
@Component
public class RequestLogGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {@Overridepublic GatewayFilter apply(NameValueConfig config) {return (ServerWebExchange exchange, GatewayFilterChain chain)->{MultiValueMap<String, String> valueMap = exchange.getRequest().getQueryParams();valueMap.forEach((k,v)->{System.out.println(k);System.out.println("==========================");v.forEach(s->{System.out.println("*****"+s+"******");});});//继续下一个filterreturn chain.filter(exchange);};}
}
  • 全局过滤器 实现 GlobalFilter, Ordered
@Component
public class CustomGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {MultiValueMap<String, String> map = exchange.getRequest().getQueryParams();System.out.println("进入全局过滤器，无需显式配置");return chain.filter(exchange);}@Overridepublic int getOrder() {return 0;}
}

10.集成Ribbon实现负载均衡

实现原理是在全局LoadBalancerClientFilter中进行拦截，然后再该过滤器中依赖LoadBalancerClient loadBalancer，而此负载均衡接口的具体实现是RibbonLoadBalancerClient，即spring cloud gateway已经整合好了ribbon，已经可以实现负载均衡，我们不需要做任何工作，网关对后端微服务的转发就已经具有负载均衡功能；uri: lb//consumer

11.集成Sentinel

  1. 添加依赖
 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId></dependency><!-- sentinel-spring-cloud-gateway-adapter --><dependency><groupId>com.alibaba.csp</groupId><artifactId>sentinel-spring-cloud-gateway-adapter</artifactId><version>1.7.2</version></dependency>
  1. 添加配置项dashboard
server:port: 9999
spring:application:name: alan-gatewaycloud:nacos:discovery:server-addr: 192.168.144.100:80gateway:discovery:locator:# 启用DiscoveryClient网关集成，实现服务发现功能enabled: true# 路由集合routes:# 路由id- id: route0# 资源地址 lb表示开启负载均衡uri: lb://consumerpredicates:- Token=123456filters:- RequestLog=prefix,gatewaysentinel:transport:dashboard: 127.0.0.1:8080eager: true
  1. 启用SentinelGatewayFilter,配置SentinelGatewayBlockHandler并注入自定义限流Handler
 @Bean@Order(-1)public GlobalFilter sentinelGatewayFilter() {return new SentinelGatewayFilter();}@Bean@Order(Ordered.HIGHEST_PRECEDENCE)public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler(BlockRequestHandler myBlockRequestHandler) {// Register the block exception handler for Spring Cloud Gateway.//重定向bloack处理
//        GatewayCallbackManager.setBlockHandler(new RedirectBlockRequestHandler("http://www.baidu.com"));//自定义bloack处理GatewayCallbackManager.setBlockHandler(myBlockRequestHandler);return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);}/*** 自定义的BlockRequestHandler** @return*/@Bean(name = "myBlockRequestHandler")public BlockRequestHandler myBlockRequestHandler() {BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {@Overridepublic Mono<ServerResponse> handleRequest(ServerWebExchange serverWebExchange, Throwable throwable) {return ServerResponse.status(HttpStatus.BAD_GATEWAY).contentType(MediaType.APPLICATION_JSON).body(BodyInserters.fromObject("服务器太热了，它罢工了~" + throwable.getClass()));}};return blockRequestHandler;}

12.处理跨域问题

什么叫跨域？
协议、ip(域名)、端口有一个不一样就是跨域请求。
添加配置类

/*** 配置网关跨域cors请求支持**/
@Configuration
public class CorsConfig {@Beanpublic CorsWebFilter corsFilter() {CorsConfiguration config = new CorsConfiguration();config.addAllowedMethod("*"); //是什么请求方法，比如 GET POST PUT DELATE .....config.addAllowedOrigin("*"); //来自哪个域名的请求，*号表示所有config.addAllowedHeader("*"); //是什么请求头UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());source.registerCorsConfiguration("/**", config);return new CorsWebFilter(source);}
}

13.Sentinel规则持久化到Nacos

14.白名单配置

这篇关于SpringCloudGateway入门的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/192816。

相关文章

SpringBoot简单整合ElasticSearch实践

SpringBoot简单整合ElasticSearch实践

《SpringBoot简单整合ElasticSearch实践》Elasticsearch支持结构化和非结构化数据检索,通过索引创建和倒排索引文档,提高搜索效率,它基于Lucene封装,分为索引库、类型... 目录一：ElasticSearch支持对结构化和非结构化的数据进行检索二：ES的核心概念Index：
阅读更多...
Java方法重载与重写之同名方法的双面魔法(最新整理)

Java方法重载与重写之同名方法的双面魔法(最新整理)

《Java方法重载与重写之同名方法的双面魔法(最新整理)》文章介绍了Java中的方法重载Overloading和方法重写Overriding的区别联系,方法重载是指在同一个类中,允许存在多个方法名相同... 目录Java方法重载与重写：同名方法的双面魔法方法重载（Overloading）：同门师兄弟的不同绝
阅读更多...
Spring配置扩展之JavaConfig的使用小结

Spring配置扩展之JavaConfig的使用小结

《Spring配置扩展之JavaConfig的使用小结》JavaConfig是Spring框架中基于纯Java代码的配置方式,用于替代传统的XML配置,通过注解（如@Bean）定义Spring容器的组... 目录JavaConfig 的概念什么是JavaConfig？为什么使用 JavaConfig？Jav
阅读更多...
Java数组动态扩容的实现示例

Java数组动态扩容的实现示例

《Java数组动态扩容的实现示例》本文主要介绍了Java数组动态扩容的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录1 问题2 方法3 结语1 问题实现动态的给数组添加元素效果，实现对数组扩容，原始数组使用静态分配
阅读更多...
Java中ArrayList与顺序表示例详解

Java中ArrayList与顺序表示例详解

《Java中ArrayList与顺序表示例详解》顺序表是在计算机内存中以数组的形式保存的线性表,是指用一组地址连续的存储单元依次存储数据元素的线性结构,：本文主要介绍Java中ArrayList与... 目录前言一、Java集合框架核心接口与分类ArrayList二、顺序表数据结构中的顺序表三、常用代码手动
阅读更多...
JAVA项目swing转javafx语法规则以及示例代码

JAVA项目swing转javafx语法规则以及示例代码

《JAVA项目swing转javafx语法规则以及示例代码》：本文主要介绍JAVA项目swing转javafx语法规则以及示例代码的相关资料,文中详细讲解了主类继承、窗口创建、布局管理、控件替换、... 目录最常用的“一行换一行”速查表（直接全局替换）实际转换示例（JFramejs → JavaFX）迁移建
阅读更多...
Spring Boot Interceptor的原理、配置、顺序控制及与Filter的关键区别对比分析

Spring Boot Interceptor的原理、配置、顺序控制及与Filter的关键区别对比分析

《SpringBootInterceptor的原理、配置、顺序控制及与Filter的关键区别对比分析》本文主要介绍了SpringBoot中的拦截器（Interceptor）及其与过滤器（Filt... 目录前言一、核心功能二、拦截器的实现2.1 定义自定义拦截器2.2 注册拦截器三、多拦截器的执行顺序四、过
阅读更多...
JAVA线程的周期及调度机制详解

JAVA线程的周期及调度机制详解

《JAVA线程的周期及调度机制详解》Java线程的生命周期包括NEW、RUNNABLE、BLOCKED、WAITING、TIMED_WAITING和TERMINATED,线程调度依赖操作系统,采用抢占... 目录Java线程的生命周期线程状态转换示例代码JAVA线程调度机制优先级设置示例注意事项JAVA线程
阅读更多...
JavaWeb项目创建、部署、连接数据库保姆级教程(tomcat)

JavaWeb项目创建、部署、连接数据库保姆级教程(tomcat)

《JavaWeb项目创建、部署、连接数据库保姆级教程(tomcat)》：本文主要介绍如何在IntelliJIDEA2020.1中创建和部署一个JavaWeb项目,包括创建项目、配置Tomcat服务... 目录简介：一、创建项目二、tomcat部署1、将tomcat解压在一个自己找得到路径2、在idea中添加
阅读更多...
Java使用Spire.Doc for Java实现Word自动化插入图片

Java使用Spire.Doc for Java实现Word自动化插入图片

《Java使用Spire.DocforJava实现Word自动化插入图片》在日常工作中,Word文档是不可或缺的工具,而图片作为信息传达的重要载体,其在文档中的插入与布局显得尤为关键,下面我们就来... 目录1. Spire.Doc for Java库介绍与安装2. 使用特定的环绕方式插入图片3. 在指定位
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2