Spring Cloud Azure 参考文档（三）

14.1.5. 示例

有关更多详细信息，请参阅azure-spring-boot-samples。

14.2. Azure 服务总线的春季云流绑定器

14.2.1. 关键概念

适用于 Azure 服务总线的 Spring Cloud Stream Binder 提供 Spring Cloud Stream Framework 的绑定实现。 此实现在其基础上使用 Spring 集成服务总线通道适配器。

定时消息

此绑定器支持将消息提交到主题以进行延迟处理。用户可以发送带有标头的计划消息以毫秒为单位表示消息的延迟时间。消息将在毫秒后传递到相应的主题。x-delayx-delay

消费群体

服务总线主题提供与 Apache Kafka 类似的使用者组支持，但逻辑略有不同。 此活页夹依赖于主题来充当使用者组。​​Subscription​​

14.2.2. 依赖设置

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-stream-binder-servicebus</artifactId>
</dependency>

或者，也可以使用 Spring Cloud Azure Stream Service Bus Startter，如以下 Maven 示例所示：

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

14.2.3. 配置

绑定程序提供以下 2 个配置选项部分：

连接配置属性

本部分包含用于连接到 Azure 服务总线的配置选项。

Table 31. Connection configurable properties of spring-cloud-azure-stream-binder-servicebus

默认情况下，绑定器还支持Spring Can Azure资源管理器。若要了解如何使用未授予相关角色的安全主体检索连接字符串，请参阅资源管理器示例以了解详细信息。Data

Azure 服务总线绑定配置属性

以下选项分为四个部分：消费者属性、高级消费者 配置、创建者属性和高级创建者配置。

消费者属性

这些属性通过以下方式公开。​​ServiceBusConsumerProperties​​

Table 32. Consumer configurable properties of spring-cloud-azure-stream-binder-servicebus

高级消费者配置

支持为每个绑定程序使用者自定义上述连接和常见的 Azure SDK 客户端配置，可以使用前缀进行配置。spring.cloud.stream.servicebus.bindings.<binding-name>.consumer.

生产者属性

这些属性通过以下方式公开。​​ServiceBusProducerProperties​​

Table 33. Producer configurable properties of spring-cloud-azure-stream-binder-servicebus

高级生产者配置

支持为每个绑定器生成器自定义上述连接和常见的 Azure SDK 客户端配置，可以使用前缀进行配置。spring.cloud.stream.servicebus.bindings.<binding-name>.producer.

14.2.4. 基本用法

从/向服务总线发送和接收消息

第 1 步。使用凭据信息填充配置选项。

• 对于作为连接字符串的凭据，请在 application.yml 中配置以下属性：

spring:
  cloud:
    azure:
      servicebus:
        connection-string: ${SERVICEBUS_NAMESPACE_CONNECTION_STRING}
    stream:
      function:
        definition: consume;supply
      bindings:
        consume-in-0:
          destination: ${SERVICEBUS_ENTITY_NAME}
          # If you use Service Bus Topic, please add the following configuration
          # group: ${SUBSCRIPTION_NAME}
        supply-out-0:
          destination: ${SERVICEBUS_ENTITY_NAME_SAME_AS_ABOVE}
      servicebus:
        bindings:
          consume-in-0:
            consumer:
              auto-complete: false
          supply-out-0:
            producer:
              entity-type: queue # set as "topic" if you use Service Bus Topic

• 对于作为服务主体的凭据，请在 application.yml 中配置以下属性：

spring:
  cloud:
    azure:
      credential:
        client-id: ${AZURE_CLIENT_ID}
        client-secret: ${AZURE_CLIENT_SECRET}
      profile:
        tenant-id: ${AZURE_TENANT_ID}
      servicebus:
        namespace: ${SERVICEBUS_NAMESPACE}
    stream:
      function:
        definition: consume;supply
      bindings:
        consume-in-0:
          destination: ${SERVICEBUS_ENTITY_NAME}
          # If you use Service Bus Topic, please add the following configuration
          # group: ${SUBSCRIPTION_NAME}
        supply-out-0:
          destination: ${SERVICEBUS_ENTITY_NAME_SAME_AS_ABOVE}
      servicebus:
        bindings:
          consume-in-0:
            consumer:
              auto-complete: false
          supply-out-0:
            producer:
              entity-type: queue # set as "topic" if you use Service Bus Topic

• 对于作为托管标识的凭据，请在 application.yml 中配置以下属性：

spring:
  cloud:
    azure:
      credential:
        managed-identity-enabled: true
        client-id: ${MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity
      servicebus:
        namespace: ${SERVICEBUS_NAMESPACE}
    stream:
      function:
        definition: consume;supply
      bindings:
        consume-in-0:
          destination: ${SERVICEBUS_ENTITY_NAME}
          # If you use Service Bus Topic, please add the following configuration
          # group: ${SUBSCRIPTION_NAME}
        supply-out-0:
          destination: ${SERVICEBUS_ENTITY_NAME_SAME_AS_ABOVE}
      servicebus:
        bindings:
          consume-in-0:
            consumer:
              auto-complete: false
          supply-out-0:
            producer:
              entity-type: queue # set as "topic" if you use Service Bus Topic

第 2 步。定义供应商和消费者。

@Bean
public Consumer<Message<String>> consume() {
    return message -> {
        Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER);
        LOGGER.info("New message received: '{}'", message.getPayload());

        checkpointer.success()
                .doOnSuccess(success -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
                .doOnError(error -> LOGGER.error("Exception found", error))
                .block();
    };
}

@Bean
public Supplier<Message<String>> supply() {
    return () -> {
        LOGGER.info("Sending message, sequence " + i);
        return MessageBuilder.withPayload("Hello world, " + i++).build();
    };
}

分区键支持

绑定程序允许在消息标头中设置分区键和会话 ID，从而支持服务总线分区。本节介绍如何设置消息的分区键。

Spring Cloud Stream 提供分区键 SpEL 表达式属性。例如，将此属性设置为 并添加一个名为 <message-header-key> 的标头。Spring Cloud Stream 在计算上述表达式以分配分区键时将使用此标头的值。下面是一个示例生产者代码：​​spring.cloud.stream.bindings.<binding-name>.producer.partition-key-expression​​​​"'partitionKey-' + headers[<message-header-key>]"​​

@Bean
public Supplier<Message<String>> generate() {
    return () -> {
        String value = “random payload”;
        return MessageBuilder.withPayload(value)
            .setHeader("<message-header-key>", value.length() % 4)
            .build();
    };
}

会话支持

绑定程序支持服务总线的消息会话。 可以通过消息标头设置消息的会话 ID。

@Bean
public Supplier<Message<String>> generate() {
    return () -> {
        String value = “random payload”;
        return MessageBuilder.withPayload(value)
            .setHeader(ServiceBusMessageHeaders.SESSION_ID, "Customize session id")
            .build();
    };
}

错误通道

• 使用者错误通道

默认情况下，此通道处于打开状态，并且默认的使用者错误通道处理程序用于在启用时将失败的消息发送到死信队列，否则将放弃失败的消息。​​spring.cloud.stream.servicebus.bindings.<binding-name>.consumer.requeue-rejected​​

若要自定义使用者错误通道处理程序，可以通过以下方式将自己的错误处理程序注册到相关的使用者错误通道：

// Replace destination with spring.cloud.stream.bindings.input.destination
// Replace group with spring.cloud.stream.bindings.input.group
@ServiceActivator(inputChannel = "{destination}.{group}.errors")
public void consumerError(Message<?> message) {
    LOGGER.error("Handling customer ERROR: " + message);
}

• 生产者错误通道

默认情况下，此通道不打开。您需要在 application.properties 中添加配置以启用它，如下所示：

spring.cloud.stream.default.producer.errorChannelEnabled=true

您可以通过以下方式处理错误消息：

// Replace destination with spring.cloud.stream.bindings.output.destination
@ServiceActivator(inputChannel = "{destination}.errors")
public void producerError(Message<?> message) {
    LOGGER.error("Handling Producer ERROR: " + message);
}

• 全局默认错误通道

默认情况下，Spring 集成会创建一个名为“errorChannel”的全局错误通道，该通道允许用户为其订阅许多端点。

@ServiceActivator(inputChannel = "errorChannel")
public void producerError(Message<?> message) {
    LOGGER.error("Handling ERROR: " + message);
}

服务总线消息标头

有关支持的基本消息标头，请参阅服务总线消息标头。

多种粘合剂支持

使用多个绑定程序还支持连接到多个服务总线命名空间。此示例以连接字符串为例。还支持服务主体和托管标识的凭据，用户可以在每个绑定程序的环境设置中设置相关属性。

第 1 步。若要使用服务总线的多个绑定程序，我们需要在 application.yml 中配置以下属性

spring:
  cloud:
    stream:
      function:
        definition: consume1;supply1;consume2;supply2
      bindings:
        consume1-in-0:
          destination: ${SERVICEBUS_TOPIC_NAME}
          group: ${SUBSCRIPTION_NAME}
        supply1-out-0:
          destination: ${SERVICEBUS_TOPIC_NAME_SAME_AS_ABOVE}
        consume2-in-0:
          binder: servicebus-2
          destination: ${SERVICEBUS_QUEUE_NAME}
        supply2-out-0:
          binder: servicebus-2
          destination: ${SERVICEBUS_QUEUE_NAME_SAME_AS_ABOVE}
      binders:
        servicebus-1:
          type: servicebus
          default-candidate: true
          environment:
            spring:
              cloud:
                azure:
                  servicebus:
                    connection-string: ${SERVICEBUS_NAMESPACE_01_CONNECTION_STRING}
        servicebus-2:
          type: servicebus
          default-candidate: false
          environment:
            spring:
              cloud:
                azure:
                  servicebus:
                    connection-string: ${SERVICEBUS_NAMESPACE_02_CONNECTION_STRING}
      servicebus:
        bindings:
          consume1-in-0:
            consumer:
              auto-complete: false
          supply1-out-0:
            producer:
              entity-type: topic
          consume2-in-0:
            consumer:
              auto-complete: false
          supply2-out-0:
            producer:
              entity-type: queue
      poller:
        initial-delay: 0
        fixed-delay: 1000

第 2 步。我们需要定义两个供应商和两个消费者

@Bean
public Supplier<Message<String>> supply1() {
    return () -> {
        LOGGER.info("Sending message1, sequence1 " + i);
        return MessageBuilder.withPayload("Hello world1, " + i++).build();
    };
}

@Bean
public Supplier<Message<String>> supply2() {
    return () -> {
        LOGGER.info("Sending message2, sequence2 " + j);
        return MessageBuilder.withPayload("Hello world2, " + j++).build();
    };
}

@Bean
public Consumer<Message<String>> consume1() {
    return message -> {
        Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER);
        LOGGER.info("New message1 received: '{}'", message);
        checkpointer.success()
                .doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
                .doOnError(e -> LOGGER.error("Error found", e))
                .block();
    };
}

@Bean
public Consumer<Message<String>> consume2() {
    return message -> {
        Checkpointer checkpointer = (Checkpointer) message.getHeaders().get(CHECKPOINTER);
        LOGGER.info("New message2 received: '{}'", message);
        checkpointer.success()
                .doOnSuccess(s -> LOGGER.info("Message '{}' successfully checkpointed", message.getPayload()))
                .doOnError(e -> LOGGER.error("Error found", e))
                .block();
    };

}

资源提供

服务总线绑定程序支持预配队列、主题和订阅，用户可以使用以下属性来启用预配。

spring:
  cloud:
    azure:
      credential:
        tenant-id: ${AZURE_TENANT_ID}
      profile:
        subscription-id: ${AZURE_SUBSCRIPTION_ID}
      servicebus:
        resource:
          resource-group: ${AZURE_SERVICEBUS_RESOURECE_GROUP}
    stream:
      servicebus:
        bindings:
          <binding-name>:
            consumer:
              entity-type: ${SERVICEBUS_CONSUMER_ENTITY_TYPE}

14.2.5. 示例

有关更多详细信息，请参阅azure-spring-boot-samples。

15. 春季 JMS 支持

通过集成到 Spring JMS 框架中的 JMS API 使用 Azure 服务总线。 必须提供 Azure 服务总线连接字符串，该字符串将解析为 AMQP 代理的登录用户名、密码和远程 URI。

