当前位置： 首页 > ops >正文

SpringCloud详细笔记

ops 2025/8/11 16:38:32

1. Nacos

1.1 简介与下载

Nacos 是 Dynamic Naming and Configuration Service 的首字母简称，一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

官网：Nacos官网

安装：

  • 下载最新的 Nacos 安装包，本文使用 Nacos-2.5.1

  • 启动命令：startup.cmd -m standalone

下载好最近的安装包后，解压到非中文目录，进入 bin 目录，执行启动命令。

1.2 服务注册

  1. 引入 spring-boot-starter-web、spring-cloud-starter-alibaba-nacos-discovery 依赖

  2. 编写主启动类，编写配置文件

  3. 配置 Naocs 地址

    spring:cloud:nacos:# 配置 Nacos 地址server-addr: 127.0.0.1:8848

  4. 启动微服务

  5. 查看注册中心效果，访问 http://localhost:8848/nacos/

  6. 测试集群模式启动：单机情况下通过改变端口号模拟微服务集群，例如添加 Program arguments 信息为 --server.port=8001

1.3 服务发现

  1. 开启服务发现，在主启动类上添加 @EnableDiscoveryClient 注解

  2. 测试两款 API 的服务发现功能：DiscoveryClient 和 NacosServiceDiscovery。前者为 Spring 提供的服务发现标准接口，后者由 Nacos 提供。

1.4 远程调用

远程调用基本流程：

1.5 负载均衡

使用 LoadBalancerClient 实现

注入 LoadBalancerClient，调用其 choose() 方法，传入服务名，实现负载均衡。

使用 @LoadBalanced 注解实现

在配置类中向 Spring 容器添加 RestTemplate 的 Bean，在 Bean 方法上添加 @LoadBalanced 注解，使用 RestTemplate 进行远程调用时，修改传入的 URL 为服务名，比如：

private Product getProductFromRemoteWithLoadBalancerAnnotation(Long productId) {// 给远程发送请求：service-product 会被动态替换String url = "http://service-product/product/" + productId;log.info("远程请求: {}", url);// 给远程发送请求return restTemplate.getForObject(url, Product.class);
}

此时底层会将服务名替换为负载均衡后的目标 URL。

经典面试题：如果注册中心宕机，远程调用是否可以成功？

  • 如果从未调用过，此时注册中心宕机，调用会立即失败

  • 如果调用过：

    • 此时注册中心宕机，会因为存在缓存的服务信息，调用会成功

    • 如果注册中心和对方服务都宕机，因为会缓存名单，调用会阻塞后失败（Connection Refused）

1.6 配置中心

配置中心的动态刷新步骤：

  • @Value("${xx}") 获取配置 + @RefreshScope 实现动态刷新

  • @ConfigurationProperties 无感自动刷新

  • NacosConfigManager 监听配置变化

如果存在多个相同的配置信息，那么：

1.7 数据隔离

一个项目通常部署在多套环境上，比如 dev、test、prod。

项目中每个微服务的配置信息在每套环境上的值可能不一样，要求项目可以通过切换环境，加载本环境的配置。

如果要完成以上需求，其中的难点是如何：

  • 区分多套环境

  • 区分多种微服务

  • 区分多种配置

  • 按需加载配置

Nacos 的解决方案：

  • 用名称空间区分多套环境

  • 用 Group 区分多种微服务

  • 用 Data-id 区分多种配置

  • 使用 SpringBoot 激活对应环境的配置

2. OpenFeign

2.1 简介与使用

OpenFeign，是一种 Declarative REST Client，即声明式 Rest 客户端，与之对应的是编程式 Rest 客户端，比如 RestTemplate。

OpenFeign 由注解驱动：

  • 指定远程地址：@FeignClien

  • 指定请求方式：@GetMapping、@PostMapping、@DeleteMapping...

  • 指定携带数据：@RequestHeader、@RequestParam、@RequestBody...

  • 指定返回结果：响应模式

其中的 @GetMapping 等注解可以沿用 Spring MVC：

  • 当它们标记在 Controller 上时，用于接收请求

  • 当他们标记在 FeignClien 上时，用于发送请求

使用时引入以下依赖：

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

在主启动类上使用以下注解：

