统一服务入口-Gateway(二)

2024-08-21 06:12
文章标签 服务 统一 入口 gateway

本文主要是介绍统一服务入口-Gateway(二),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

1.Gateway Filter Factories(网关过滤器工厂)

1.1GatewayFilter

1.2GlobalFilter

2.过滤器执行顺序

3.自定义GatewayFilter

3.1定义GatewayFilter

3.2配置过滤器

3.3测试

4.自定义GlobalFilter

4.1定义GlobalFilter

4.2测试


承接上文:统一服务入口-Gateway(一)-CSDN博客

1.Gateway Filter Factories(网关过滤器工厂)

Predicate决定了请求由哪一个路由处理,如果在请求处理前后需要加一些逻辑,这就是Filter(过滤器)的作用范围了

Filter分为两种类型:Pre类型和Post类型

Pre类型过滤器:路由处理之前执行(请求转发到后端服务之前执行),在Pre类型过滤器中可以做鉴权,限流等

Post类型过滤器:请求执行完成后,将结果返回给客户端之前执行

Spring Cloud Gateway中内置了很多Filter,用于拦截和链式处理web请求.比如权限校验,访问超时等设定.

Spring Cloud Gateway从作用范围上,把Filter可分为GatewayFilter和GlobalFilter.

GatewayFilter:应用到单个路由或者一个分组的路由上.

GlobalFilter:应用到所有的路由上,也就是对所有的请求生效.

1.1GatewayFilter

GatewayFilter同Predicate类似,都是在配置文件application.yml中配置,每个过滤器的逻辑都是固定的.比如AddRequestParameterGatewayFilter Factory只需要在配置文件中写AddRequestParameter,就可以为所有的请求添加一个参数

快速上手

1.在application.yml中添加filter

server:port: 10030
spring:application:name: gatewaycloud:nacos:discovery:server-addr: 127.0.0.1:8848namespace: b460e95c-d4b9-42a3-810f-cdf0051ce008gateway:metrics:enabled: trueroutes:- id: product-service   #路由规则id, 随便起, 不重复即可uri: lb://product-service/ #目标服务地址predicates:   #路由条件- Path=/product/**- After=2024-01-01T00:00:00.000+08:00[Asia/Shanghai]filters:- AddRequestParameter=userName, romised- id: order-service   #路由规则id, 随便起, 不重复即可uri: lb://order-service/ #目标服务地址predicates: #路由条件- Path=/order/**,/feign/**

该filter只添加在了product-service路由下,因此只对product-service路由生效

2.接收参数并打印

在product-service服务中接收请求的参数,并打印出来

 @RequestMapping("/product")@RestControllerpublic class ProductController {@Autowiredprivate ProductService productService;@RequestMapping("/{productId}")public ProductInfo getProductById(@PathVariable("productId") Integer 
productId, String userName){System.out.println("收到请求,Id:"+productId);System.out.println("userName:"+userName);return productService.selectProductById(productId);}}

3.测试

重启服务,访问请求,观察日志

http://127.0.0.1:10030/product/1001

控制台打印日志:

GatewayFilter说明

Spring Cloud Gateway提供的Filter特别多,下面列出一些常见的过滤器说明

详细可参考官方文档:GatewayFilter Factories :: Spring Cloud Gateway

Default Filters

前面的filter添加在指定路由下,所以只对当前路由生效,若需要对全部路由生效,可以使用:spring.cloud.gateway.default-filters

配置举例:

spring:cloud: gateway:default-filters:- AddResponseHeader=X-Response-Default-Red, Default-Blue- PrefixPath=/httpbin

1.2GlobalFilter

GlobalFilter是Spring Cloud Gateway中的全局过滤器,它和GatewayFilter的作用是相同的.
GlobalFilter会应用到所有的路由请求上,全局过滤器通常用于实现与安全性,性能监控和日志记录等相关的全局功能.

Spring Cloud Gateway内置的全局过滤器也有很多,比如:

  • Gateway Metrics Filter:网关指标,提供监控指标
  • Forward Routing Filter:用于本地forword,请求不转发到下游服务器
  • LoadBalancer Client Filter:针对下游服务,实现负载均衡.
  • ...

更多过滤器参考:Global Filters :: Spring Cloud Gateway 

快速上手

