一文掌握spring cloud gateway(總結(jié)篇)

更新時間：2024年12月23日 11:09:03 作者：壹佰大多

Spring Cloud Gateway是Spring Cloud的全新項目,該項目是基于Spring 5.0,Spring WebFlux和Project Reactor等技術(shù)開發(fā)的網(wǎng)關(guān),它旨在為微服務(wù)架構(gòu)提供一種簡單有效的統(tǒng)一的API路由管理方式,本文通過實例代碼總結(jié)介紹spring cloud gateway的相關(guān)知識,感興趣的朋友一起看看吧

什么是gateway

在微服務(wù)架構(gòu)中，gateway網(wǎng)關(guān)是一個服務(wù)，它作為系統(tǒng)的唯一入口點，處理所有的客戶端請求，然后將這些請求路由到適當(dāng)?shù)姆?wù)。提供了幾個關(guān)鍵功能：
1.請求路由：根據(jù)請求的URL路徑和其他參數(shù)，將請求路由到正確的后端服務(wù)。
2.負載均衡：在多個服務(wù)實例之間分配流量，以提高可用性和可擴展性。
3.認證和授權(quán)：檢查用戶是否有權(quán)訪問特定的服務(wù)。
4.限流：控制訪問后端服務(wù)的請求速率，以防止過載。
5.監(jiān)控：收集關(guān)于API使用情況的統(tǒng)計數(shù)據(jù)，用于分析和計費。
6.日志記錄：記錄所有通過網(wǎng)關(guān)的請求和響應(yīng)，以便進行問題排查和性能監(jiān)控。
7.緩存：提高響應(yīng)速度和減少后端負載，通過緩存常見的響應(yīng)。
8.過濾：檢驗當(dāng)前的請求是否符合請求的規(guī)則。

客戶端向 Spring Cloud Gateway 發(fā)出請求。如果 Gateway Handler Mapping 確定請求與路由匹配，則將其發(fā)送到 Gateway Web Handler。此處理程序通過特定于該請求的過濾器鏈運行該請求。過濾器被虛線分開的原因是過濾器可以在發(fā)送代理請求之前和之后運行邏輯。所有“前”過濾器邏輯都??會執(zhí)行。然后發(fā)出代理請求。發(fā)出代理請求后，運行“后”過濾器邏輯。

如何導(dǎo)入gateway依賴

1.導(dǎo)包

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>>2021.0.5</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2021.0.6.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
		<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
 		</dependency>

2.配置yaml文件

spring:
  cloud:
    gateway:
      discovery:
        locator:
          lower-case-service-id: true
          enabled: true
      default-filters:
        - name: CircuitBreaker
          args:
            name: myCircuitBreaker
            fallbackUri: forward:/fallback //默認的兜底策略
      routes:
      - id: fee-service
        uri: lb://fee-service //指定的服務(wù)
        predicates:
        - Path=/query  //斷言

路由配置

1.配置路由謂詞工廠和網(wǎng)關(guān)過濾器工廠
配置謂詞和過濾器有兩種方式：快捷方式和完全展開參數(shù)。
名稱和參數(shù)名稱將列code在每個部分的第一句或第二句中。參數(shù)通常按快捷方式配置所需的順序列出。
快捷方式配置由過濾器名稱識別，后跟等號（=），后跟用逗號分隔的參數(shù)值（,）。
配置文件實現(xiàn)：

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - Cookie=mycookie,mycookievalue

java代碼實現(xiàn)過濾方式：

@Configuration
public class GateConfig {
    @Bean
    public RouteLocator routeLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route(r -> r.path("/check")
                        .filters(f -> f.filter(new IpWhitelistFilter()))  // 注冊過濾器
                        .uri("lb://fee-service"))
                .build();
    }
}

package com.umpay.config;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
/**
 * @author zq
 * data 2024-12-18
 */
@Configuration
@Slf4j
public class IpWhitelistFilter implements GatewayFilter, Ordered {
    private static final String ALLOWED_IPS = "allowedIps";
    private static final String DENIED_IPS = "deniedIps";
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String clientIp=exchange.getRequest().getRemoteAddress().getAddress().getHostAddress();
        log.info("獲取到的ip:============:{}",clientIp);
        String responseBody = "{\"error\": \"Custom error message\"}";
        if(!"1111111".equals(clientIp)){
            exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
            exchange.getResponse().getHeaders().add("Content-Type", "application/json");
            return exchange.getResponse()
                    .writeWith(Mono.just(exchange.getResponse()
                            .bufferFactory().wrap(responseBody.getBytes())));
        }
        return chain.filter(exchange);
    }
    @Override
    public int getOrder() {
        return 0;
    }
}

gateway配置斷路器

導(dǎo)包

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-circuitbreaker-resilience4j</artifactId>
        </dependency>
        <dependency>
            <groupId>io.github.resilience4j</groupId>
            <artifactId>resilience4j-feign</artifactId>
        </dependency>
        <dependency>
            <groupId>io.github.resilience4j</groupId>
            <artifactId>resilience4j-reactor</artifactId>
        </dependency>

配置

spring:
  cloud: 
    gateway:
      discovery:
        locator:
          lower-case-service-id: true
          enabled: true
      default-filters:
        - name: CircuitBreaker
          args:
            name: myCircuitBreaker
            fallbackUri: forward:/fallback
      routes:
      - id: fee-service
        uri: lb://fee-service
        predicates:
        - Path=/query
        filters:
        - name: CircuitBreaker
          args:
            name: myCircuitBreaker
            fallbackUri: forward:/fallback
 //斷路器配置
 resilience4j:
  circuitbreaker:
    instances:
      myCircuitBreaker:
        slidingWindowSize: 10
        failureRateThreshold: 50
        minimumNumberOfCalls: 5
        waitDurationInOpenState: 10s

兜底接口

@RestController
@Slf4j
public class GateController {
    @Autowired
    private FeginClients feginClients;
    @GetMapping("/fallback")
    public Wrapper query(){
        log.info("test:================");
        return WrapperMapper.error();
    }
}

到此這篇關(guān)于spring cloud gateway 總結(jié)的文章就介紹到這了,更多相關(guān)spring cloud gateway內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: