Routing und Filtern mit Spring Cloud Gateway

Microservices mit Spring Cloud, Teil 4 Routing und Filtern mit Spring Cloud Gateway

09.03.2022 Von Dr. Dirk Koller

In Microservice-Umgebungen ist es hilfreich, wenn bestimmte Funktionalitäten wie zum Beispiel Authentifizierung, Logging oder das Erfassen von Metriken über alle Dienste hinweg funktionieren; und das – bei mehreren Entwicklungsteams – auch noch auf die gleiche Art und Weise.

Erstellen des Gateway-Service im Initializr.
(Bild: Koller / Spring.io)

Die Lösung für dieses Problem ist es, diese Cross Cutting Concerns einer zentralen Instanz, einem API Gateway-Service zu überlassen. Eingehende Aufrufe laufen dann nicht mehr direkt vom Client zum Service, sondern nehmen den Umweg über das Gateway und werden von dort zum eigentlichen Empfänger geroutet. Auf dem zentralen Gateway lassen sich dann mithilfe von Filtern Aktionen wie Logging, Security-Überprüfungen und andere Funktionalitäten implementieren.

Für Spring Cloud gibt es mehrere dieser Gateways. Hier stellen wir das native Spring Cloud Gateway vor. Gegenüber dem bekannten und etwas älteren Zuul aus dem Netflix-Stack setzt Spring Cloud Gateway auf neuere Technologien wie Spring 5, Spring Boot 2 und Reactor und unterstützt Websockets.

Ein Test-Service

Um einen Service zum Testen zu haben, wird hier ein einfacher Service mit einem RestController (Dependency Spring Web im Initializr) implementiert. Er gibt beim Aufruf von http://localhost:8081/consumer/message (Achtung: server.port in application.properties anpassen!) eine Nachricht zurück:

```Java
@RestController
@SpringBootApplication
@RequestMapping("/consumer")
public class ConsumerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ConsumerApplication.class, args);
  }

  @GetMapping("/message")
  public String hello() {
    return "Hallo vom Consumer";
  }
}
```

Einrichten des Gateway-Service

Erstellen des Gateway-Service.
(Bild: Dr. Koller / Spring.io)

Das Gateway wird ebenfalls in Form eines Spring Boot-Service eingerichtet. Das Anlegen des Projekts erfolgt am einfachsten mit dem Initializr. Dabei ist lediglich die Abhängigkeit Gateway zwingend erforderlich.

Wer den Service stattdessen von Hand in POM.xml konfigurieren möchte, sollte beachten, dass der Initializr neben der Abhängigkeit spring-cloud-starter-gateway auch noch Spring Cloud in Form einer Property und einem Eintrag unter Dependency-Management einrichtet.

Definieren von Routen