1.添加依赖

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

2.添加配置

spring:cloud:gateway:metrics:enabled: true
management:endpoints:web:exposure:include: "*"endpoint:health:show-details: alwaysshutdown:enabled: true

3.测试

访问http://127.0.0.1:10030/actuator 显示所有监控的信息链接

2.过滤器执行顺序

一个项目中,既有GatewayFilter,又有GlobalFilter时,执行的先后顺序是什么呢?

请求路由后,网关会把当前项目中的GatewayFilter和GlobalFilter合并到一个过滤器链(集合)中并进行排序,依次执行过滤器.

每一个过滤器都必须指定一个int类型的order值,默认值为0,表示该过滤的优先级.order值越小,优先级越高,执行顺序越靠前。

  • Filter通过实现Order接口或者添加@Order注解来指定order值.
  • SpringCloud Gateway提供的Filter由Spring指定.用户也可以自定义Filter,由用户指定.
  • 当过滤器的order值一样时,会按照defaultFilter>GatewayFilter>GlobalFilter的顺序执行.

3.自定义GatewayFilter

 自定义GatewayFilter,需要去实现对应的接口GatewayFilterFactory,Spring Boot默认帮我们实现的抽象类是AbstractGatewayFilterFactory ,我们可以直接使用.

3.1定义GatewayFilter