15.1. 依赖设置

如果要迁移 Spring JMS 应用程序以使用 Azure 服务总线，请添加以下依赖项。

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

15.2. 配置

Table 34. Configurable properties when using Spring JMS support

15.3. 基本用法

15.3.1. 使用服务总线连接字符串

连接到 Spring JMS 应用程序服务总线的最简单方法是使用连接字符串。

添加以下属性，您就可以开始了。

spring:
  jms:
    servicebus:
      connection-string: ${AZURE_SERVICEBUS_CONNECTION_STRING}
      pricing-tier: ${PRICING_TIER}

15.4. 示例

有关更多详细信息，请参阅azure-spring-boot-samples。

16. 春季原生支持

16.1. 春季原生

Spring Native 支持使用GraalVM​ 本机映像编译器将 Spring Boot 应用程序编译为本机​可执行文件。本机映像将带来许多优势，例如即时启动、即时峰值性能和减少内存消耗。一些Spring Cloud Azure功能也可以从Spring Native支持中受益，目标是Spring Cloud Azure应用程序可以构建为本机映像，而无需任何代码修改。有关更多信息，请参阅Spring Native 文档。

16.2. 支持

Spring Cloud Azure已经过GraalVM和Spring Native的验证，并提供测试版支持。如果项目使用这些受支持的依赖项，则可以在项目上尝试它，并在Spring Cloud Azure上出现问题时引发错误​或贡献拉取请求​。有关更多信息，请参阅Spring 本机支持以获取更多详细信息。

16.2.1. 春季原生

Spring CloudAzure 4.4.1已针对 Spring Native 和 GraalVM 进行了测试。0.11.422.0.0

16.2.2. 春季云 Azure 原生

Spring Cloud Azure 提供了一个依赖项，它是 Spring Cloud Azure 库的 Spring Native 配置的扩展。Spring Native AOT 插件将把构建应用程序合并到原生可执行文件中。除了添加依赖项之外，不需要对使用 Spring Cloud Azure 库的代码进行任何额外的修改，该依赖项仅适用于 Spring Cloud Azure 库中的代码。​​spring-cloud-azure-native-configuration​​​​spring-native-configuration​​​​spring-cloud-azure-native-configuration​​

支持以下功能：

• ​​Azure App Configuration clients auto-configuration​​
• ​​Azure Event Hubs clients auto-configuration​​
• ​​Azure Key Vault Certificates clients auto-configuration​​
• ​​Azure Key Vault Secrets clients auto-configuration​​
• ​​Azure Storage Blob clients auto-configuration​​
• ​​Azure Storage File Share clients auto-configuration​​
• ​​Azure Storage Queue clients auto-configuration​​
• ​​Spring Integration for Azure Event Hubs​​
• ​​Spring Integration for Azure Storage Queue​​

16.2.3. 限制

Spring Cloud Azure 对 Spring Native 的支持仍处于早期阶段，并将继续更新。尚不支持以下功能：

• ​​Azure Cosmos clients auto-configuration​​
• ​​Azure Service Bus clients auto-configuration​​
• ​​Spring Data for Azure Cache for Redis​​
• ​​Spring Data for Azure Cosmos​​
• ​​Spring Cloud Stream for Azure Event Hubs​​
• ​​Spring Cloud Stream for Azure Service Bus​​
• ​​Spring Kafka for Azure Event Hubs​​
• ​​Spring Integration for Azure Service Bus​​

16.3. 项目设置

Spring Cloud Azure 应用程序可以按照 Spring Native 文档的入门部分中的说明启用 Spring Native 支持。唯一需要的附加处理是将以下依赖项添加到 POM 文件。

马文

格拉德尔·格鲁维

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-native-configuration</artifactId>
    <version>4.0.0-beta.1</version>
  </dependency>

16.4. 构建原生应用程序

以下部分介绍了使用 Spring Cloud Azure 库构建 Spring Boot 本机应用程序的两种主要方法。

16.4.1. 使用构建包构建

本机应用程序可以按如下方式构建：

马文

格拉德尔·格鲁维

mvn spring-boot:build-image

有关更多信息，请参阅 Spring Native 文档中的构建包入门部分。

16.4.2. 使用原生构建工具构建

可以使用以下命令生成本机应用程序：

马文

格拉德尔·格鲁维

mvn -Pnative -DskipTests package

有关更多信息，请参阅 Spring 原生文档的原生构建工具入门部分。

16.5. 运行本机应用程序

以下各节介绍运行本机可执行文件的两种主要方法。

16.5.1. 使用构建包运行

若要运行应用程序，可以使用以下示例中所示的常用方式：​​docker​​

docker run --rm -p 8080:8080 spring-cloud-azure-sample:0.0.1-SNAPSHOT

16.5.2. 使用本机构建工具运行

若要运行应用程序，请使用以下命令：

使用 Maven 构建

使用 Gradle 构建

target\spring-cloud-azure-sample

16.6. 示例

有关详细信息，请参阅 GitHub 上的存储 blob-native。

下面是支持 Spring Native 的其他经过验证的示例。有关更多信息，请参阅 GitHub 上的Spring Cloud Azure 示例。

Table 35. Supported Spring Cloud Azure Samples

17. 卡夫卡支持

从版本 4.3.0 开始，Spring Cloud Azure for Kafka 支持各种类型的凭据进行身份验证并连接到 Azure 事件中心。

17.1. 支持的卡夫卡版本

当前版本的启动器应与使用 Java 8 或更高版本的 Apache Kafka Clients 2.0.0 兼容。

17.2. 支持的认证类型

支持以下身份验证类型：

• 普通连接字符串身份验证

• 直接连接字符串身份验证
• 基于 ARM 的连接字符串身份验证

• OAuth 凭据身份验证

• 托管标识身份验证
• 用户名/密码身份验证
• 服务主体身份验证
• DefautlAzureCredential authentication

17.3. 工作原理

17.3.1. OAuth 凭证认证

本节介绍Spring Cloud Azure OAuth身份验证的整体工作流程。

Spring Cloud Azure 将首先根据应用程序身份验证配置构建以下类型的凭据之一：

• ​​ClientSecretCredential​​
• ​​ClientCertificateCredential​​
• ​​UsernamePasswordCredential​​
• ​​ManagedIdentityCredential​​

如果未找到这些类型的凭据，则将使用凭据链 via 从应用程序属性、环境变量、托管标识或 IDE 获取凭据。有关详细信息，请参阅身份验证部分。DefaultAzureTokenCredential

17.3.2. 纯连接字符串认证

对于连接字符串身份验证模式，可以直接使用连接字符串身份验证，也可以使用 Azure 资源管理器检索连接字符串。有关用法的详细信息，请参阅连接字符串身份验证的基本用法部分。

17.4. 配置

17.4.1. 将 Kafka 支持与 OAuth 身份验证结合使用时的可配置属性

Spring Cloud Azure for Kafka 支持以下两个级别的配置选项：

1. Spring Cloud Azure for Event Hubs Kafka properties.
2. 的全局身份验证配置选项 和前缀。credentialprofilespring.cloud.azure
3. 特定于 Kafka 的级别配置。Kafka 级别的配置也可用于 Spring Boot 和 Spring Cloud Stream 绑定器，用于,,, orscope，它们具有不同的前缀。commonconsumerproduceradmin