@EnableFeignClients

  • 远程调用注册中心中的服务参考：ProductFeignClient

  • 远程调用指定 URL 参考：MockUrlFeignClient

2.2 小技巧

如何编写好 OpenFeign 声明式的远程调用接口：

  • 针对业务 API：直接复制对方的 Controller 签名即可；

  • 第三方 API：根据接口文档确定请求如何发

2.3 一道面试题

客户端负载均衡与服务端负载均衡的区别：

2.4 进阶用法

日志

在配置文件中指定 feign 接口所在包的日志级别：

logging:level:# 指定 feign 接口所在的包的日志级别为 debug 级别indi.mofan.order.feign: debug

向 Spring 容器中注册 feign.Logger.Level 对象：

@Bean
public Logger.Level feignlogLevel() {// 指定 OpenFeign 发请求时，日志级别为 FULLreturn Logger.Level.FULL;
}

超时控制

连接超时（connectTimeout），默认 10 秒。

读取超时（readTimeout），默认 60 秒。

如果需要修改默认超时时间，在配置文件中进行如下配置：

spring:cloud:openfeign:client:config:# 默认配置default:logger-level: fullconnect-timeout: 1000read-timeout: 2000# 具体 feign 客户端的超时配置service-product:logger-level: full# 连接超时，3000 毫秒connect-timeout: 3000# 读取超时，5000 毫秒read-timeout: 5000

重试机制

远程调用超时失败后，还可以进行多次尝试，如果某次成功则返回 ok，如果多次尝试后依然失败则结束调用，返回错误。

OpenFeign 底层默认使用 NEVER_RETRY，即从不重试策略。

向 Spring 容器中添加 Retryer 类型的 Bean：

@Bean
public Retryer retryer() {return new Retryer.Default();
}

这里使用 OpenFeign 的默认实现 Retryer.Default，在这种默认实现下：

public Default() {this(100L, TimeUnit.SECONDS.toMillis(1L), 5);
}

OpenFeign 的重试规则是：

  • 重试间隔 100ms

  • 最大重试间隔 1s。新一次重试间隔是上一次重试间隔的 1.5 倍，但不能超过最大重试间隔。

  • 最多重试 5 次

拦截器

以请求拦截器为例，自定义的请求拦截器需要实现 RequestInterceptor 接口，并重写 apply() 方法：

package indi.mofan.order.interceptor;
​
public class XTokenRequestInterceptor implements RequestInterceptor {/*** 请求拦截器** @param template 封装本次请求的详细信息*/@Overridepublic void apply(RequestTemplate template) {System.out.println("XTokenRequestInterceptor ...");template.header("X-Token", UUID.randomUUID().toString());}
}

要想要该拦截器生效有两种方法：

  1. 在配置文件中配置对应 Feign 客户端的请求拦截器，此时该拦截器只对指定的 Feign 客户端生效

    spring:cloud:openfeign:client:config:# 具体 feign 客户端service-product:# 该请求拦截器仅对当前客户端有效request-interceptors:- indi.mofan.order.interceptor.XTokenRequestInterceptor

  2. 还可以直接将自定义的请求拦截器添加到 Spring 容器中，此时该拦截器对服务内的所有 Feign 客户端生效

    @Component
public class XTokenRequestInterceptor implements RequestInterceptor {// --snip--
}

Fallback

Fallback，即兜底返回。

注意，此功能需要整合 Sentinel 才能实现。

因此需要先导入 Sentinel 依赖：

<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>

并在需要进行 Fallback 的服务的配置文件中开启配置：

feign:sentinel:enabled: true

现在需要对 Feign 客户端 ProductFeignClient 配置 Fallback，那么需要先实现 ProductFeignClient 编写兜底返回逻辑，并将其交由 Spring 管理：

@Component
public class ProductFeignClientFallback implements ProductFeignClient {@Overridepublic Product getProductById(Long id) {System.out.println("Fallback...");Product product = new Product();product.setId(id);product.setPrice(new BigDecimal("0"));product.setProductName("未知商品");product.setNum(0);return product;}
}

之后回到对应的 Feign 客户端，配置 Fallback：

@FeignClient(value = "service-product", fallback = ProductFeignClientFallback.class)
public interface ProductFeignClient {
​@GetMapping("/product/{id}")Product getProductById(@PathVariable("id") Long id);
}

