Unterstützung für Spring Cloud Azure Kafka

Spring Cloud Azure Kafka-Unterstützung hilft Spring-Anwendungen bei der Authentifizierung und Verbindung mit Azure Event Hubs mithilfe von OAuth-Anmeldeinformationen oder Verbindungszeichenfolgen. In diesem Artikel werden die unterstützten Authentifizierungstypen, Konfigurationsoptionen, Abhängigkeiten und Verwendungsszenarien beschrieben.

Unterstützte Kafka-Version

Die aktuelle Version des Starters ist kompatibel mit Apache Kafka Clients 2.0.0 und verwendet Java 8 oder höher.

Unterstützte Authentifizierungstypen

Der Start unterstützt die folgenden Authentifizierungstypen:

• Einfache Verbindungszeichenfolgenauthentifizierung
  • Direkte Verbindungszeichenfolgenauthentifizierung
  • ARM-basierte Verbindungszeichenfolgenauthentifizierung
• Authentifizierung von OAuth-Anmeldeinformationen
  • Verwaltete Identitätsauthentifizierung
  • Benutzername/Kennwortauthentifizierung
  • Dienstprinzipalauthentifizierung
  • DefaultAzureCredential Authentifizierung

Funktionsweise

Authentifizierung von OAuth-Anmeldeinformationen

In diesem Abschnitt wird der allgemeine Workflow der Spring Cloud OAuth-Authentifizierung beschrieben.

Spring Cloud Azure erstellt zunächst eine der folgenden Arten von Anmeldeinformationen, je nach Anwendungsauthentifizierungskonfiguration:

• ClientSecretCredential
• ClientCertificateCredential
• UsernamePasswordCredential
• ManagedIdentityCredential

Wenn die Anwendung keinen dieser Arten von Anmeldeinformationen verwendet, verwendet die Anwendung die Anmeldeinformationskette DefaultAzureTokenCredential , um Anmeldeinformationen von Anwendungseigenschaften, Umgebungsvariablen, verwalteter Identität oder IDEs abzurufen. Ausführliche Informationen finden Sie unter Spring Cloud Azure authentication.

Einfache Verbindungszeichenfolgenauthentifizierung

Für den Authentifizierungsmodus der Verbindungszeichenfolge können Sie die Verbindungszeichenfolgenauthentifizierung direkt verwenden oder den Azure Resource Manager verwenden, um die Verbindungszeichenfolge abzurufen. Weitere Informationen zur Verwendung finden Sie im Abschnitt Grundlegende Verwendung für die Verbindungszeichenfolgenauthentifizierung Abschnitt.

Konfiguration

Konfigurierbare Eigenschaften bei Verwendung der Kafka-Unterstützung mit OAuth-Authentifizierung

Spring Cloud Azure für Kafka unterstützt die folgenden beiden Konfigurationsoptionen:

1. Spring Cloud Azure für Event Hubs Kafka-Eigenschaften.
2. Die globalen Authentifizierungskonfigurationsoptionen von credential und profile mit Präfixen von spring.cloud.azure.
3. Kafka-spezifische Levelkonfigurationen. Die Konfigurationen auf Kafka-Ebene sind auch für Spring Boot- und Spring Cloud Stream-Ordner für common, consumer, produceroder admin Bereiche verfügbar, die unterschiedliche Präfixe haben.

Die globalen Eigenschaften werden über com.azure.spring.cloud.autoconfigure.context.AzureGlobalPropertiesverfügbar gemacht. Die kafka-spezifischen Eigenschaften werden über org.springframework.boot.autoconfigure.kafka.KafkaProperties (Spring Boot) und org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties (Spring Cloud Stream Binder) verfügbar gemacht.

In der folgenden Liste sind alle unterstützten Konfigurationsoptionen aufgeführt.

• Spring Cloud Azure für Event Hubs Kafka-Eigenschaften.

  • Eigenschaft: spring.cloud.azure.eventhubs.kafka.enabled
  • Beschreibung: Gibt an, ob die kostenlose Verbindung mit Anmeldeinformationen zu Azure Event Hubs für Kafka aktiviert werden soll, der Standardwert ist true.

• Die Konfigurationsoptionen für die globale Azure-Authentifizierung in Spring Cloud

  • Präfix: spring.cloud.azure
  • Unterstützte Optionen: spring.cloud.azure.credential.*, spring.cloud.azure.profile.*

  Eine vollständige Liste der globalen Konfigurationsoptionen finden Sie unter globalen Konfigurationseigenschaften.