全局属性通过以下方式公开。特定于 Kafka 的属性通过 （Spring Boot） 和 （Spring Cloud Stream binder） 公开。​​com.azure.spring.cloud.autoconfigure.context.AzureGlobalProperties​​​​org.springframework.boot.autoconfigure.kafka.KafkaProperties​​​​org.springframework.cloud.stream.binder.kafka.properties.KafkaBinderConfigurationProperties​​

以下列表显示了所有受支持的配置选项。

• Spring Cloud Azure 全局身份验证配置选项

• 前缀：spring.cloud.azure
• 支持的选项：，​spring.cloud.azure.profile.​spring.cloud.azure.credential.​

有关全局配置选项的完整列表，请参阅全局属性部分。

• 弹簧启动卡夫卡常用配置

• 前缀：spring.kafka.properties.azure
• 示例：.凭据。spring.kafka.properties.azure

• Spring Kafka 消费者配置选项

• 前缀：spring.kafka.consumer.properties.azure
• 示例：.凭据。spring.kafka.consumer.properties.azure

• 春季卡夫卡生产者配置选项

• 前缀：spring.kafka.producer.properties.azure
• 示例：.凭据。spring.kafka.producer.properties.azure

• Spring Kafka 管理员配置选项

• 前缀：spring.kafka.admin.properties.azure
• 示例：.凭据。spring.kafka.admin.properties.azure

• 春云流卡夫卡活页夹常用配置

• 前缀：spring.cloud.stream.kafka.binder.configuration.azure
• 示例：.凭据。spring.cloud.stream.kafka.binder.configuration.azure

• 春云流卡夫卡绑定器消费者配置

• 前缀：spring.cloud.stream.kafka.binder.consumer-properties.azure
• 示例：.凭据。spring.cloud.stream.kafka.binder.consumer-properties.azure

• 春云流卡夫卡活页夹生产者配置

• 前缀：spring.cloud.stream.kafka.binder.producer-properties.azure
• 示例：.凭据。spring.cloud.stream.kafka.binder.producer-properties.azure

• Spring Cloud Stream Kafka Binder 管理员配置

• 前缀：不支持，应使用 Spring Boot Kafka 通用或管理员配置。

Table 36. Spring Boot Kafka common configuration options

17.4.2. 使用 Kafka 支持和普通连接字符串身份验证时的可配置属性

Table 37. Spring Boot Event Hubs for Kafka common configuration options

17.5. 依赖设置

将以下依赖项添加到项目中。这将自动将依赖项传递地包含在项目中。​​spring-boot-starter​​

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

17.6. 基本用法

以下各节显示了经典的 Spring 引导应用程序使用场景。

17.6.1. 使用 OAuth 认证

当您使用 Spring Cloud Azure for Kafka 提供的 OAuth 身份验证时，您可以使用上述配置配置特定凭据。或者，您可以选择不配置任何有关凭据的内容，在这种情况下，Spring Cloud Azure 将从环境中加载凭据。本部分介绍从 Azure CLI 环境或 Azure Spring 应用托管环境加载凭据的用法。

以下部分描述了使用具有OAuth身份验证的不同Spring生态系统库的场景。

春季卡夫卡应用支持

本节描述了使用 Spring Kafka 或 Spring Integration Kafka 库的 Spring 引导应用程序的使用场景。

依赖项设置

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

配置更新

若要使用 OAuth 身份验证，只需指定事件中心终结点，如以下示例所示：

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

春云流活页夹卡夫卡应用支持

本节介绍使用 Spring Cloud Stream binder Kafka 库的 Spring 引导应用程序的使用场景。

依赖项设置

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

配置

若要使用 OAuth 身份验证，只需指定事件中心终结点，如以下示例所示：​​com.azure.spring.cloud.autoconfigure.kafka.AzureKafkaSpringCloudStreamConfiguration​​

spring.cloud.stream.kafka.binder.brokers=<NAMESPACENAME>.servicebus.windows.net:9093
spring.cloud.stream.binders.kafka.environment.spring.main.sources=com.azure.spring.cloud.autoconfigure.kafka.AzureKafkaSpringCloudStreamConfiguration