3. Sentinel

官方文档：Sentinel

3.1 工作原理

随着微服务的流行，服务和服务之间的稳定性变得越来越重要。Spring Cloud Alibaba Sentinel 以流量为切入点，从流量控制、流量路由、熔断降级、系统自适应过载保护、热点流量防护等多个维度保护服务的稳定性。

定义规则：

  • 主流框架自动适配（Web Servlet、Dubbo、Spring Cloud、gRPC、Spring WebFlux、Reactor），所有 Web 接口均为资源

  • 编程式：SphU API

  • 声明式：@SentinelResource

定义资源：

  • 流量控制（FlowRule）

  • 熔断降级（DegradeRule）

  • 系统保护（SystemRule）

  • 来源访问控制（AuthorityRule）

  • 热点参数（ParamFlowRule）

3.2 整合 Sentinel

启动 Dashboard

前往 Sentinel GitHub Realease 页下载 Sentinel Dashboard，这里选择 1.8.8 版本，因此下载 sentinel-dashboard-1.8.8.jar。

在 sentinel-dashboard-1.8.8.jar 所在的目录运行以下命令，启动 Dashboard：

java -jar sentinel-dashboard-1.8.8.jar

启动完成后，浏览器访问 http://localhost:8080/，默认用户与密码均为 sentinel。

服务整合 Sentinel

引入依赖：

<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>

配置文件中添加：

spring:application:name: service-productcloud:sentinel:transport:# 控制台地址dashboard: localhost:8080# 立即加载服务  eager: true

配置完成后启动对应服务，再前往 Sentinel Dashboard 查看，能够看到对应服务信息。

可以在一个方法上使用 @SentinelResource 注解，将其标记为一个「资源」，当方法被调用时，能够在 Dashboard 的「簇点链路」上找到对应的资源，之后在界面上完成对资源的流控、熔断、热点、授权等操作。

3.3 异常处理

Web 接口

当 Web 接口作为资源被流控时，默认情况下会在页面显示：

​

Blocked by Sentinel (flow limiting)

​

如果需要自定义异常处理，可以实现 BlockExceptionHandler 接口，并将实现类交给 Spring 管理：

@Component
public class MyBlockExceptionHandler implements BlockExceptionHandler {
​private final ObjectMapper objectMapper;
​public MyBlockExceptionHandler(ObjectMapper objectMapper) {this.objectMapper = objectMapper;}
​@Overridepublic void handle(HttpServletRequest request,HttpServletResponse response,String resourceName,BlockException e) throws Exception {response.setContentType("application/json;charset=utf-8");PrintWriter writer = response.getWriter();
​R error = R.error(500, resourceName + " 被 Sentinel 限制了, 原因: " + e.getClass());
​String json = objectMapper.writeValueAsString(error);writer.write(json);
​writer.flush();writer.close();}
}

以 /create 接口为例，当其被流控时，页面显示：

{"code": 500,"message": "/create 被 Sentinel 限制了, 原因: class com.alibaba.csp.sentinel.slots.block.flow.FlowException","data": null
}

@SentinelResource

当 @SentinelResource 注解标记的资源被流控时，默认返回 500 错误页。

如果需要自定义异常处理，一般可以增加 @SentinelResource 注解的以下任意配置：

  • blockHandler

  • fallback

  • defaultFallback

以 blockHandler 为例：

@SentinelResource(value = "createOrder", blockHandler = "createOrderFallback")
public Order createOrder(Long productId, Long userId) {// --snip--
}

在当前类中创建名称为 blockHandler 值的方法，并且返回值类型、参数信息与 @SentinelResource 标记的方法一致（可以额外增加一个 BlockException 类型的参数）：

/*** 指定兜底回调*/
public Order createOrderFallback(Long productId, Long userId, BlockException e) {Order order = new Order();order.setId(0L);order.setTotalAmount(new BigDecimal("0"));order.setUserId(userId);order.setNickname("未知用户");order.setAddress("异常信息: " + e.getClass());return order;
}

当资源被流控时，执行 blockHandler 指定的方法：

{"id": 0,"totalAmount": 0,"userId": 666,"nickname": "未知用户","address": "异常信息: class com.alibaba.csp.sentinel.slots.block.flow.FlowException","productList": null
}

