知識庫 / Spring / Spring Cloud RSS 訂閱

3.2. 使用 setRewriteFunction() 方法

現在，我們更深入地瞭解一下 `setRewriteFunction()` 方法。

此方法接受三個參數：兩個類（in 和 out）和一個可以從傳入類型轉換為傳出類型的函數。 在我們的情況下，我們不進行類型轉換，因此輸入和輸出都使用相同的類：JsonNode。 此類來自 Jackson 庫，並且位於 JSON 中表示不同節點類型的類層次結構的頂層，例如對象節點、數組節點等等。 使用 JsonNode 作為輸入/輸出類型允許我們處理任何有效的 JSON 負載，即我們希望在此時處理的負載。

對於轉換器類，我們傳遞一個 Scrubber 類的實例，該類在它的 apply() 方法中實現了所需的 RewriteFunction 接口：

public static class Scrubber implements RewriteFunction<JsonNode,JsonNode> {
    // ... fields and constructor omitted
    @Override
    public Publisher<JsonNode> apply(ServerWebExchange t, JsonNode u) {
        return Mono.just(scrubRecursively(u));
    }
    // ... scrub implementation omitted
}

傳遞給 apply() 的第一個參數是當前的 ServerWebExchange，這使我們能夠訪問請求處理的上下文。我們這裏不會使用它，但知道我們擁有這種能力是有益的。下一個參數是接收到的 body，已經轉換為 informed 類。

預期的返回值是一個 Publisher，包含 informed 類實例。只要我們不進行任何阻塞 I/O 操作，我們就可以在 rewrite 函數內部進行復雜的處理。

3.3. 清洗器（Scrubber）實現

現在我們已經瞭解了重寫函數的合同，接下來我們將最終實現我們的清洗器邏輯。 在此，我們假設報負載相對較小，因此我們無需擔心存儲接收對象的內存要求。

它的實現方式是遞歸地遍歷所有節點，查找與配置的模式匹配的屬性，並替換對應的值用於掩碼。

public static class Scrubber implements RewriteFunction<JsonNode,JsonNode> {
    // ... fields and constructor omitted
    private JsonNode scrubRecursively(JsonNode u) {
        if ( !u.isContainerNode()) {
            return u;
        }
        
        if (u.isObject()) {
            ObjectNode node = (ObjectNode)u;
            node.fields().forEachRemaining((f) -> {
                if ( fields.matcher(f.getKey()).matches() && f.getValue().isTextual()) {
                    f.setValue(TextNode.valueOf(replacement));
                }
                else {
                    f.setValue(scrubRecursively(f.getValue()));
                }
            });
        }
        else if (u.isArray()) {
            ArrayNode array = (ArrayNode)u;
            for ( int i = 0 ; i < array.size() ; i++ ) {
                array.set(i, scrubRecursively(array.get(i)));
            }
        }
        
        return u;
    }
}

4. 測試

我們提供了示例代碼中的兩個測試：一個簡單的單元測試和一個集成測試。前者只是一個標準的 JUnit 測試，用作清洗器（scrubber）的初步驗證。後者則更具價值，因為它展示了在 SCG 開發中使用的實用技術。

首先，需要提供一個實際的後端，以便可以發送消息。一種可能的方法是使用像 Postman 這樣的外部工具，但這可能會對典型的 CI/CD 場景產生問題。相反，我們將使用 JDK 中不太為人所知 <em >HttpServer</em> 類，該類實現了簡單的 HTTP 服務器。

@Bean
public HttpServer mockServer() throws IOException {
    HttpServer server = HttpServer.create(new InetSocketAddress(0),0);
    server.createContext("/customer", (exchange) -> {
        exchange.getResponseHeaders().set("Content-Type", "application/json");
        
        byte[] response = JSON_WITH_FIELDS_TO_SCRUB.getBytes("UTF-8");
        exchange.sendResponseHeaders(200,response.length);
        exchange.getResponseBody().write(response);
    });
    
    server.setExecutor(null);
    server.start();
    return server;
}

此服務器將處理請求，路徑為 /customer，並返回一個用於測試的固定 JSON 響應。請注意，返回的服務器已經啓動，並且會監聽隨機端口上的傳入請求。我們還指示服務器創建一個新的默認 Executor，用於管理處理請求的線程。

其次，我們通過編程方式創建路由 @Bean，其中包含我們的過濾器。這與使用配置屬性構建路由等效，但允許我們完全控制測試路由的所有方面：

@Bean
public RouteLocator scrubSsnRoute(
  RouteLocatorBuilder builder, 
  ScrubResponseGatewayFilterFactory scrubFilterFactory, 
  SetPathGatewayFilterFactory pathFilterFactory, 
  HttpServer server) {
    int mockServerPort = server.getAddress().getPort();
    ScrubResponseGatewayFilterFactory.Config config = new ScrubResponseGatewayFilterFactory.Config();
    config.setFields("ssn");
    config.setReplacement("*");
    
    SetPathGatewayFilterFactory.Config pathConfig = new SetPathGatewayFilterFactory.Config();
    pathConfig.setTemplate("/customer");
    
    return builder.routes()
      .route("scrub_ssn",
         r -> r.path("/scrub")
           .filters( 
              f -> f
                .filter(scrubFilterFactory.apply(config))
                .filter(pathFilterFactory.apply(pathConfig)))
           .uri("http://localhost:" + mockServerPort ))
      .build();
}

最終，這些 Bean 現在已成為一個 @TestConfiguration的一部分，我們可以將它們注入到實際的測試中，與一個 WebTestClient一起使用。實際的測試使用這個 WebTestClient來驅動生成的 SCG 以及後端：

@Test
public void givenRequestToScrubRoute_thenResponseScrubbed() {
    client.get()
      .uri("/scrub")
      .accept(MediaType.APPLICATION_JSON)
      .exchange()
      .expectStatus()
        .is2xxSuccessful()
      .expectHeader()
        .contentType(MediaType.APPLICATION_JSON)
      .expectBody()
        .json(JSON_WITH_SCRUBBED_FIELDS);
}

5. 結論

在本文中，我們展示瞭如何訪問後端服務的響應體，並使用 Spring Cloud Gateway 庫對其進行修改。