Supporto di Spring Cloud Azure Kafka

Questo articolo si applica a:✅ versione 4.19.0 ✅ versione 5.19.0

Dalla versione 4.3.0, Spring Cloud Azure per Kafka supporta vari tipi di credenziali per l'autenticazione e la connessione a Hub eventi di Azure.

Versione di Kafka supportata

La versione corrente dello starter deve essere compatibile con i client Apache Kafka 2.0.0 con Java 8 o versione successiva.

Tipi di autenticazione supportati

Sono supportati i tipi di autenticazione seguenti:

• Autenticazione con stringa di connessione normale
  • Autenticazione della stringa di connessione diretta
  • Autenticazione della stringa di connessione basata su ARM
• Autenticazione delle credenziali OAuth
  • Autenticazione dell'identità gestita
  • Autenticazione con nome utente/password
  • Autenticazione dell'entità servizio
  • autenticazione DefaultAzureCredential

Come funziona

Autenticazione delle credenziali OAuth

Questa sezione descrive il flusso di lavoro complessivo dell'autenticazione OAuth di Spring Cloud di Azure.

Spring Cloud Azure creerà prima di tutto uno dei tipi di credenziali seguenti a seconda della configurazione di autenticazione dell'applicazione:

• ClientSecretCredential
• ClientCertificateCredential
• UsernamePasswordCredential
• ManagedIdentityCredential

Se nessuno di questi tipi di credenziali viene trovato, la catena di credenziali tramite DefaultAzureTokenCredential verrà usata per ottenere le credenziali dalle proprietà dell'applicazione, dalle variabili di ambiente, dall'identità gestita o dagli IDE. Per informazioni dettagliate, vedere autenticazione di Spring Cloud azure.

Autenticazione con stringa di connessione normale

Per la modalità di autenticazione della stringa di connessione, è possibile usare direttamente l'autenticazione della stringa di connessione o usare Azure Resource Manager per recuperare la stringa di connessione. Per altre informazioni sull'utilizzo, vedere la sezione Utilizzo di base per l'autenticazione della stringa di connessione.

Configurazione

Proprietà configurabili quando si usa il supporto kafka con l'autenticazione OAuth

Spring Cloud Azure per Kafka supporta i due livelli di opzioni di configurazione seguenti:

1. Proprietà Kafka di Spring Cloud Azure per Hub eventi.
2. Opzioni di configurazione di autenticazione globali di credential e profile con prefissi di spring.cloud.azure.
3. Configurazioni di livello specifiche di Kafka. Le configurazioni a livello di Kafka sono disponibili anche per gli strumenti di associazione Spring Boot e Spring Cloud Stream per common, consumer, producero ambiti di admin, con prefissi diversi.

Le proprietà globali vengono esposte tramite com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties. Le proprietà specifiche di Kafka vengono esposte tramite org.springframework.boot.autoconfigure.kafka.KafkaProperties (Spring Boot) e org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties (Binder Spring Cloud Stream).

L'elenco seguente mostra tutte le opzioni di configurazione supportate.

• Proprietà Kafka di Spring Cloud Azure per Hub eventi.

  • Proprietà: spring.cloud.azure.eventhubs.kafka.enabled
  • Descrizione: se abilitare la connessione gratuita delle credenziali a Hub eventi di Azure per Kafka, il valore predefinito è true.

• Opzioni di configurazione dell'autenticazione globale di Spring Cloud Azure

  • Prefisso: spring.cloud.azure
  • Opzioni supportate: spring.cloud.azure.credential.*, spring.cloud.azure.profile.*

  Per l'elenco completo delle opzioni di configurazione globali, vedere proprietà di configurazione globale.

• Configurazione comune di Spring Boot Kafka

  • Prefisso: spring.kafka.properties.azure
  • Esempio: spring.kafka.properties.azure.credential.*

• Opzioni di configurazione del consumer Spring Kafka

  • Prefisso: spring.kafka.consumer.properties.azure
  • Esempio: spring.kafka.consumer.properties.azure.credential.*

• Opzioni di configurazione del producer Spring Kafka

  • Prefisso: spring.kafka.producer.properties.azure
  • Esempio: spring.kafka.producer.properties.azure.credential.*

• Opzioni di configurazione dell'amministratore di Spring Kafka

  • Prefisso: spring.kafka.admin.properties.azure
  • Esempio: spring.kafka.admin.properties.azure.credential.*

• Configurazione comune di Spring Cloud Stream Kafka Binder

  • Prefisso: spring.cloud.stream.kafka.binder.configuration.azure
  • Esempio: spring.cloud.stream.kafka.binder.configuration.azure.credential.*

• Configurazione consumer di Spring Cloud Stream Kafka Binder

  • Prefisso: spring.cloud.stream.kafka.binder.consumer-properties.azure
  • Esempio: spring.cloud.stream.kafka.binder.consumer-properties.azure.credential.*