Feign 接口

当 Feign 接口作为资源并被流控时，如果调用的 Feign 接口指定了 fallback，那么就会使用 Feign 接口的 fallback 进行异常处理，否则由 SpringBoot 进行全局异常处理。

3.4 流控规则

流控，即流量控制（FlowRule），用于限制多余请求，从而保护系统资源不被耗尽。

阈值类型

Sentinel 的流控阈值规则有两种：

  1. QPS：Queries Per Second，用于限制资源每秒的请求次数，防止突发流量，应用于高频短时接口（如 API 网关）。当每秒的请求数超过设定的阈值时，就会触发流控。比如上图设置的 QPS = 5，就表示每秒最多允许 5 个请求。

  2. 并发线程数：用于限制同时处理该资源的线程数（即并发数），保护系统资源（线程池），应用于耗时操作（如数据库查询）。当处理该资源的线程数超过阈值时，就会触发流控。比如设置并发线程数为 5，表示最多允许 5 个线程同时处理该资源。

当勾选「是否集群」时，有两种集群阈值模式可供选择：

  1. 单机均摊：将设置的「均摊阈值」均摊到每个节点。以上图为例，假设集群有 3 个节点，那么每个节点的阈值都是 5；

  2. 总体阈值：整个集群共享设置的「均摊阈值」。假设集群有 3 个节点，这 3 个节点的的总阈值只有 5，比如按 2-2-1 的形式将阈值均摊到每个节点。

流控模式

配置流控规则时，可以点击下方的「高级选项」，在这里可以配置「流控模式」，共有三种可选项：

  1. 直接：默认选项。

  2. 关联：关联资源超阈值时，限流当前资源。

  3. 链路：仅对于某一路径下的资源访问生效。使用时需要在配置文件中设置 spring.cloud.sentinel.web-context-unify=false。

调用关系包括调用方、被调用方；一个方法又可能会调用其他方法，形成一个调用链路的层次关系；有了调用链路的统计信息，可以衍生出多种流量控制手段。

维度直接关联链路
作用对象当前资源本身关联的其他资源特定调用链路的入口
触发逻辑当前资源超阈值关联资源超阈值时，限流当前资源从指定入口发起的请求超阈值
核心目的保护当前资源保护关联资源或间接限流按入口细分流量控制
典型场景独立接口的直接限流资源依赖（如读操作限流写操作）区分不同调用来源
配置依赖无需额外配置需指定关联资源需指定资源访问入口

流控效果

打开流控规则中的高级配置后，还可以配置「流控效果」，同样有三种选项：

  1. 快速失败：默认选项。注意，只有该选项支持「流控模式」（直接、关联、链路）的设置。

  2. Warm Up：初始阈值较低（默认是设定阈值的 $\frac{1}{3}$），随后在预热时间内逐步提升至设定阈值。例如设定阈值为 3 QPS、预热时间 3 秒，初始阈值为 1 QPS，3 秒内逐步升至 3。

  3. 排队等待：基于漏桶算法，请求进入队列后按固定间隔时间匀速处理。若请求的预期等待时间超过设定的超时时间，则拒绝请求。

效果核心机制适用场景阈值动态变化流量特征
快速失败直接拒绝超出阈值的请求明确系统处理能力并快速保护固定阈值突发流量
Warm Up阈值逐步提升冷启动或流量突增的平滑过渡动态提升逐步增长的流量
排队等待匀速处理请求服务处理均匀，避免突发压力固定阈值均匀的流量

3.5 熔断规则

熔断规则，即 DegradeRule。

使用熔断规则可以配置熔断降级，用于：

  • 切断不稳定调用

  • 快速返回不积压

  • 避免雪崩效应

最佳实践： 熔断降级作为保护自身的手段，通常在客户端（调用端）进行配置。

熔断降级里的核心组件是「断路器」，其工作原理如下：

Sentinel 提供了三种熔断策略：

  1. 慢调用比例

  2. 异常比例

  3. 异常数

慢调用比例

在 5000ms 内，有 80%（0.8 的比例阈值）的请求的最大响应时间超过 1000ms，则进行 30s 的熔断。

如果 5000ms 内，请求数不超过 5，就算达到熔断规则，也不进行熔断。

异常比例

