Stöd för Spring Cloud Azure Kafka

Stöd för Spring Cloud Azure Kafka hjälper Spring-program att autentisera och ansluta till Azure Event Hubs med hjälp av OAuth-autentiseringsuppgifter eller anslutningssträngar. Den här artikeln beskriver de autentiseringstyper, konfigurationsalternativ, beroenden och användningsscenarier som stöds.

Kafka-version som stöds

Den aktuella versionen av startprogrammet är kompatibel med Apache Kafka-klienterna 2.0.0 och använder Java 8 eller senare.

Autentiseringstyper som stöds

Startprogrammet stöder följande autentiseringstyper:

• Autentisering med vanlig anslutningssträng
  • Direktanslutningssträngsautentisering
  • ARM-baserad anslutningssträngsautentisering
• Autentisering med OAuth-autentiseringsuppgifter
  • Hanterad identitetsautentisering
  • Autentisering med användarnamn/lösenord
  • Autentisering med service principal
  • DefaultAzureCredential autentisering

Så här fungerar det

Autentisering med OAuth-autentiseringsuppgifter

I det här avsnittet beskrivs det övergripande arbetsflödet för Spring Cloud Azure OAuth-autentisering.

Spring Cloud Azure skapar först en av följande typer av autentiseringsuppgifter, beroende på konfigurationen för programautentisering:

• ClientSecretCredential
• ClientCertificateCredential
• UsernamePasswordCredential
• ManagedIdentityCredential

Om programmet inte använder någon av dessa typer av autentiseringsuppgifter använder programmet autentiseringskedjan för DefaultAzureTokenCredential att hämta autentiseringsuppgifter från programegenskaper, miljövariabler, hanterad identitet eller IDE:er. Detaljerad information finns i Spring Cloud Azure-autentisering.

Autentisering med vanlig anslutningssträng

För autentiseringsläget med anslutningssträng kan du antingen använda autentisering med anslutningssträng direkt eller använda Azure Resource Manager för att hämta anslutningssträngen. Mer information om användningen finns i avsnittet Grundläggande användning för autentisering av anslutningssträngar.

Konfiguration

Konfigurerbara egenskaper när du använder Kafka-stöd med OAuth-autentisering

Spring Cloud Azure for Kafka stöder följande två konfigurationsalternativ:

1. Spring Cloud Azure för Event Hubs Kafka-egenskaper.
2. Konfigurationsalternativen för global autentisering för credential och profile med prefix för spring.cloud.azure.
3. Kafka-specifika nivåkonfigurationer. Kafka-nivåkonfigurationerna är också tillgängliga för Spring Boot- och Spring Cloud Stream-pärmar för common, consumer, producereller admin omfång som har olika prefix.

De globala egenskaperna är tillgängliga via com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties. Kafka-specifika egenskaper exponeras via org.springframework.boot.autoconfigure.kafka.KafkaProperties (Spring Boot) och org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties (Spring Cloud Stream binder).

I följande lista visas alla konfigurationsalternativ som stöds.

• Spring Cloud Azure för Event Hubs Kafka-egenskaper.

  • Egenskap: spring.cloud.azure.eventhubs.kafka.enabled
  • Beskrivning: om anslutning utan autentiseringsuppgifter till Azure Event Hubs för Kafka ska aktiveras; standardvärdet är true.

• Konfigurationsalternativ för global autentisering i Spring Cloud Azure

  • Prefix: spring.cloud.azure
  • Alternativ som stöds: spring.cloud.azure.credential.*, spring.cloud.azure.profile.*

  En fullständig lista över globala konfigurationsalternativ finns i Globala konfigurationsegenskaper.

• Vanliga konfigurationer för Spring Boot Kafka

  • Prefix: spring.kafka.properties.azure
  • Exempel: spring.kafka.properties.azure.credential.*

• Konfigurationsalternativ för Spring Kafka-konsumenter

  • Prefix: spring.kafka.consumer.properties.azure
  • Exempel: spring.kafka.consumer.properties.azure.credential.*

• Konfigurationsalternativ för Spring Kafka-producent

  • Prefix: spring.kafka.producer.properties.azure
  • Exempel: spring.kafka.producer.properties.azure.credential.*

• Konfigurationsalternativ för Spring Kafka-administratör

  • Prefix: spring.kafka.admin.properties.azure
  • Exempel: spring.kafka.admin.properties.azure.credential.*

• Gemensam konfiguration för Spring Cloud Stream Kafka Binder

  • Prefix: spring.cloud.stream.kafka.binder.configuration.azure
  • Exempel: spring.cloud.stream.kafka.binder.configuration.azure.credential.*