• Configurazione del producer Kafka Binder di Spring Cloud Stream

  • Prefisso: spring.cloud.stream.kafka.binder.producer-properties.azure
  • Esempio: spring.cloud.stream.kafka.binder.producer-properties.azure.credential.*

• Configurazione dell'amministratore di Spring Cloud Stream Kafka Binder

  • Prefisso: non supportato, deve usare la configurazione comune o amministratore di Spring Boot Kafka.

La tabella seguente illustra le opzioni di configurazione comuni di Spring Boot Kafka:

Proprietà configurabili quando si usa il supporto Kafka con l'autenticazione con stringa di connessione normale

La tabella seguente illustra le opzioni di configurazione comuni di Hub eventi Spring Boot per Kafka:

Configurazione delle dipendenze

Aggiungere la dipendenza seguente al progetto. Ciò includerà automaticamente la dipendenza spring-boot-starter nel progetto in modo transitivo.

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

Utilizzo di base

Le sezioni seguenti illustrano gli scenari di utilizzo dell'applicazione Spring Boot classici.

Usare l'autenticazione OAuth

Quando si usa l'autenticazione OAuth fornita da Spring Cloud Azure per Kafka, è possibile configurare le credenziali specifiche usando le configurazioni precedenti. In alternativa, è possibile scegliere di configurare nulla sulle credenziali, nel qual caso Spring Cloud Azure caricherà le credenziali dall'ambiente. Questa sezione descrive gli utilizzi che caricano le credenziali dall'ambiente dell'interfaccia della riga di comando di Azure o dall'ambiente di hosting di Azure Spring Apps.

La sezione seguente descrive gli scenari che usano librerie dell'ecosistema Spring diverse con l'autenticazione OAuth.

Supporto delle applicazioni Spring Kafka

Questa sezione descrive lo scenario di utilizzo per l'applicazione Spring Boot usando la libreria Spring Kafka o Spring Integration Kafka.

Configurazione delle dipendenze

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

Aggiornamento della configurazione

Per usare l'autenticazione OAuth, specificare solo l'endpoint di Hub eventi, come illustrato nell'esempio seguente:

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

Supporto dell'applicazione Kafka per lo strumento di associazione Spring Cloud Stream

Questa sezione descrive lo scenario di utilizzo per le applicazioni Spring Boot che usano la libreria Kafka del binder Spring Cloud Stream.

Configurazione delle dipendenze

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

Configurazione

Per usare l'autenticazione OAuth, è sufficiente specificare l'endpoint di Hub eventi come illustrato nell'esempio seguente:

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

Usare l'identità gestita per l'autenticazione OAuth

1. Per usare l'identità gestita, è necessario abilitare l'identità gestita per il servizio e assegnare i ruoli Azure Event Hubs Data Receiver e Azure Event Hubs Data Sender. Per altre informazioni, vedere Assegnare ruoli di Azure per i diritti di accesso.

2. Configurare le proprietà seguenti nel file application.yml:

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

   Importante

   Se si usa l'identità gestita assegnata dall'utente, è anche necessario aggiungere la proprietà spring.cloud.azure.credential.client-id con l'ID client dell'identità gestita assegnata dall'utente.

Campioni

Vedere il repository azure-spring-boot-samples in GitHub.

Usare l'autenticazione della stringa di connessione

È possibile usare direttamente l'autenticazione della stringa di connessione o usare Azure Resource Manager per recuperare la stringa di connessione.

Configurazione delle dipendenze

Aggiungere le dipendenze seguenti se si vuole eseguire la migrazione dell'applicazione Apache Kafka per usare Hub eventi di Azure per Kafka.

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

Se si vuole recuperare la stringa di connessione usando Azure Resource Manager, aggiungere la dipendenza seguente:

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

Configurazione

Usare direttamente la stringa di connessione di Hub eventi

Il modo più semplice per connettersi a Hub eventi per Kafka è la stringa di connessione. È sufficiente aggiungere la proprietà seguente.

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

Usare Azure Resource Manager per recuperare la stringa di connessione

Se non si vuole configurare la stringa di connessione nell'applicazione, è possibile usare Azure Resource Manager per recuperare la stringa di connessione. Per eseguire l'autenticazione con Azure Resource Manager, è anche possibile usare le credenziali archiviate nell'interfaccia della riga di comando di Azure o in un altro strumento di sviluppo locale, ad esempio Visual Studio Code o Intellij IDEA. In alternativa, è possibile usare l'identità gestita se l'applicazione viene distribuita nel cloud di Azure. Assicurarsi che l'entità disponga di autorizzazioni sufficienti per leggere i metadati delle risorse.

Per usare Azure Resource Manager per recuperare la stringa di connessione, è sufficiente aggiungere la proprietà seguente.

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

Campioni

Vedere il repository azure-spring-boot-samples in GitHub.