在远程调用的目标接口里添加 int i = 1 / 0; 模拟远程调用异常。

此时尚未配置任何熔断规则，然后远程调用存在异常的接口，此时会触发使用 OpenFeign 配置的兜底回调。

换句话说，没有配置任何熔断规则可以触发兜底回调，而配置熔断规则也是为了触发兜底回调，那岂不是配不配置熔断规则都可以？

当 A 服务向 B 服务发送请求时，远程调用的 B 服务接口中存在异常，此时触发兜底回调。

在这个过程，由 A 服务发送的请求依旧会打到 B 服务上。

而配置熔断规则后，A 服务发送的请求快速失败，立即出发兜底回调，不会再把请求打到 B 服务上。

在 5000ms 内，有 80%（0.8 的比例阈值）的请求产生了异常，则进行 30s 的熔断。

异常数

「异常数」的熔断策略与「异常比例」很类似，只不过「异常数」是直接统计异常个数，就算统计时长内产生了一百万个请求，但只要有 10 个请求出现了异常，也会触发熔断。

3.6 热点规则

所谓热点，即经常访问的数据。很多时候希望统计某个热点数据中访问频次最高的 Top K 数据，并对其访问进行限制。比如：

  • 商品 ID 为参数，统计一段时间内最常购买的商品 ID 并进行限制

  • 用户 ID 为参数，针对一段时间内频繁访问的用户 ID 进行限制

热点参数限流会统计传入参数中的热点参数，并根据配置的限流阈值与模式，对包含热点参数的资源调用进行限流。

热点参数限流可以看做是一种特殊的流量控制，仅对包含热点参数的资源调用生效。

Sentinel 利用 LRU 策略统计最近最常访问的热点参数，结合令牌桶算法来进行参数级别的流控。

在需求中学习

现有如下需求：

  • 每个用户秒杀 QPS 不得超过 1（秒杀下单时，userId 级别）

  • 6 号用户是 vvip，不限制 QPS（例外情况）

  • 666 号商品是下架商品，不允许访问

在 Sentinel GitHub Wiki 中指出：

  • 目前 Sentinel 自带的 adapter 仅 Dubbo 方法埋点带了热点参数，其它适配模块（如 Web）默认不支持热点规则，可通过自定义埋点方式指定新的资源名并传入希望的参数。注意自定义埋点的资源名不要和适配模块生成的资源名重复，否则会导致重复统计。

@GetMapping("/seckill")
@SentinelResource(value = "seckill-order", fallback = "seckillFallback")
public Order seckill(@RequestParam(value = "userId", required = false) Long userId,@RequestParam(value = "productId", defaultValue = "1000") Long productId) {Order order = orderService.createOrder(productId, userId);order.setId(Long.MAX_VALUE);return order;
}
​
public Order seckillFallback(Long userId,Long productId,// 使用 fallback，而不是 blockHandler// 最后一个参数类型是 Throwable，而不是 BlockExceptionThrowable throwable) {System.out.println("seckillFallback...");Order order = new Order();order.setId(productId);order.setUserId(userId);order.setAddress("异常信息: " + throwable.getClass());return order;
}

对 seckill-order 资源进行如下热点规则配置：

这表示：访问 seckill-order 资源时，第一个参数（参数索引 0）在 1 秒的统计窗口时长下，其阈值为 1，也就是 QPS = 1。

需要注意：携带此参数，则参与流控；不携带不流控。

@GetMapping("/seckill")
@SentinelResource(value = "seckill-order", fallback = "seckillFallback")
public Order seckill(@RequestParam(value = "userId", defaultValue = "888") Long userId,@RequestParam(value = "productId", defaultValue = "1000") Long productId) {// --snip--
}

上述代码中，userId 的默认值为 888，也就是以 http://localhost:8000/seckill?productId=777 的形式进行访问时，userId 的值为 888，此时依旧传入了 userId，依旧触发流控。

@GetMapping("/seckill")
@SentinelResource(value = "seckill-order", fallback = "seckillFallback")
public Order seckill(@RequestParam(value = "userId", required = false) Long userId,@RequestParam(value = "productId", defaultValue = "1000") Long productId) {// --snip--
}

上述代码中，userId 可以不传，当以 http://localhost:8000/seckill?productId=777 的形式进行访问时，userId 为 null，没有传入 userId，不会触发流控。