• Spring Cloud Stream Kafka Binder-konsumentkonfiguration

  • Prefix: spring.cloud.stream.kafka.binder.consumer-properties.azure
  • Exempel: spring.cloud.stream.kafka.binder.consumer-properties.azure.credential.*

• Spring Cloud Stream Kafka Binder-producentkonfiguration

  • Prefix: spring.cloud.stream.kafka.binder.producer-properties.azure
  • Exempel: spring.cloud.stream.kafka.binder.producer-properties.azure.credential.*

• Spring Cloud Stream Kafka Binder-administratörskonfiguration

  • Prefix: Stöds inte, använd Vanlig Spring Boot Kafka-konfiguration eller administratörskonfiguration.

I följande tabell visas vanliga konfigurationsalternativ för Spring Boot Kafka:

Konfigurerbara egenskaper när du använder Kafka-stöd med autentisering med oformaterad anslutningssträng

I följande tabell visas vanliga konfigurationsalternativ för Spring Boot Event Hubs för Kafka:

Konfiguration av beroenden

Lägg till följande beroende i projektet. Det här beroendet inkluderar automatiskt beroendet spring-boot-starter i ditt projekt.

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

Grundläggande användning

I följande avsnitt visas de klassiska Användningsscenarierna för Spring Boot-program.

Använda OAuth-autentisering

När du använder OAuth-autentiseringen som Spring Cloud Azure tillhandahåller för Kafka kan du konfigurera specifika autentiseringsuppgifter med hjälp av föregående konfigurationer. Du kan också välja att inte konfigurera några autentiseringsuppgifter. I det här fallet läser Spring Cloud Azure in autentiseringsuppgifterna från miljön. I det här avsnittet beskrivs hur du läser in autentiseringsuppgifter från Azure CLI-miljön eller Azure Spring Apps värdmiljön.

I följande avsnitt beskrivs scenarier som använder olika Spring-ekosystembibliotek med OAuth-autentisering.

Stöd för Spring Kafka-program

I det här avsnittet beskrivs användningsscenariot för ett Spring Boot-program som använder Spring Kafka eller Spring Integration Kafka-biblioteket.

Konfiguration av beroenden

<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>

Konfigurationsuppdatering

Om du vill använda OAuth-autentisering anger du Event Hubs-slutpunkten enligt följande exempel:

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

Stöd för Spring Cloud Stream-binder för Kafka-applikationer

I det här avsnittet beskrivs användningsscenariot för Spring Boot-program som använder Spring Cloud Stream-binder Kafka-biblioteket.

Konfiguration av beroenden

<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

Om du vill använda OAuth-autentisering anger du Event Hubs-slutpunkten enligt följande exempel:

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

Använda hanterad identitet för OAuth-autentisering

1. Om du vill använda hanterad identitet aktiverar du hanterad identitet för din tjänst och tilldelar rollerna Azure Event Hubs Data Receiver och Azure Event Hubs Data Sender . Mer information finns i Tilldela Azure-roller för åtkomsträttigheter.

2. Konfigurera följande egenskaper i din application.yml-fil:

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

   Viktig

   Om du använder användartilldelad hanterad identitet lägger du även till egenskapen spring.cloud.azure.credential.client-id med ditt användartilldelade klient-ID för hanterad identitet.

Exempel

Se lagringsplatsen azure-spring-boot-samples på GitHub.

Använda autentisering med anslutningssträngar

Du kan använda anslutningssträngsautentisering direkt eller använda Azure Resource Manager för att hämta anslutningssträngen.

Konfiguration av beroenden

Lägg till följande beroenden om du vill migrera ditt Apache Kafka-program för att använda Azure Event Hubs för Kafka.

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

Om du vill hämta reťazec pripojenia med hjälp av Azure Resource Manager lägger du till följande beroende:

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

Konfiguration

Använd Event Hubs-anslutningssträngen direkt

Det enklaste sättet att ansluta till Event Hubs för Kafka är med anslutningssträngen. Lägg bara till följande egenskap.

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

Använda Azure Resource Manager för att hämta anslutningssträngen

Om du inte vill konfigurera anslutningssträngen i ditt program kan du använda Azure Resource Manager för att hämta anslutningssträngen. Om du vill autentisera med Azure Resource Manager kan du också använda autentiseringsuppgifter som lagras i Azure CLI eller något annat lokalt utvecklingsverktyg som Visual Studio Code eller Intellij IDEA. Alternativt kan du använda Hanterad identitet om ditt program distribueras till Azure Cloud. Se bara till att huvudnamnet har tillräcklig behörighet för att läsa resursmetadata.

Om du vill använda Azure Resource Manager för att hämta anslutningssträngen lägger du bara till följande egenskap.

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

Exempel

Se lagringsplatsen azure-spring-boot-samples på GitHub.