@Slf4j
@Component
public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomConfig> implements Ordered {public CustomGatewayFilterFactory() {super(CustomConfig.class);}@Overridepublic GatewayFilter apply(CustomConfig config) {return new GatewayFilter() {/*** ServerWebExchange: HTTP 请求-响应交互契约, 提供了对HTTP请求和响应的访问* GatewayFilterChain: 过滤器链* Mono: Reactor的核心类, 数据流发布者,Mono最多只能触发一个事件.可以把Mono用在异步完成任务时,发出通知* chain.filter(exchange)  执行请求* Mono.fromRunnable()  创建一个包含Runnable元素的数据流*/@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {//Pre类型   执行请求   Post类型log.info("Pre Filter, config:{} ",config);  //Pre类型过滤器代码逻辑return chain.filter(exchange).then(Mono.fromRunnable(()->{log.info("Post Filter....");  //Post类型过滤器代码逻辑}));}};}@Overridepublic int getOrder() {return Ordered.LOWEST_PRECEDENCE;//配置优先级, order越⼤, 优先级越低}
}
针对这个Filter的配置,使用CustomConfig定义
 @Datapublic static class CustomConfig {private String name;}

代码说明:

  1. 类名统一以GatewayFilterFactory结尾,因为默认情况下,过滤器的name会采用该定义类的前缀.这里的name=Custom(yml配置中使用)
  2. apply方法中,同时包含Pre和Post过滤,then方法中是请求执行结束之后处理的
  3. CustomConfig是一个配置类,该类只有一个属性name,和yml的配置对应
  4. 该类需要交给Spring管理,所以需要加@Component注解
  5. getOrder表示该过滤器的优先级,值越大,优先级越低.

3.2配置过滤器

spring:application:name: gatewaycloud:nacos:discovery:server-addr: 127.0.0.1:8848namespace: b460e95c-d4b9-42a3-810f-cdf0051ce008gateway:metrics:enabled: trueroutes:- id: product-service   #路由规则id, 随便起, 不重复即可uri: lb://product-service/ #目标服务地址predicates:   #路由条件- Path=/product/**- After=2024-01-01T00:00:00.000+08:00[Asia/Shanghai]filters:- AddRequestParameter=userName, romised- name: Custom    #过滤器名称args:name: test_custom

3.3测试

重启服务访问接口,观察日志:http://127.0.0.1:10030/product/1001

4.自定义GlobalFilter

GlobalFilter的实现比较简单,它不需要额外的配置,只需要实现GlobalFilter接口,自动会过滤所有的Filter

4.1定义GlobalFilter

@Slf4j
@Component
public class CustomGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {log.info("Pre Global Filter");return chain.filter(exchange).then(Mono.fromRunnable(()->{log.info("Post Global Filter...");}));}@Overridepublic int getOrder() {return Ordered.LOWEST_PRECEDENCE;}
}

4.2测试

重启服务,访问接口,观察日志:http://127.0.0.1:10030/product/1001

从日志中,也可以看出来, 当GatewayFilter 和GlobalFilter 过滤器order⼀样时, 会先执行GatewayFilter

这篇关于统一服务入口-Gateway(二)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1092341

相关文章

Nginx配置系统服务&设置环境变量方式

《Nginx配置系统服务&设置环境变量方式》本文介绍了如何将Nginx配置为系统服务并设置环境变量,以便更方便地对Nginx进行操作,通过配置系统服务,可以使用系统命令来启动、停止或重新加载Nginx... 目录1.Nginx操作问题2.配置系统服android务3.设置环境变量总结1.Nginx操作问题

Spring Boot 3 整合 Spring Cloud Gateway实践过程

《SpringBoot3整合SpringCloudGateway实践过程》本文介绍了如何使用SpringCloudAlibaba2023.0.0.0版本构建一个微服务网关,包括统一路由、限... 目录引子为什么需要微服务网关实践1.统一路由2.限流防刷3.登录鉴权小结引子当前微服务架构已成为中大型系统的标

springboot的调度服务与异步服务使用详解

《springboot的调度服务与异步服务使用详解》本文主要介绍了Java的ScheduledExecutorService接口和SpringBoot中如何使用调度线程池,包括核心参数、创建方式、自定... 目录1.调度服务1.1.JDK之ScheduledExecutorService1.2.spring

Android 悬浮窗开发示例((动态权限请求 | 前台服务和通知 | 悬浮窗创建 )

《Android悬浮窗开发示例((动态权限请求|前台服务和通知|悬浮窗创建)》本文介绍了Android悬浮窗的实现效果,包括动态权限请求、前台服务和通知的使用,悬浮窗权限需要动态申请并引导... 目录一、悬浮窗 动态权限请求1、动态请求权限2、悬浮窗权限说明3、检查动态权限4、申请动态权限5、权限设置完毕后

TP-Link PDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务

《TP-LinkPDDNS服将于务6月30日正式停运:用户需转向第三方DDNS服务》近期,路由器制造巨头普联(TP-Link)在用户群体中引发了一系列重要变动,上个月,公司发出了一则通知,明确要求所... 路由器厂商普联(TP-Link)上个月发布公告要求所有用户必须完成实名认证后才能继续使用普联提供的 D

关于Gateway路由匹配规则解读

《关于Gateway路由匹配规则解读》本文详细介绍了SpringCloudGateway的路由匹配规则,包括基本概念、常用属性、实际应用以及注意事项,路由匹配规则决定了请求如何被转发到目标服务,是Ga... 目录Gateway路由匹配规则一、基本概念二、常用属性三、实际应用四、注意事项总结Gateway路由

微服务架构之使用RabbitMQ进行异步处理方式

《微服务架构之使用RabbitMQ进行异步处理方式》本文介绍了RabbitMQ的基本概念、异步调用处理逻辑、RabbitMQ的基本使用方法以及在SpringBoot项目中使用RabbitMQ解决高并发... 目录一.什么是RabbitMQ?二.异步调用处理逻辑:三.RabbitMQ的基本使用1.安装2.架构

Spring Boot统一异常拦截实践指南(最新推荐)

《SpringBoot统一异常拦截实践指南(最新推荐)》本文介绍了SpringBoot中统一异常处理的重要性及实现方案,包括使用`@ControllerAdvice`和`@ExceptionHand... 目录Spring Boot统一异常拦截实践指南一、为什么需要统一异常处理二、核心实现方案1. 基础组件

Java中使用Java Mail实现邮件服务功能示例

《Java中使用JavaMail实现邮件服务功能示例》:本文主要介绍Java中使用JavaMail实现邮件服务功能的相关资料,文章还提供了一个发送邮件的示例代码,包括创建参数类、邮件类和执行结... 目录前言一、历史背景二编程、pom依赖三、API说明(一)Session (会话)(二)Message编程客

windos server2022的配置故障转移服务的图文教程

《windosserver2022的配置故障转移服务的图文教程》本文主要介绍了windosserver2022的配置故障转移服务的图文教程,以确保服务和应用程序的连续性和可用性,文中通过图文介绍的非... 目录准备环境:步骤故障转移群集是 Windows Server 2022 中提供的一种功能,用于在多个