经过上述配置，已经完成「每个用户秒杀 QPS 不得超过 1」的需求，但「6 号用户」是个例外：

访问 seckill-order 资源时，第一个参数（参数索引 0）的类型是 long，当其值为 6 时，限流阈值为 1000000，变相不限制「6 号用户」的 QPS。

现在还有最后一个需求「666 号商品是下架商品，不允许访问」，这其实相当于：对 666 号商品进行流控（限流阈值为 0，不允许访问），对其他商品不进行流控（或阈值非常大）。

新增热点规则：

访问 seckill-order 资源时，第二个参数（参数索引 1）在 1 秒的统计窗口时长下，其阈值为 1000000，这是一个无法达到的值，相当于不进行限流。但有一个例外：当其值为 666 时，限流阈值为 0，也就是不允许访问。

4. Gateway

4.1 路由

需求：

  1. 客户端发送 /api/order/** 转到 service-order

  2. 客户端发送 /api/product/** 转到 service-product

  3. 以上转发有负载均衡效果

配置路由规则时，可直接在配置文件中完成：

spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.compredicates:- Path=/**order: 10# id 全局唯一- id: order-route# 指定服务名称uri: lb://service-order# 指定断言规则，即路由匹配规则predicates:- Path=/api/order/**order: 1- id: product-routeuri: lb://service-productpredicates:- Path=/api/product/**order: 2

Gateway 路由的工作原理如下：

4.2 断言

官方文档：Route Predicate Factories

断言的两种书写方式：

spring:cloud:gateway:routes:# id 全局唯一- id: order-route# 指定服务名称uri: lb://service-order# 指定断言规则，即路由匹配规则# Fully Expanded Argumentspredicates:- name: Pathargs:patterns: /api/order/**matchTrailingSlash: true- id: product-routeuri: lb://service-product# Shortcut Configurationpredicates:- Path=/api/product/**

在 Spring Cloud Gateway 的实现中，断言的实现都是 RoutePredicateFactory 接口的实现。

因此除了直接查看官方文档外确定有哪些断言形式外，还可以通过查看 RoutePredicateFactory 的实现：

  • HeaderRoutePredicateFactory

  • PathRoutePredicateFactory

  • ReadBodyRoutePredicateFactory

  • BeforeRoutePredicateFactory

  • ...

断言的名称可以通过去掉实现类名后的 RoutePredicateFactory 来确定，比如 HeaderRoutePredicateFactory 对应名为 Header 的断言。

名称参数（个数/类型）作用
After1/datetime在指定时间之后
Before1/datetime在指定时间之前
Between2/datetime在指定时间区间内
Cookie2/string,regexp包含 cookie 名且必须匹配指定值
Header2/string,regexp包含请求头且必须匹配指定值
HostN/string请求 host 必须是指定枚举值
MethodN/string请求方式必须是指定枚举值
Path2/List<String>,bool请求路径满足规则，是否匹配最后的 /
Query2/string,regexp包含指定请求参数
RemoteAddr1/List<String>请求来源于指定网络域（CIDR写法）
Weight2/string,int按指定权重负载均衡
XForwardedRemoteAddr1/List<String>从 X-Forwarded-For 请求头中解析请求来源，并判断是否来源于指定网络域

以 Query 为例：

spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.compredicates:- name: Pathargs:patterns: /search- name: Queryargs:param: qregexp: haha

这表示：访问网关的 /search 地址，并且使用了名为 q 的请求参数，且值为 haha，才会将请求转到 https://cn.bing.com。

尽管 Gateway 内置了许多断言规则，但依旧难以满足千变万化的需求。

在上述规则的基础上，再指定一个名为 Vip 的断言规则，要求存在名为 user 的请求参数，并且值为 mofan 时才将请求跳转到 https://cn.bing.com：

spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.compredicates:- name: Pathargs:patterns: /search- name: Queryargs:param: qregexp: haha- Vip=user,mofan

自定义 AbstractRoutePredicateFactory 实现类 VipRoutePredicateFactory：

/*** @author mofan* @date 2025/4/29 22:49*/
@Component
public class VipRoutePredicateFactory extends AbstractRoutePredicateFactory<VipRoutePredicateFactory.Config> {
​
​public VipRoutePredicateFactory() {super(Config.class);}
​@Overridepublic List<String> shortcutFieldOrder() {return List.of("param", "value");}
​@Overridepublic Predicate<ServerWebExchange> apply(Config config) {return (GatewayPredicate) serverWebExchange -> {// localhost/search?q=haha&user=mofanServerHttpRequest request = serverWebExchange.getRequest();String first = request.getQueryParams().getFirst(config.param);return StringUtils.hasText(first) && first.equals(config.value);};}
​@Validated@Getter@Setterpublic static class Config {@NotEmptyprivate String param;@NotEmptyprivate String value;}
}

然后访问 http://localhost/search?q=haha&user=mofan 时，会跳转到 Bing 搜索 haha。

4.3 过滤器

官方文档：GatewayFilter Factories

先前在网关中配置了将 /api/order/ 开头的请求转到 service-order 服务，并要求在 service-order 服务中也存在 /api/order/ 开头的请求路径，比如 /api/order/readDb。如果该服务中原先并不存在 /api/order/ 开头的请求，比如只有 /readDb，那么在以 /api/order/readDb 进行访问就会出现 404 错误。

为了解决这个问题，可以在 service-order 服务对应的 Controller 上添加 @RequestMapping("/api/order") 注解，但这并不是最佳方案，如果能直接在网关层面解决这个问题就好了，就像把 /api/order/readDb 重写为 /readDb。

Gateway 中内置了许多过滤器，其中有一个常用的过滤器名为：RewritePath，即路径重写。

spring:cloud:gateway:routes:# id 全局唯一- id: order-route# 指定服务名称uri: lb://service-order# 指定断言规则，即路由匹配规则# Fully Expanded Argumentspredicates:- name: Pathargs:patterns: /api/order/**matchTrailingSlash: truefilters:# 类似把 /api/order/a/bc 重写为 /a/bc，移除路径前的 /api/order/- RewritePath=/api/order/?(?<segment>.*), /$\{segment}order: 1- id: product-routeuri: lb://service-product# Shortcut Configurationpredicates:- Path=/api/product/**filters:- RewritePath=/api/product/?(?<segment>.*), /$\{segment}order: 2

默认过滤器

如果需要为所有路由都添加同一个过滤器，则可以使用 默认过滤器，比如：

spring:cloud:gateway:default-filters:# 为所有路由添加响应头过滤器- AddResponseHeader=X-Response-Abc, 123

全局过滤器

除了默认过滤器，全局过滤器也能为所有匹配的路由添加一个过滤器，全局过滤器的配置无需修改配置文件。

实现 GlobalFilter 接口，并将实现类交由 Spring 管理，即可实现全局过滤器。

还可以实现 Ordered 接口，调整多个全局过滤器的执行顺序。

/*** @author mofan* @date 2025/5/1 13:49*/
@Slf4j
@Component
public class RtGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {ServerHttpRequest request = exchange.getRequest();String uri = request.getURI().toString();long start = System.currentTimeMillis();log.info("请求 [{}] 开始，时间：{}", uri, start);return chain.filter(exchange).doFinally(res -> {long end = System.currentTimeMillis();log.info("请求 [{}] 结束，时间：{}，耗时：{}ms", uri, start, end - start);});}
​@Overridepublic int getOrder() {return 0;}
}

自定义过滤器工厂

尽管 Gateway 内置了许多过滤器，但仍有无法满足需求的情况，此时就需要自定义过滤器工厂。

与自定义断言类似，自定义过滤器工厂的类名也有限制，要求以 GatewayFilterFactory 结尾，而配置文件中配置的名称就是类名开头。

比如需要在配置文件中定义名为 OnceToken 的过滤器，那么需要新增 OnceTokenGatewayFilterFactory：

/*** @author mofan* @date 2025/5/1 14:24*/
@Component
public class OnceTokenGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {@Overridepublic GatewayFilter apply(NameValueConfig config) {return (exchange, chain) -> chain.filter(exchange).then(Mono.fromRunnable(() -> {ServerHttpResponse response = exchange.getResponse();
​String value = switch (config.getValue().toLowerCase()) {case "uuid" -> UUID.randomUUID().toString();case "jwt" -> "Test Token";default -> "";};
​HttpHeaders headers = response.getHeaders();headers.add(config.getName(), value);}));}
}
spring:cloud:gateway:routes:- id: order-routeuri: lb://service-orderfilters:# 自定义过滤器- OnceToken=X-Response-Token, uuid

4.4 全局跨域

如果需要配置跨域，可以在 Controller 的类上添加 @CrossOrigin 注解。

如果有许多 Controller，逐一添加注解太麻烦，可以在项目的配置类中添加 CorsFilter 类型的 Bean。

上述方法只适用于单体服务，那如果在微服务中呢？

借由 Gateway 的功能，可以在配置文件中轻松完成微服务的跨域配置：

spring:cloud:gateway:globalcors:cors-configurations:'[/**]':allowed-origin-patterns: '*'allowed-headers: '*'allowedMethods: '*'

之后在请求的 Response Headers 中会增加一些允许跨域的信息。

5. Seata

在微服务项目中，一个操作往往会涉及多个不同的服务，每个服务又会连接不同的数据库：

此时应该如何保证多个事务的统一提交和统一回滚呢？

Seata 是一款开源的分布式事务解决方案，致力于在微服务架构下提供高性能和简单易用的分布式事务服务。

现有如下交易流程：

发起采购流程后，需要扣库存、生成订单、从账户中扣除指定金额，任一流程发生异常时，整个流程应当回滚。