样品

请参阅 GitHub 上的azure-spring-boot-samples存储库。

17.6.2. 使用连接字符串身份验证

可以直接使用连接字符串身份验证，也可以使用 Azure 资源管理器检索连接字符串。

依赖项设置

如果要迁移 Apache Kafka 应用程序以使用适用于 Kafka 的 Azure 事件中心，请添加以下依赖项。

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

如果要使用 Azure 资源管理器检索连接字符串，请添加以下依赖项：

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

配置

直接使用事件中心连接字符串

连接到 Kafka 事件中心的最简单方法是使用连接字符串。只需添加以下属性。

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

使用 Azure 资源管理器检索连接字符串

如果不想在应用程序中配置连接字符串，可以使用 Azure 资源管理器检索连接字符串。若要使用 Azure 资源管理器进行身份验证，还可以使用存储在 Azure CLI 或其他本地开发工具（如 Visual Studio Code 或 Intellij IDEA）中的凭据。或者，如果应用程序部署到 Azure 云，则可以使用托管标识。只需确保主体具有足够的权限来读取资源元数据。

若要使用 Azure 资源管理器检索连接字符串，只需添加以下属性。

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

17.7. 示例

请参阅 GitHub 上的azure-spring-boot-samples存储库。

18. 红地思支持

使用 Spring Redis 库连接到适用于 Redis 的 Azure 缓存。通过向应用程序添加和，可以通过 Azure 资源管理器读取适用于 Redis 的 Azure 缓存连接信息，并自动配置 Redis 属性。spring-cloud-azure-starterspring-cloud-azure-resourcemanager

18.1. 依赖设置

如果要使用 Redis 将 Spring Cloud Azure Redis 支持用于 Spring Boot 应用程序，请添加以下依赖项。

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

18.2. 配置

Table 38. Configurable properties when using Redis support

18.3. 基本用法

添加以下属性，您就可以开始了。

spring.cloud.azure.redis.name=${AZURE_CACHE_REDIS_NAME}
spring.cloud.azure.redis.resource.resource-group=${AZURE_CACHE_REDIS_RESOURCE_GROUP}

18.4. 示例

有关更多详细信息，请参阅azure-spring-boot-samples。

19. Azure 资源管理器

Azure 资源管理器 （ARM） 是 Azure 的部署和管理服务。它提供了一个管理层，使你能够在 Azure 帐户中创建、更新和删除资源。Spring Cloud Azure 资源管理器可以帮助预配资源或检索资源元数据。

19.1. 依赖设置

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

19.2. 配置

Table 39. Configurable properties of spring-cloud-azure-resourcemanager

19.3. 基本用法

Spring Cloud Azure 资源管理器可以与特定的 Spring Cloud Azure 初学者一起工作，检索连接信息（如连接字符串）以连接到 Azure 服务。它还可以与第三方库一起使用，以检索用户名/密码等元数据，并完成身份验证，有关更多信息，请参阅Kafka支持和Redis 支持部分。spring-cloud-azure-starter

例如，若要检索 Azure 服务的连接字符串，开发人员可以使用服务主体作为凭据来对连接字符串进行身份验证和检索。配置列出如下。提供的服务主体应 至少为关联的命名空间分配角色。请参阅使用 Azure AD 授予访问权限，确保主体已被授予访问 Azure 资源的足够权限。Contributor

spring:
  cloud:
    azure:
      credential:
        client-id: ${AZURE_CLIENT_ID}
        client-secret: ${AZURE_CLIENT_SECRET}
      profile:
        tenant-id: ${AZURE_TENANT_ID}
        subscription-id: ${AZURE_SUBSCRIPTION_ID}
      <azure-service>:
        namespace: ${SERVICEBUS_NAMESPACE}
        resource:
          resource-group: ${RESOURCE_GROUP}

19.4. 示例

有关更多详细信息，请参阅azure-spring-boot-samples。

20. 配置属性

要查看所有与Spring Cloud Azure相关的配置属性的列表，请查看附录页面。