Spring Cloud Alibaba 快速上手搭建公司项目（三）GateWay

news2025/1/11 11:41:42

Gateway是Spring Cloud生态系统中的一个组件，它是一个基于Spring Cloud Gateway的API网关。它提供了一种简单、快速和可扩展的方式来管理微服务之间的请求流量。
它是一个轻量级的API网关，它可以轻松地与Spring Cloud集成，并提供了一些高级功能，如限流、熔断、路由、负载均衡等。它还支持多种协议，包括HTTP、WebSocket、TCP等。

特点

简单易用：Spring Cloud Alibaba Gateway非常易于使用，只需要添加相应的依赖即可快速搭建。
高性能：它采用了Nginx作为底层技术，可以提供高性能的请求处理能力。
灵活性：它支持多种路由规则和过滤器，可以根据需要进行自定义配置。
可扩展性：它可以通过插件机制扩展其功能，例如添加自定义过滤器、限流、熔断等功能。
多协议支持：它支持多种协议，包括HTTP、WebSocket、TCP等。

官方文档

GateWay官方文档（4.0.6 其他版本看历史记录）

官网文档对GateWay解释较为详细，下文简单使用几个配置使得请求能够通过网关进行分发。

工作原理

在这里插入图片描述
如官方工作原理图，可以推出以下案例：

前提条件：

具有一个网关服务名称gatewy,端口 9999
具有一个订单服务名称order, 端口8081
具有一个仓库服务名称storage,端口8082
三个服务都已经在Nacos中注册

工作步骤：

所有请求访问的是9999端口。
例如获取订单是127.0.0.1：9999/order/getById/1。查询库存是127.0.0.1：9999/storage/getById/1
gateway服务拿到请求后通过负载均衡去把这些请求分按照一定的规则分发到对应服务中。

微服务中整合

依赖

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!--特别注意：在 gateway 网关服务中不能引入 spring-boot-starter-web 的依赖，否则会报错-->
        <!-- Spring cloud gateway 网关依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.alibaba.cloud/spring-cloud-starter-alibaba-nacos-config -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
        <!--客户端负载均衡loadbalancer-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

poperties文件

spring.cloud.gateway.routes[0].id=my-order 
spring.cloud.gateway.routes[0].predicates[0]=Path=/order/**    # 前缀
spring.cloud.gateway.routes[0].uri=lb://order              #  lb为负载均衡

spring.cloud.gateway.routes[0].id=my-storage
spring.cloud.gateway.routes[0].predicates[0]=Path=/storage/**
spring.cloud.gateway.routes[0].uri=lb://storage

连接Nacos
没有Nacos可以用 Euraka。建议用Nacos,教程参考Spring Cloud & Alibaba 快速上手搭建公司项目（二）Nacos
配置全局过滤（根据需求决定）

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;

@Component
@Slf4j
public class MyGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("进入自定义的全局过滤器 MyGlobalFilter" + new Date());
        //使用服务提供者传参使用Params方式
        String str = exchange.getRequest().getQueryParams().getFirst("str");
        if (str == null) {
            log.info("参数 str 不能为 null！");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }
    @Override
    public int getOrder() {
        //过滤器的顺序，0 表示第一个
        return 0;
    }
}