  • TC：Transaction Coordinator，即事务协调者。维护全局和分支事务的状态，驱动全局事务提交或回滚；

  • TM：Transaction Manager，即事务管理器。定义全局事务的范围，开始全局事务、提交或回滚全局事务；

  • RM：Resource Manager，即资源管理器。管理分支事务处理的资源，与 TC 交谈以注册分支事务和报告分支事务的状态，并驱动分支事务提交或回滚。

下载并解压 Seata 后，进入 bin 目录，使用 seata-server.bat 命令启动 Seata。

下载的 Seata 版本保证与 pom 文件中引入的 spring-cloud-alibaba-dependencies 依赖中的 Seata 版本一致。

在需要使用分布式事务的模块中添加依赖：

<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-seata</artifactId>
</dependency>

在需要使用 Seata 的模块中添加 Seata 的配置文件 file.conf ：

service {#transaction service group mappingvgroupMapping.default_tx_group = "default"#only support when registry.type=file, please don't set multiple addressesdefault.grouplist = "127.0.0.1:8091"#degrade, current not supportenableDegrade = false#disable seatadisableGlobalTransaction = false
}

最后在最顶端的方法入口上使用 @GlobalTransactional 注解，由此开启全局事务。

http://www.xdnf.cn/news/17479.html

相关文章：

  • reinterpret_cast and static cast
  • 【PyTorch】单目标检测项目
  • 深度解析1688关键字搜索API接口：技术实现与应用探索
  • crc32算法php版----crc32.php
  • 什么是ABA问题？
  • 【牛客刷题】REAL800 棋盘
  • 随想记——excel报表
  • WinForm之TreeView控件
  • Excel版经纬度和百分度互转v1.1
  • 复现论文《多无人机协同任务分配算法设计与实现》
  • 【YOLO11改进 - C3k2融合】C3k2融合EBlock(Encoder Block)：低光增强编码器块，利用傅里叶信息增强图像的低光条件
  • Spring 依赖注入、AOP代理
  • Stlink识别不到-安装驱动
  • Redis基本原理,性能优化和参数调优简述
  • Lua基础+Lua数据类型
  • 正则表达式常用语法参考
  • es查询小结
  • 机械学习--DBSCAN 算法（附实战案例）
  • 本地WSL部署接入 whisper + ollama qwen3:14b 总结字幕校对增强版
  • C++基础语法积累
  • Rust进阶-part6-宏
  • LLaMA-Adapter V2 Parameter-Efficient Visual Instruction Model
  • Shell脚本-数组定义
  • Android 四大布局：使用方式与性能优化原理
  • ELK分布式日志采集系统
  • 手写 Spring
  • 《Go小技巧易错点100例》第三十七篇
  • 创建降阶模型用于搅拌槽中的涡流预测
  • 线性代数1000题学习笔记
  • 【机器学习深度学习】Embedding 模型详解：从基础原理到实际应用场景