如何實現SpringCloud Gateway請求響應日志

# 如何實現SpringCloud Gateway請求響應日志

## 目錄
- [一、前言](#一前言)
- [二、SpringCloud Gateway核心機制](#二springcloud-gateway核心機制)
  - [2.1 網關架構設計](#21-網關架構設計)
  - [2.2 核心過濾器鏈](#22-核心過濾器鏈)
- [三、基礎日志實現方案](#三基礎日志實現方案)
  - [3.1 全局日志過濾器](#31-全局日志過濾器)
  - [3.2 請求/響應體記錄](#32-請求響應體記錄)
- [四、高級日志增強方案](#四高級日志增強方案)
  - [4.1 鏈路追蹤集成](#41-鏈路追蹤集成)
  - [4.2 敏感信息脫敏](#42-敏感信息脫敏)
- [五、生產環境最佳實踐](#五生產環境最佳實踐)
  - [5.1 日志采樣策略](#51-日志采樣策略)
  - [5.2 性能優化技巧](#52-性能優化技巧)
- [六、可視化監控方案](#六可視化監控方案)
  - [6.1 ELK集成方案](#61-elk集成方案)
  - [6.2 Prometheus+Grafana](#62-prometheusgrafana)
- [七、總結與展望](#七總結與展望)

## 一、前言

在微服務架構中，API網關作為流量入口承擔著重要職責。SpringCloud Gateway作為SpringCloud生態的官方網關組件，其請求/響應日志的完整記錄對于以下場景至關重要：

1. **問題排查**：快速定位接口調用異常
2. **流量分析**：統計API調用頻率和性能指標
3. **安全審計**：追蹤敏感操作和潛在攻擊
4. **業務監控**：實時感知系統健康狀態

本文將深入探討從基礎實現到生產級優化的完整解決方案。

## 二、SpringCloud Gateway核心機制

### 2.1 網關架構設計

SpringCloud Gateway基于Reactor模式實現異步非阻塞處理，核心組件包括：

```java
// 典型網關配置示例
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
    return builder.routes()
        .route("user-service", r -> r.path("/api/user/**")
            .filters(f -> f.addRequestHeader("X-Trace-ID", UUID.randomUUID().toString()))
        .build();
}

2.2 核心過濾器鏈

網關處理流程中的關鍵過濾器：

三、基礎日志實現方案

3.1 全局日志過濾器

實現全局日志記錄的基礎方案：

@Component
public class LoggingFilter implements GlobalFilter, Ordered {

    private static final Logger log = LoggerFactory.getLogger(LoggingFilter.class);

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        long startTime = System.currentTimeMillis();
        
        // 請求日志記錄
        ServerHttpRequest request = exchange.getRequest();
        log.info("Request: {} {} from {}", request.getMethod(), 
                 request.getPath(), 
                 request.getRemoteAddress());
        
        // 響應日志記錄
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            ServerHttpResponse response = exchange.getResponse();
            log.info("Response: {} with status {} in {}ms", 
                     request.getPath(),
                     response.getStatusCode(),
                     System.currentTimeMillis() - startTime);
        }));
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

3.2 請求/響應體記錄

需要特別處理body內容的緩存：

// 請求體緩存裝飾器
public class RequestBodyCacheFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 只處理JSON請求
        if (exchange.getRequest().getHeaders().getContentType()
            .includes(MediaType.APPLICATION_JSON)) {
            
            return DataBufferUtils.join(exchange.getRequest().getBody())
                .flatMap(dataBuffer -> {
                    byte[] bytes = new byte[dataBuffer.readableByteCount()];
                    dataBuffer.read(bytes);
                    DataBufferUtils.release(dataBuffer);
                    
                    // 緩存請求體
                    exchange.getAttributes().put("cachedRequestBody", bytes);
                    return chain.filter(exchange.mutate().request(
                        new ServerHttpRequestDecorator(exchange.getRequest()) {
                            @Override
                            public Flux<DataBuffer> getBody() {
                                return Flux.just(exchange.getResponse()
                                    .bufferFactory().wrap(bytes));
                            }
                        }).build());
                });
        }
        return chain.filter(exchange);
    }
}

四、高級日志增強方案

4.1 鏈路追蹤集成

結合Sleuth實現分布式追蹤：

# application.yml配置
spring:
  sleuth:
    enabled: true
    gateway:
      enabled: true
    web:
      enabled: true
    sampler:
      probability: 1.0

日志格式優化：

// 改造日志輸出格式
log.info("[{}] {} {} headers={}", 
    traceId,
    request.getMethod(), 
    request.getURI(),
    request.getHeaders());

4.2 敏感信息脫敏

實現數據脫敏處理器：

public class DataMasker {
    private static final Pattern CREDIT_CARD = Pattern.compile("\\b(\\d{4}[ -]?){3}\\d{4}\\b");
    
    public static String maskSensitive(String input) {
        if (input == null) return null;
        
        // 銀行卡號脫敏
        Matcher matcher = CREDIT_CARD.matcher(input);
        return matcher.replaceAll(m -> 
            m.group().substring(0, 4) + "******" + 
            m.group().substring(m.group().length() - 4));
    }
}

五、生產環境最佳實踐

5.1 日志采樣策略

基于速率的采樣方案：

@Bean
public Sampler defaultSampler() {
    return new RateLimitingSampler(1000); // 每秒最多1000條日志
}

5.2 性能優化技巧

1. 異步日志記錄：使用Logback AsyncAppender
2. 內存緩存優化：限制body緩存大小
3. 條件過濾：忽略健康檢查端點

// 健康檢查路徑過濾
if (request.getPath().toString().contains("/actuator/health")) {
    return chain.filter(exchange);
}

六、可視化監控方案

6.1 ELK集成方案

日志收集架構：

Gateway -> Logstash -> Elasticsearch -> Kibana

Logback配置示例：

<appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
    <destination>logstash:5044</destination>
    <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
        <providers>
            <pattern>
                <pattern>{"app":"gateway","traceId":"%X{traceId}"}</pattern>
            </pattern>
        </providers>
    </encoder>
</appender>

6.2 Prometheus+Grafana

關鍵監控指標： - 請求吞吐量（requests/minute） - 平均響應時間（ms） - 錯誤率（5xx responses）

七、總結與展望

本文詳細介紹了從基礎到高級的日志實現方案，未來可擴展方向包括： 1. 基于的異常請求識別 2. 實時流量熱點分析 3. 自動化日志分析告警

最佳實踐建議：生產環境應結合具體業務場景選擇合適的日志級別和采樣率，在信息完整性和系統性能之間取得平衡。 “`

注：本文為概要性技術文檔，實際實現時需要根據具體業務需求進行調整。完整實現代碼示例和詳細配置建議可參考SpringCloud官方文檔及相關開源項目。