Die Konfiguration der Routen erfolgt wahlweise programmatisch in einer Java-Konfiguration oder in der Properties-Datei application.properties bzw. application.yml wie im folgenden Beispiel. Eine Route besteht aus einer frei wählbaren Id, einem URI zu dem weitergeleitet wird und einem Prädikat, das die Bedingung beschreibt, die zur Weiterleitung einer Anfrage führt. Im Beispiel unten prüft das Prädikat auf den Pfad /consumer/**. Ist das zutreffend, wird zum angegebenen URI http://localhost:8081/ weitergeleitet:

```YML
spring:
  cloud:
    gateway:
      routes:
        - id: consumer_path
        uri: http://localhost:8081/
        predicates:
        - Path=/consumer/**
```

Ein Aufruf der Gateway-URL http://localhost:8080/consumer/message (der Default-Port 8080 wurde hier belassen) im Browser oder in Curl landet also bei http://localhost:8081/consumer/message und führt zur Anzeige der Nachricht vom Consumer-Service. Es gibt eine Menge weiterer Möglichkeiten, das Prädikat zu formulieren, etwa mithilfe von Zeitstempeln, der verwendeten HTTP-Methode und Query- oder Header-Parametern. Details dazu finden sich in der Dokumentation.

Erstellen von Filtern

Wie eingangs erwähnt, lassen sich auf dem Gateway Filter zur Bearbeitung von Standard- oder eigener Aufgaben einrichten. Für Standardaufgaben gibt es eine Reihe fertiger FilterFactories. Mit ihnen kann man zum Beispiel Request- oder Response-Header zufügen (AddRequestHeader, AddResponseHeader), Request-Parameter zufügen (AddRequestParameter) oder Umleiten (RedirectTo). Das folgende Beispiel zeigt die Verwendung des AddResponseHeader-Filters:

```YML
spring:
  cloud:
    gateway:
      routes:
      - id: consumer_path
        uri: http://localhost:8081/
        predicates:
        - Path=/consumer/**
        filters:
        - AddResponseHeader=X-Organization-Id, 4711
```

Eine komplette Liste aller Gateway-Filter findet sich in der Spring-Cloud-Gateway-Dokumentation unter GatewayFilter-Factories.

Eigene Filter erstellt man, indem man von einer der zahlreichen FilterFactories erbt oder die Interfaces GatewayFilter bzw. GlobalFilter implementiert. Globale Filter werden im Gegensatz zu Gateway-Filtern für alle Routen aufgerufen. Das folgende Beispiel zeigt das am Beispiel eines Pre-Filters, der vor dem Weiterleiten des Requests an den Service aufgerufen wird:

```Java
@Component
public class LoggingFilter implements GlobalFilter {

  final Logger logger =
    LoggerFactory.getLogger(LoggingFilter.class);

  @Override
  public Mono<Void> filter(
    ServerWebExchange exchange,
    GatewayFilterChain chain) {
      logger.info("Log vom Filter");
      return chain.filter(exchange);
  }
}
```

Selbstverständlich lassen sich auch Post-Filter implementieren, die dann nach dem Aufruf des Service vor der Rückgabe der Antwort an den Client abgearbeitet werden.

Hilfe beim Debugging

Funktionieren Routing oder Filter nicht wie gewünscht, empfiehlt sich das Anpassen des Log-Levels für das Gateway auf DEBUG oder TRACE in application.yml:

```YML

logging:
  level:
    org:
      springframework:
        cloud:
          gateway: TRACE
```

Im Log finden sich dann hilfreiche Informationen wie zum Beispiel die eingebundenen Routen:

```
Routes supplied from Gateway Properties: [RouteDefinition{id='consumer_path', predicates=[PredicateDefinition{name='Path', args={_genkey_0=/consumer/**}}], filters=[FilterDefinition{name='AddResponseHeader', args={_genkey_0=X-Organization-Id, _genkey_1=4711}}], uri=http://localhost:8081/, order=0, metadata={}}]
(...)
Netty started on port 8080
RouteDefinition consumer_path applying {_genkey_0=/consumer/**} to Path
RouteDefinition consumer_path applying filter {_genkey_0=X-Organization-Id, _genkey_1=4711} to AddResponseHeader
RouteDefinition matched: consumer_path
New routes count: 1
Started GatewayApplication in 3.76 seconds (JVM running for 4.482)
```

Eine weitere Möglichkeit, Problemen auf die Spur zu kommen, ist das Actuator-Framework, das zur Laufzeit Einblicke in das Innenleben der Spring-Anwendung gewährt. Wie in einem früheren Beitrag zum Spring Boot Actuator beschrieben, ist dazu die folgende Dependency einzubinden:

``` XML
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
```

Außerdem müssen die entsprechenden Endpoints freigegeben werden (hier der Einfachheit halber alle):

```YML
management:
  endpoints:
    web:
      exposure:
        include: "*"
```

Ein Aufruf der URL http://localhost:8080/actuator/gateway/routes liefert dann nützliche Daten zu den eingelesenen Routen und Filtern:

```JSON
[
  {
    "predicate": "Paths: [/consumer/**], match trailing slash: true",
    "route_id": "consumer_path",
    "filters": [
      "[[AddResponseHeader X-Organization-Id = '4711'], order = 1]"
    ],
    "uri": "http://localhost:8081/",
    "order": 0
  }
]
```

(ID:47972232)

Microservices mit Spring Cloud, Teil 4 Routing und Filtern mit Spring Cloud Gateway

Ein Test-Service

Einrichten des Gateway-Service

Definieren von Routen

Erstellen von Filtern

Hilfe beim Debugging

Jetzt Newsletter abonnieren

Täglich die wichtigsten Infos zu Softwareentwicklung und DevOps

Einwilligung in die Verwendung von Daten zu Werbezwecken

Karrierechancen