• Allgemeine Konfiguration des Spring Boot Kafka

  • Präfix: spring.kafka.properties.azure
  • Beispiel: spring.kafka.properties.azure.credential.*

• Konfigurationsoptionen für Spring Kafka-Consumer

  • Präfix: spring.kafka.consumer.properties.azure
  • Beispiel: spring.kafka.consumer.properties.azure.credential.*

• Konfigurationsoptionen für Spring Kafka-Produzenten

  • Präfix: spring.kafka.producer.properties.azure
  • Beispiel: spring.kafka.producer.properties.azure.credential.*

• Konfigurationsoptionen für Spring Kafka-Administratoren

  • Präfix: spring.kafka.admin.properties.azure
  • Beispiel: spring.kafka.admin.properties.azure.credential.*

• Allgemeine Konfiguration von Spring Cloud Stream Kafka Binder

  • Präfix: spring.cloud.stream.kafka.binder.configuration.azure
  • Beispiel: spring.cloud.stream.kafka.binder.configuration.azure.credential.*

• Spring Cloud Stream Kafka Binder Consumer Configuration

  • Präfix: spring.cloud.stream.kafka.binder.consumer-properties.azure
  • Beispiel: spring.cloud.stream.kafka.binder.consumer-properties.azure.credential.*

• Feder Cloud Stream Kafka Binder Producer-Konfiguration

  • Präfix: spring.cloud.stream.kafka.binder.producer-properties.azure
  • Beispiel: spring.cloud.stream.kafka.binder.producer-properties.azure.credential.*

• Feder Cloud Stream Kafka Binder-Administratorkonfiguration

  • Präfix: Nicht unterstützt, verwenden Sie die allgemeine Spring Boot Kafka- oder Administratorkonfiguration.

Die folgende Tabelle zeigt die allgemeinen Konfigurationsoptionen für Spring Boot Kafka:

Konfigurierbare Eigenschaften bei Verwendung der Kafka-Unterstützung mit einfacher Verbindungszeichenfolgenauthentifizierung

In der folgenden Tabelle sind die allgemeinen Konfigurationsoptionen für Kafka für Spring Boot Event Hubs aufgeführt:

Setup von Abhängigkeiten

Fügen Sie dem Projekt die folgende Abhängigkeit hinzu. Diese Abhängigkeit schließt automatisch die spring-boot-starter Abhängigkeit in Ihr Projekt ein.

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>

Grundlegende Nutzung

Die folgenden Abschnitte zeigen die klassischen Anwendungsverwendungsszenarien für Spring Boot.

Verwenden der OAuth-Authentifizierung

Wenn Sie die OAuth-Authentifizierung verwenden, die Spring Cloud Azure für Kafka bereitstellt, können Sie bestimmte Anmeldeinformationen mithilfe der vorherigen Konfigurationen konfigurieren. Alternativ können Sie auswählen, dass keine Anmeldeinformationen konfiguriert werden sollen. In diesem Fall lädt Spring Cloud Azure die Anmeldeinformationen aus der Umgebung. In diesem Abschnitt wird beschrieben, wie Anmeldeinformationen aus der Azure CLI-Umgebung oder der Azure Spring Apps-Hostingumgebung geladen werden.

Im folgenden Abschnitt werden Szenarien beschrieben, in denen verschiedene Spring-Ökosystembibliotheken mit OAuth-Authentifizierung verwendet werden.

Unterstützung der Spring Kafka-Anwendung

In diesem Abschnitt wird das Verwendungsszenario für eine Spring Boot-Anwendung beschrieben, die Spring Kafka oder die Spring Integration Kafka-Bibliothek verwendet.

Setup von Abhängigkeiten

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
<!-- Using Spring Kafka library only-->
<dependency>
    <groupId>org.springframework.kafka</groupId>
    <artifactId>spring-kafka</artifactId>
    <version>{version}</version><!--Need to be set, for example:2.8.6-->
</dependency>
<!-- Using Spring Integration library only -->
<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-kafka</artifactId>
    <version>{version}</version><!--Need to be set, for example:5.5.12-->
</dependency>

Konfigurationsupdate

Um die OAuth-Authentifizierung zu verwenden, geben Sie den Event Hubs-Endpunkt an, wie im folgenden Beispiel gezeigt:

spring.kafka.bootstrap-servers=<NAMESPACENAME>.servicebus.windows.net:9093

Unterstützung der Feder Cloud Stream-Ordner-Kafka-Anwendung

In diesem Abschnitt wird das Verwendungsszenario für Spring Boot-Anwendungen beschrieben, die die Feder Cloud Stream-Ordner-Kafka-Bibliothek verwenden.

Setup von Abhängigkeiten

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-stream-kafka</artifactId>
    <version>{version}</version><!--Need to be set, for example:3.2.3-->
</dependency>

Konfiguration

Um die OAuth-Authentifizierung zu verwenden, geben Sie den Event Hubs-Endpunkt an, wie im folgenden Beispiel gezeigt:

spring.cloud.stream.kafka.binder.brokers=<NAMESPACENAME>.servicebus.windows.net:9093

Verwenden der verwalteten Identität für die OAuth-Authentifizierung

1. Um verwaltete Identität zu verwenden, aktivieren Sie verwaltete Identität für Ihren Dienst, und weisen Sie die Azure Event Hubs Data Receiver rollen zu Azure Event Hubs Data Sender . Weitere Informationen finden Sie unter Zuweisen von Azure-Rollen für Zugriffsberechtigungen.

2. Konfigurieren Sie die folgenden Eigenschaften in Ihrer application.yml Datei:

   spring:
     cloud:
       azure:
         credential:
           managed-identity-enabled: true
   

   Wichtig

   Wenn Sie die vom Benutzer zugewiesene verwaltete Identität verwenden, fügen Sie die Eigenschaft spring.cloud.azure.credential.client-id auch mit Ihrer vom Benutzer zugewiesenen Client-ID für verwaltete Identität hinzu.

Proben

Sehen Sie sich das azure-spring-boot-samples Repository auf GitHub an.

Verwenden der Verbindungszeichenfolgenauthentifizierung

Sie können die Verbindungszeichenfolgenauthentifizierung direkt verwenden oder den Azure Resource Manager verwenden, um die Verbindungszeichenfolge abzurufen.

Setup von Abhängigkeiten

Fügen Sie die folgenden Abhängigkeiten hinzu, wenn Sie Ihre Apache Kafka-Anwendung migrieren möchten, um Azure Event Hubs für Kafka zu verwenden.

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>

Wenn Sie die Verbindungszeichenfolge mithilfe von Azure Resource Manager abrufen möchten, fügen Sie die folgende Abhängigkeit hinzu:

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-resourcemanager</artifactId>
</dependency>

Konfiguration

Verwenden der Event Hubs-Verbindungszeichenfolge direkt

Die einfachste Möglichkeit zum Herstellen einer Verbindung mit Event Hubs für Kafka ist die Verbindungszeichenfolge. Fügen Sie einfach die folgende Eigenschaft hinzu.

spring.cloud.azure.eventhubs.connection-string=${AZURE_EVENTHUBS_CONNECTION_STRING}

Verwenden von Azure Resource Manager zum Abrufen der Verbindungszeichenfolge

Wenn Sie die Verbindungszeichenfolge in Ihrer Anwendung nicht konfigurieren möchten, können Sie azure Resource Manager verwenden, um die Verbindungszeichenfolge abzurufen. Um sich bei Azure Resource Manager zu authentifizieren, können Sie auch Anmeldeinformationen verwenden, die in Azure CLI oder einem anderen lokalen Entwicklungstool wie Visual Studio Code oder Intellij IDEA gespeichert sind. Alternativ können Sie verwaltete Identität verwenden, wenn Ihre Anwendung in Azure Cloud bereitgestellt wird. Stellen Sie einfach sicher, dass der Prinzipal über ausreichende Berechtigungen zum Lesen von Ressourcenmetadaten verfügt.

Um azure Resource Manager zum Abrufen der Verbindungszeichenfolge zu verwenden, fügen Sie einfach die folgende Eigenschaft hinzu.

spring:
  cloud:
    azure:
      profile:
        subscription-id: ${AZURE_SUBSCRIPTION_ID}
      eventhubs:
        namespace: ${AZURE_EVENTHUBS_NAMESPACE}
        resource:
          resource-group: ${AZURE_EVENTHUBS_RESOURCE_GROUP}

Proben

Sehen Sie sich das azure-spring-boot-samples Repository auf GitHub an.