Руководство по миграции для Spring Cloud Azure 4.0

Это руководство помогает выполнить миграцию в Spring Cloud Azure 4.0 из устаревших библиотек Azure Spring.

Знакомство

Мы вызовем библиотеки, идентификатор группы которых и идентификатор артефакта соответствуют шаблону современных библиотек, а также библиотек шаблонов , или устаревших библиотек .

В этом руководстве рассматриваются параллельные сравнения аналогичных конфигураций между современными и устаревшими библиотеками.

Предполагается знакомство с com.azure.spring:azure-spring-boot-*пакетом com.azure.spring:azure-spring-cloud-* или com.azure.spring:azure-spring-integration-*.

Если вы не знакомы с библиотеками Spring Cloud Azure версии 4.0, ознакомьтесь с руководством разработчика Spring Cloud Azure вместо этого руководства.

Преимущества миграции

Естественный вопрос, который следует задать при рассмотрении того, следует ли принять новую версию или библиотеку, является его преимуществами. По мере того как Azure зрелый и был принят более разнообразной группой разработчиков, мы были сосредоточены на изучении шаблонов и методик, чтобы обеспечить поддержку производительности разработчиков и понять пробелы, которые имеют библиотеки Spring Cloud Azure.

В Azure библиотеках Spring Cloud было выражено несколько областей согласованной обратной связи. Наиболее важным является то, что библиотеки для разных служб Azure не включили полный набор конфигураций. Кроме того, несоответствие именования проектов, идентификаторов артефактов, версий и конфигураций сделало кривую обучения крутой.

Чтобы улучшить возможности разработки в библиотеках Azure Spring Cloud, был представлен набор рекомендаций по проектированию, чтобы гарантировать, что библиотеки Spring Cloud Azure имеют естественное и идиоматичное чувство в отношении экосистемы Spring. Дополнительные сведения см. в документе design для тех, кто заинтересован.

Spring Cloud Azure 4.0 предоставляет общий интерфейс между библиотеками, интегрирующимися с различными проектами Spring Boot, Spring Boot, Spring Integration, Spring Cloud Stream и т. д. Общий интерфейс включает в себя:

• Унифицированный BOM для включения всех библиотек Spring Cloud Azure 4.0.
• Согласованное соглашение об именовании артефактов.
• Единый способ настройки учетных данных, прокси-сервера, повторных попыток, облачной среды и параметров транспортного слоя.
• Поддержка всех методов проверки подлинности службы Azure или пакета SDK службы Azure поддерживается.

Обзор

Это руководство по миграции состоит из следующих разделов:

• Изменения именования для Spring Cloud Azure 4.0
• Изменения артефакта: переименовано/ добавлено или удалено
• Изменения зависимостей
• Изменения проверки подлинности
• Свойства конфигурации
• Критические изменения API
• Изменения библиотеки

Изменения именования

Никогда не было согласованного или официального имени для вызова всех библиотек Azure Spring Cloud. Некоторые из них были вызваны Azure Spring Boot и некоторые из них Spring on Azure. С 4.0 мы начали использовать имя проекта Spring Cloud Azure для представления всех библиотек Spring Azure.

БОМ

Мы использовались для отправки двух BOM для наших библиотек, azure-spring-boot-bom и azure-spring-cloud-dependencies, но мы объединили эти два BOM в один BOM с 4.0, spring-cloud-azure-dependencies. Добавьте запись в раздел dependencyManagement проекта, чтобы воспользоваться управлением зависимостями.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>7.1.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Изменения артефакта: переименовано/ добавлено или удалено

Идентификаторы групп одинаковы для современных и устаревших библиотек Spring Cloud Azure. Все они com.azure.spring. Идентификаторы артефактов для современных библиотек Spring Cloud Azure изменились. Согласно проекту Spring, которому он принадлежит, Spring Boot, Spring Integration или Spring Cloud Stream, шаблон идентификаторов артефактов может быть spring-cloud-azure-starter-[service], spring-integration-azure-[service]или spring-cloud-azure-stream-binder-[service]. Устаревшие начальные элементы для каждого из них имеют идентификатор артефакта после azure-spring-*шаблона. Это обеспечивает быстрые и доступные средства, помогающие понять, используете ли вы современные или устаревшие начальные элементы.

В процессе разработки Spring Cloud Azure 4.0 мы переименовали некоторые артефакты, чтобы они соответствовали новым соглашениям об именовании, удалили некоторые артефакты, чтобы функциональные возможности могли быть помещены в более подходящий артефакт, и добавили некоторые новые артефакты, чтобы лучше обслуживать некоторые сценарии.

В следующей таблице показаны сопоставления между устаревшим идентификатором артефакта и современным идентификатором артефакта:

Изменения зависимостей

Некоторые ненужные зависимости были включены в устаревшие артефакты, которые мы удалили в современных библиотеках Spring Cloud Azure 4.0. Обязательно добавьте удаленные зависимости вручную в проект, чтобы предотвратить сбои.

К библиотекам, которые имеют изменения зависимостей, относятся:

• spring-cloud-azure-starter
• spring-cloud-azure-starter-active-directory
• spring-cloud-azure-starter-active-directory-b2c

Изменения проверки подлинности

Spring Cloud Azure 4.0 поддерживает все методы проверки подлинности, поддерживаемые каждым пакетом SDK службы Azure. Он позволяет настроить учетные данные глобального токена, а также предоставить учетные данные маркера на каждом уровне обслуживания. Но учетные данные не требуются для настройки Spring Cloud Azure 4.0, так как они могут применять учетные данные, хранящиеся в локальной среде разработки или управляемом удостоверении в службах Azure. Просто убедитесь, что субъект получил достаточно разрешений для доступа к целевым Azure ресурсам.

Учетные данные с цепочкой, DefaultAzureCredential bean настроены автоматически по умолчанию и будут использоваться всеми компонентами, если не указана дополнительная информация о проверке подлинности. Дополнительные сведения см. в разделе DefaultAzureCredential клиентской библиотеки Azure Identity для Java.

Свойства конфигурации

Миграция свойств

Мы создали additional-spring-configuration-metadata.json файл, чтобы сгладить миграцию свойств при использовании spring-boot-properties-migrator. Сначала добавьте в приложение следующий перенос свойств:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-properties-migrator</artifactId>
    <scope>runtime</scope>
</dependency>

Или, если вы используете Gradle:

runtime("org.springframework.boot:spring-boot-properties-migrator")

Если вы запускаете приложение, он определит свойства, которые больше не управляются Spring Cloud Azure. Если есть замена, он временно переназначит свойство для вас с предупреждением. Если нет замены, отчет об ошибке даст вам дополнительные сведения. В любом случае необходимо обновить конфигурацию и удалить зависимость после обновления конфигурации.

Прежде чем перейти, рекомендуется использовать функцию поиска интегрированной среды разработки для двойной проверки того, что вы не используете одно из свойств, перенесенных в тесте интеграции.

Глобальные конфигурации

Современная spring-cloud-azure-starter позволяет определять свойства, которые применяются ко всем Azure SDKs в пространстве имен spring.cloud.azure. Эта функция не поддерживается в устаревшей azure-spring-boot-starter. Глобальные конфигурации можно разделить на пять категорий, показанных в следующей таблице:

Полный список конфигураций см. в разделе Spring Cloud Azure свойства конфигурации.

Настройка каждого пакета SDK

Дополнительные сведения о параметрах конфигурации на уровне пакета SDK см. по следующим ссылкам:

• От azure-spring-boot-starter-active-directory до spring-cloud-azure-starter-active-directory
• От azure-spring-boot-starter-active-directory-b2c до spring-cloud-azure-starter-active-directory-b2c
• От azure-spring-boot-starter-cosmos до spring-cloud-azure-starter-data-cosmos
• От azure-spring-boot-starter-keyvault-secrets до spring-cloud-azure-starter-keyvault-secrets
• От azure-spring-boot-starter-servicebus-jms до spring-cloud-azure-starter-servicebus-jms
• От azure-spring-boot-starter-storage до spring-cloud-azure-starter-storage-blob
• От azure-spring-boot-starter-storage до spring-cloud-azure-starter-storage-file-share
• От azure-spring-cloud-starter-eventhubs до spring-cloud-azure-starter-integration-eventhubs
• От azure-spring-cloud-starter-servicebus до spring-cloud-azure-starter-integration-servicebus
• От azure-spring-cloud-starter-storage-queue до spring-cloud-azure-starter-integration-storage-queue
• От azure-spring-cloud-stream-binder-eventhubs до spring-cloud-azure-stream-binder-eventhubs
• От azure-spring-cloud-stream-binder-servicebus-* до spring-cloud-azure-stream-binder-servicebus

Критические изменения API

Дополнительные сведения о критических изменениях API в каждой библиотеке см. по следующим ссылкам:

• От azure-spring-boot-starter-active-directory до spring-cloud-azure-starter-active-directory
• От azure-spring-boot-starter-active-directory-b2c до spring-cloud-azure-starter-active-directory-b2c
• От azure-spring-boot-starter-storage до spring-cloud-azure-starter-storage-blob
• От azure-spring-boot-starter-storage до spring-cloud-azure-starter-storage-file-share
• От azure-spring-cloud-starter-eventhubs до spring-cloud-azure-starter-integration-eventhubs
• От azure-spring-integration-eventhubs до spring-integration-azure-eventhubs
• От azure-spring-cloud-starter-servicebus до spring-cloud-azure-starter-integration-servicebus
• От azure-spring-integration-servicebus до spring-integration-azure-servicebus
• От azure-spring-cloud-starter-storage-queue до spring-cloud-azure-starter-integration-storage-queue
• От azure-spring-integration-storage-queue до spring-integration-azure-storage-queue
• От azure-spring-cloud-stream-binder-eventhubs до spring-cloud-azure-stream-binder-eventhubs
• От azure-spring-cloud-stream-binder-servicebus-* до spring-cloud-azure-stream-binder-servicebus

Изменения библиотеки

Критические изменения в каждой библиотеке представлены следующим образом.

От azure-spring-boot-starter до spring-cloud-azure-starter

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter с версии 3.azure-spring-boot-starter

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения зависимостей

Некоторые ненужные зависимости были включены в устаревшие артефакты, которые мы удалили в современных библиотеках Spring Cloud Azure 4.0. Обязательно добавьте удаленные зависимости вручную в проект, чтобы предотвратить непреднамеренный сбой.

В следующей таблице показаны удаленные зависимости:

От azure-spring-boot-starter-active-directory до spring-cloud-azure-starter-active-directory

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-active-directory с версии 3.azure-spring-boot-starter-active-directory

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения зависимостей

Некоторые ненужные зависимости в устаревшем артефакте были удалены с современной библиотеки Spring Cloud Azure 4.0. Добавьте эти удаленные зависимости в проект, чтобы предотвратить непреднамеренный сбой.

В следующей таблице показаны удаленные зависимости:

Изменения конфигурации пакета SDK

В этом разделе содержатся изменения о добавленных, удаленных и измененных свойствах.

• Следующие два пункта являются основными, чтобы обратить внимание на:

1. Префикс всех имен свойств конфигурации изменился с azure.activedirectory на spring.cloud.azure.active-directory.
2. Добавлено новое свойство spring.cloud.azure.active-directory.enabled, чтобы включить или отключить связанные функции Microsoft Entra. Значение по умолчанию — false.

В следующей таблице показаны сопоставления свойств между azure-spring-boot-starter-active-directory и spring-cloud-azure-starter-active-directory:

• Тип значения следующих свойств изменяется с long на Duration:

  • jwt-connect-timeout
  • jwt-read-timeout
  • jwk-set-cache-lifespan
  • jwk-set-cache-refresh-time.

• Удаляются следующие свойства:

  • azure.activedirectory.allow-telemetry
  • azure.activedirectory.user-group.enable-full-list
  • azure.activedirectory.graph-base-uri
  • azure.activedirectory.graph-membership-uri

• Добавлены следующие свойства:

  • spring.cloud.azure.active-directory.enabled
  • spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint
  • spring.cloud.azure.active-directory.user-group.use-transitive-members

Ниже приведены некоторые примеры миграции:

• Пример 1. Случай 1

  • Для устаревших версий: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf

  • Для современных: spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint=https://graph.microsoft.com/ + spring.cloud.azure.active-directory.user-group.use-transitive-members=false

• Пример 2. Случай 2

  • Для устаревших версий: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf

  • Для современных: spring.cloud.azure.active-directory.profile.environment.microsoft-graph-endpoint=https://graph.microsoft.com/ + spring.cloud.azure.active-directory.user-group.use-transitive-members=true

Изменения API

В следующей таблице показаны сопоставления классов из azure-spring-boot-starter-active-directory в spring-cloud-azure-starter-active-directory:

В этом разделе перечислены удаленные классы из azure-spring-boot-starter-active-directory.

• Удален устаревший класс

  • com.azure.spring.aad.webapp.AADHandleConditionalAccessFilter
  • com.azure.spring.aad.webapi.validator.AADJwtAudienceValidator
  • com.azure.spring.aad.webapi.validator.AADJwtClaimValidator

От azure-spring-boot-starter-active-directory-b2c до spring-cloud-azure-starter-active-directory-b2c

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-active-directory-b2c с версии 3.azure-spring-boot-starter-active-directory-b2c

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения зависимостей

Некоторые ненужные зависимости были включены в устаревшие артефакты, которые мы удалили в современных библиотеках Spring Cloud Azure 4.0. Обязательно добавьте удаленные зависимости вручную в проект, чтобы предотвратить непреднамеренный сбой.

В следующей таблице показаны удаленные зависимости:

Изменения конфигурации пакета SDK

В этом разделе содержатся изменения о добавленных, удаленных и измененных свойствах.

• Следующие два пункта являются основными, чтобы обратить внимание на:

1. Все имена свойств конфигурации изменили префикс с azure.activedirectory.b2c на spring.cloud.azure.active-directory.b2c.
2. Добавлено новое свойство spring.cloud.azure.active-directory.b2c.enabled, чтобы разрешить включение и отключение Azure связанных функций AD B2C. Значение по умолчанию — false.

В следующей таблице показаны сопоставления свойств из azure-spring-boot-starter-active-directory-b2c в spring-cloud-azure-starter-active-directory-b2c:

• Удалены свойства из azure-spring-boot-starter-active-directory-b2c:

  • azure.activedirectory.b2c.allow-telemetry
  • azure.activedirectory.b2c.tenant

• Тип значения следующих свойств изменяется с long на Duration:

  • jwt-connect-timeout
  • jwt-read-timeout

Изменения API

В следующей таблице показаны сопоставления классов из azure-spring-boot-starter-active-directory-b2c в spring-cloud-azure-starter-active-directory-b2c:

От azure-spring-boot-starter-cosmos до spring-cloud-azure-starter-data-cosmos

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-data-cosmos с версии 3.azure-spring-boot-starter-cosmos

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Все имена свойств конфигурации изменили префикс с azure.cosmos на spring.cloud.azure.cosmos.

В следующей таблице показаны сопоставления классов из azure-spring-boot-starter-cosmos в spring-cloud-azure-starter-data-cosmos:

От azure-spring-boot-starter-keyvault-secrets до spring-cloud-azure-starter-keyvault-secrets

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-keyvault-secrets с версии 3.azure-spring-boot-starter-keyvault-secrets

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

В этом разделе содержатся изменения о добавленных, удаленных и измененных свойствах.

В следующей таблице показаны сопоставления свойств из azure-spring-boot-starter-keyvault-secrets в spring-cloud-azure-starter-keyvault-secrets:

• Удалены свойства из spring-cloud-azure-starter-keyvault-secrets:

  • azure.keyvault.allow-telemetry
  • azure.keyvault.order

Следующие моменты следует обратить внимание на следующее:

1. Все имена свойств конфигурации изменили префикс с azure.keyvault на spring.cloud.azure.keyvault.secret.
2. spring.cloud.azure.keyvault.secret.enabled используется для включения всех функций секрета Key Vault, включения настройки Key Vault клиентских компонентов секрета (например, SecretClient и SecretAsyncClient) и добавления KeyVaultPropertySource в ConfigurableEnvironment.
3. spring.cloud.azure.keyvault.secret.property-source-enabled используется для включения всех KeyVaultPropertySource. Оно вступит в силу только в том случае, если spring.cloud.azure.keyvault.secret.enabled=true.
4. Для общих свойств Azure (например, client, proxy, retry, credential, profile) и свойств Key Vault (например, endpoint, service-version). Если spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME не настроено, будет использоваться spring.cloud.azure.keyvault.secret.PROPERTY_NAME.
5. spring.cloud.azure.keyvault.secret.property-sources[n].resource зависит от уникального ресурса Azure, поэтому если он не настроен, он не получит значение из других мест.

От azure-spring-boot-starter-servicebus-jms до spring-cloud-azure-starter-servicebus-jms

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-servicebus-jms с версии 3.azure-spring-boot-starter-servicebus-jms

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Тип конфигурации для spring.jms.servicebus.idle-timeout изменения long (миллисекунда) на Duration шаблон для удобства чтения.

От azure-spring-boot-starter-storage до spring-cloud-azure-starter-storage-blob

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-storage-blob с версии 3.azure-spring-boot-starter-storage

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Все имена свойств конфигурации изменили префикс с azure.storage на spring.cloud.azure.storage.blob.

В следующей таблице показаны сопоставления свойств из azure-spring-boot-starter-storage в spring-cloud-azure-starter-storage-blob:

Изменения API

В следующей таблице показаны сопоставления классов из azure-spring-boot-starter-storage в spring-cloud-azure-starter-storage-blob:

От azure-spring-boot-starter-storage до spring-cloud-azure-starter-storage-file-share

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-storage-file-share с версии 3.azure-spring-boot-starter-storage

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Все имена свойств конфигурации изменили префикс с azure.storage на spring.cloud.azure.storage.fileshare.

В следующей таблице показаны сопоставления свойств из azure-spring-boot-starter-storage в spring-cloud-azure-starter-storage-file-share:

Изменения API

В следующей таблице показаны сопоставления классов из azure-spring-boot-starter-storage в spring-cloud-azure-starter-storage-file-share:

От azure-spring-cloud-starter-eventhubs до spring-cloud-azure-starter-integration-eventhubs

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-integration-eventhubs с версии 2.azure-spring-cloud-starter-eventhubs

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Изменения дочерних записей для этого префикса см. в следующих таблицах:

В следующей таблице показаны сопоставления свойств из azure-spring-cloud-starter-eventhubs в spring-cloud-azure-starter-integration-eventhubs:

Например, изменение с:

spring:
  cloud:
    azure:
      eventhub:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME}
        checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY}
        checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME}

Кому:

spring:
  cloud:
    azure:
      eventhubs:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        processor:
          checkpoint-store:
            container-name: ${AZURE_STORAGE_CONTAINER_NAME}
            account-name: ${AZURE_STORAGE_ACCOUNT_NAME}
            account-key: ${AZURE_STORAGE_ACCOUNT_KEY}

Изменения API

• Сведения об изменениях примечаний прослушивателя см. в руководстве по миграции <<библиотеке>> миграции azure-spring-cloud-messaging.
• Удалите EventHubOperation с функцией подписки, перемещенной в класс EventHubsMessageListenerContainer, и функция отправки перемещена в EventHubsTemplate.
• Переименуйте EventHubInboundChannelAdapter как EventHubsInboundChannelAdapter, чтобы обеспечить согласованность со службой Azure Event Hubs.
• Измените конструктор с EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) на EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) и EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Измените стиль создания CheckpointConfig на простой конструктор вместо стиля сборки.
• Удаление EventHubOperation#setCheckpointConfigAPI. Чтобы задать конфигурацию контрольной точки для адаптера входящего канала, пользователи могут вызвать метод EventHubsContainerProperties#setCheckpointConfig.
• Удаление EventHubOperation#setBatchConsumerConfigAPI. Чтобы задать конфигурацию пакетного использования для адаптера входящего канала, пользователи могут вызывать два метода EventHubsContainerProperties#getBatch#setMaxSize и EventHubsContainerProperties#getBatch#setMaxWaitTime между тем.
• Для режима использования пакетной службы измените имена заголовков сообщений, преобразованные из пакетных сообщений.
  • Измените заголовок сообщения с azure_eventhub_enqueued_time на azure_eventhubs_batch_converted_enqueued_time.
  • Измените заголовок сообщения с azure_eventhub_offset на azure_eventhubs_batch_converted_offset.
  • Измените заголовок сообщения с azure_eventhub_sequence_number на azure_eventhubs_batch_converted_sequence_number.
  • Измените заголовок сообщения с azure_partition_key на azure_batch_converted_partition_key.
• При публикации сообщений в Центры событий игнорируйте все заголовки сообщений, преобразованные из пакетных сообщений. К заголовкам относятся:
  • azure_batch_converted_partition_key
  • azure_eventhubs_batch_converted_enqueued_time
  • azure_eventhubs_batch_converted_offset
  • azure_eventhubs_batch_converted_sequence_number
  • azure_eventhubs_batch_converted_system_properties
  • azure_eventhubs_batch_converted_application_properties
• Режим контрольной точки BATCH работает только в режиме пакетного использования, который можно включить, передав ListenerMode.BATCH в конструктор EventHubsInboundChannelAdapter.

В следующей таблице показаны сопоставления классов из azure-spring-cloud-starter-eventhubs в spring-cloud-azure-starter-integration-eventhubs:

Пример фрагмента кода

• EventHubsInboundChannelAdapter пример кода:

  Устаревший код:

  public class Demo {
      @Bean
      public EventHubInboundChannelAdapter messageChannelAdapter(
          @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel, EventHubOperation   eventhubOperation) {
          eventhubOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode  (CheckpointMode.MANUAL).build());
          EventHubInboundChannelAdapter adapter = new EventHubInboundChannelAdapter("EVENTHUB_NAME",
              eventhubOperation, "CONSUMER_GROUP");
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  }
  

  Современный код:

  public class Demo {
      @Bean
      public EventHubsMessageListenerContainer messageListenerContainer(EventHubsProcessorFactory processorFactory) {
          EventHubsContainerProperties containerProperties = new EventHubsContainerProperties();
          containerProperties.setEventHubName("EVENTHUB_NAME");
          containerProperties.setConsumerGroup("CONSUMER_GROUP");
          CheckpointConfig config = new CheckpointConfig(CheckpointMode.MANUAL);
          containerProperties.setCheckpointConfig(config);
          return new EventHubsMessageListenerContainer(processorFactory, containerProperties);
      }
  
      @Bean
      public EventHubsInboundChannelAdapter messageChannelAdapter(@Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
                                                                  EventHubsMessageListenerContainer listenerContainer) {
          EventHubsInboundChannelAdapter adapter = new EventHubsInboundChannelAdapter(listenerContainer);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  }
  

• DefaultMessageHandler пример кода:

  Устаревший код:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
      public MessageHandler messageSender(EventHubOperation eventhubOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully.");
              }
  
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.error("There was an error sending the message.", ex);
              }
          });
          return handler;
      }
  }
  

  Современный код:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL")
      public MessageHandler messageSender(EventHubsTemplate eventhubOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("EVENTHUB_NAME", eventhubOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully.");
              }
  
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.error("There was an error sending the message.", ex);
              }
          });
  
          return handler;
      }
  }
  

От azure-spring-integration-eventhubs до spring-integration-azure-eventhubs

Это руководство предназначено для поддержки миграции spring-integration-azure-eventhubs с версии 2.azure-spring-integration-eventhubs

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.

Изменения API

• Удалите EventHubOperation с функцией подписки, перемещенной в класс EventHubsMessageListenerContainer, и функция отправки перемещена в EventHubsTemplate.
• Переименуйте EventHubInboundChannelAdapter как EventHubsInboundChannelAdapter, чтобы обеспечить согласованность со службой Azure Event Hubs.
• Измените конструктор с EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) на EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) и EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Измените стиль создания CheckpointConfig на простой конструктор вместо стиля сборки.
• Удаление EventHubOperation#setCheckpointConfigAPI. Чтобы задать конфигурацию контрольной точки для адаптера входящего канала, пользователи могут вызвать метод EventHubsContainerProperties#setCheckpointConfig.
• Удаление EventHubOperation#setBatchConsumerConfigAPI. Чтобы задать конфигурацию пакетного использования для адаптера входящего канала, пользователи могут вызывать два метода EventHubsContainerProperties#getBatch#setMaxSize и EventHubsContainerProperties#getBatch#setMaxWaitTime между тем.
• Для режима использования пакетной службы измените имена заголовков сообщений, преобразованные из пакетных сообщений.
  • Измените заголовок сообщения с azure_eventhub_enqueued_time на azure_eventhubs_batch_converted_enqueued_time.
  • Измените заголовок сообщения с azure_eventhub_offset на azure_eventhubs_batch_converted_offset.
  • Измените заголовок сообщения с azure_eventhub_sequence_number на azure_eventhubs_batch_converted_sequence_number.
  • Измените заголовок сообщения с azure_partition_key на azure_batch_converted_partition_key.
• При публикации сообщений в Центры событий игнорируйте все заголовки сообщений, преобразованные из пакетных сообщений. К заголовкам относятся:
  • azure_batch_converted_partition_key
  • azure_eventhubs_batch_converted_enqueued_time
  • azure_eventhubs_batch_converted_offset
  • azure_eventhubs_batch_converted_sequence_number
  • azure_eventhubs_batch_converted_system_properties
  • azure_eventhubs_batch_converted_application_properties
• Режим контрольной точки BATCH работает только в режиме пакетного использования, который можно включить, передав ListenerMode.BATCH в конструктор EventHubsInboundChannelAdapter.

В следующей таблице показаны сопоставления классов из azure-spring-integration-eventhubs в spring-integration-azure-eventhubs:

От azure-spring-cloud-starter-servicebus до spring-cloud-azure-starter-integration-servicebus

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-integration-servicebus с версии 2.azure-spring-cloud-starter-servicebus

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Для всех параметров конфигурации, поддерживаемых в spring-cloud-azure-starter-integration-servicebus, префикс остается spring.cloud.azure.servicebus.

В следующей таблице показаны сопоставления свойств из azure-spring-cloud-starter-servicebus в spring-cloud-azure-starter-integration-servicebus:

Изменения API

• Удалите ServiceBusQueueOperation и ServiceBusTopicOperation с функцией подписки, перемещенной в класс ServiceBusMessageListenerContainer, и функция отправки перемещена в ServiceBusTemplate.
• Удалите ServiceBusQueueInboundChannelAdapter и ServiceBusTopicInboundChannelAdapter и переместите функциональные возможности для Service Bus прослушивания сущности очереди или раздела в ServiceBusInboundChannelAdapter.
• Измените конструктор с ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) на ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) и ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Измените конструктор с ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) на ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) и ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Удаление API-интерфейсов ServiceBusQueueOperation#setCheckpointConfig и ServiceBusTopicOperation#setCheckpointConfig. Чтобы задать конфигурацию контрольной точки для адаптера входящего канала, пользователи могут вызывать метод ServiceBusContainerProperties#setAutoComplete. Отключение режима автоматического завершения эквивалентно MANUAL режиму контрольных точек и включен режиму RECORD.
• Удаление API-интерфейсов ServiceBusQueueOperatio#setClientConfig и ServiceBusTopicOperation#setClientConfig. Чтобы настроить базовый ServiceBusProcessorClient, используемый адаптером входящего канала, пользователи могут использовать вместо этого ServiceBusContainerProperties.
• Удалите поддержку CompletableFuture в ServiceBusTemplate и DefaultMessageHandler, вместо этого поддержку Reactor.
• Добавьте новый API ServiceBusTemplate#setDefaultEntityType, чтобы указать тип сущности, который требуется, если для PropertiesSupplier<String, ProducerProperties>не предоставляется ни ProducerProperties#entityType.
• Удаление заголовка сообщения AzureHeaders.RAW_ID. Вместо этого используйте ServiceBusMessageHeaders.MESSAGE_ID.

В следующей таблице показаны сопоставления классов из azure-spring-cloud-starter-servicebus в spring-cloud-azure-starter-integration-servicebus:

Пример фрагмента кода

• ServiceBusInboundChannelAdapter пример кода:

  Устаревший код использования ServiceBusQueueInboundChannelAdapter или ServiceBusTopicInboundChannelAdapter:

  public class Demo {
      @Bean
      public ServiceBusQueueInboundChannelAdapter queueMessageChannelAdapter(
          @Qualifier("INPUT_CHANNEL_NAME") MessageChannel inputChannel, ServiceBusQueueOperation queueOperation) {
          queueOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build());
          ServiceBusQueueInboundChannelAdapter adapter = new ServiceBusQueueInboundChannelAdapter("QUEUE_NAME",
              queueOperation);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  
      @Bean
      public ServiceBusTopicInboundChannelAdapter topicMessageChannelAdapter(
          @Qualifier("INPUT_CHANNEL_NAME") MessageChannel inputChannel, ServiceBusTopicOperation topicOperation) {
          topicOperation.setCheckpointConfig(CheckpointConfig.builder().checkpointMode(CheckpointMode.MANUAL).build());
          ServiceBusTopicInboundChannelAdapter adapter = new ServiceBusTopicInboundChannelAdapter("TOPIC_NAME",
              topicOperation, "SUBSCRIPTION_NAME");
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  
  }
  

  Современный код:

  public class Demo {
      @Bean("queue-listener-container")
      public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
          ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
          containerProperties.setEntityName("QUEUE_NAME");
          containerProperties.setAutoComplete(false);
          return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
      }
  
      @Bean
      public ServiceBusInboundChannelAdapter queueMessageChannelAdapter(
          @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
          @Qualifier("queue-listener-container") ServiceBusMessageListenerContainer listenerContainer) {
          ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  
      @Bean("topic-listener-container")
      public ServiceBusMessageListenerContainer messageListenerContainer(ServiceBusProcessorFactory processorFactory) {
          ServiceBusContainerProperties containerProperties = new ServiceBusContainerProperties();
          containerProperties.setEntityName("TOPIC_NAME");
          containerProperties.setSubscriptionName("SUBSCRIPTION_NAME");
          containerProperties.setAutoComplete(false);
          return new ServiceBusMessageListenerContainer(processorFactory, containerProperties);
      }
  
      @Bean
      public ServiceBusInboundChannelAdapter topicMessageChannelAdapter(
          @Qualifier("INPUT_CHANNEL") MessageChannel inputChannel,
          @Qualifier("topic-listener-container") ServiceBusMessageListenerContainer listenerContainer) {
          ServiceBusInboundChannelAdapter adapter = new ServiceBusInboundChannelAdapter(listenerContainer);
          adapter.setOutputChannel(inputChannel);
          return adapter;
      }
  }
  

• DefaultMessageHandler пример кода:

  Устаревший код, принимающие очередь в качестве примера:

  public class Demo {
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME")
      public MessageHandler queueMessageSender(ServiceBusQueueOperation queueOperation) {
          DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", queueOperation);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully.");
              }
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.info("There was an error sending the message.");
              }
          });
          return handler;
      }
  }
  

  Современный код:

  public class Demo {
  
      @Bean
      @ServiceActivator(inputChannel = "OUTPUT_CHANNEL_NAME")
      public MessageHandler queueMessageSender(ServiceBusTemplate serviceBusTemplate) {
          serviceBusTemplate.setDefaultEntityType(ServiceBusEntityType.QUEUE);
          DefaultMessageHandler handler = new DefaultMessageHandler("QUEUE_NAME", serviceBusTemplate);
          handler.setSendCallback(new ListenableFutureCallback<Void>() {
              @Override
              public void onSuccess(Void result) {
                  LOGGER.info("Message was sent successfully for {}.", "QUEUE_NAME");
              }
  
              @Override
              public void onFailure(Throwable ex) {
                  LOGGER.info("There was an error sending the message.");
              }
          });
  
          return handler;
      }
  }
  

От azure-spring-integration-servicebus до spring-integration-azure-servicebus

Это руководство предназначено для поддержки миграции spring-integration-azure-servicebus с версии 2.azure-spring-integration-servicebus

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.

Изменения API

• Удалите ServiceBusQueueOperation и ServiceBusTopicOperation с функцией подписки, перемещенной в класс ServiceBusMessageListenerContainer, и функция отправки перемещена в ServiceBusTemplate.
• Удалите ServiceBusQueueInboundChannelAdapter и ServiceBusTopicInboundChannelAdapter и переместите функциональные возможности для Service Bus прослушивания сущности очереди или раздела в ServiceBusInboundChannelAdapter.
• Измените конструктор с ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) на ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) и ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Измените конструктор с ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) на ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) и ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Удаление API-интерфейсов ServiceBusQueueOperation#setCheckpointConfig и ServiceBusTopicOperation#setCheckpointConfig. Чтобы задать конфигурацию контрольной точки для адаптера входящего канала, пользователи могут вызывать метод ServiceBusContainerProperties#setAutoComplete. Отключение режима автоматического завершения эквивалентно MANUAL режиму контрольных точек и включен режиму RECORD.
• Удаление API-интерфейсов ServiceBusQueueOperation#setClientConfig и ServiceBusTopicOperation#setClientConfig. Чтобы настроить базовый ServiceBusProcessorClient, используемый адаптером входящего канала, пользователи могут использовать вместо этого ServiceBusContainerProperties.
• Удалите поддержку CompletableFuture в ServiceBusTemplate и DefaultMessageHandler, вместо этого поддержку Reactor.
• Добавьте новый API ServiceBusTemplate#setDefaultEntityType, чтобы указать тип сущности, который требуется, если для PropertiesSupplier<String, ProducerProperties>не предоставляется ни ProducerProperties#entityType.
• Удаление заголовка сообщения AzureHeaders.RAW_ID. Вместо этого используйте ServiceBusMessageHeaders.MESSAGE_ID.

В следующей таблице показаны сопоставления классов из azure-spring-integration-servicebus в spring-integration-azure-servicebus:

От azure-spring-cloud-starter-storage-queue до spring-cloud-azure-starter-integration-storage-queue

Это руководство предназначено для поддержки миграции spring-cloud-azure-starter-integration-storage-queue с версии 2.azure-spring-cloud-starter-storage-queue

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Все имена свойств конфигурации изменили префикс с spring.cloud.azure.storage на spring.cloud.azure.storage.queue.

В следующей таблице показаны сопоставления свойств из azure-spring-cloud-starter-storage-queue в spring-cloud-azure-starter-integration-storage-queue:

Изменения API

• Удалите StorageQueueOperation и укажите вместо этого StorageQueueTemplate.
• Удаление конфигурации checkpoint-mode в StorageQueueTemplateподдерживает только режим MANUAL.

В следующей таблице показаны сопоставления классов из azure-spring-cloud-starter-storage-queue в spring-cloud-azure-starter-integration-storage-queue.

От azure-spring-integration-storage-queue до spring-integration-azure-storage-queue

Это руководство предназначено для поддержки миграции spring-integration-azure-storage-queue с версии 2.azure-spring-integration-storage-queue

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.

Изменения API

• Удалите StorageQueueOperation и укажите вместо этого StorageQueueTemplate.
• Удаление конфигурации checkpoint-mode в StorageQueueTemplateподдерживает только режим MANUAL.

В следующей таблице показаны сопоставления классов из azure-spring-integration-storage-queue в spring-integration-azure-storage-queue.

От azure-spring-cloud-stream-binder-eventhubs до spring-cloud-azure-stream-binder-eventhubs

Это руководство предназначено для поддержки миграции spring-cloud-azure-stream-binder-eventhubs с версии 2.azure-spring-cloud-stream-binder-eventhubs

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

Изменения дочерних записей для следующего префикса см. в следующей таблице.

В следующей таблице показаны сопоставления свойств из azure-spring-cloud-stream-binder-eventhubs в spring-cloud-azure-stream-binder-eventhubs:

Примеры миграции конфигурации

Чтобы использовать connection string для проверки подлинности и перенести указанные выше свойства, изменения конфигурации перечислены ниже.

Устаревшая конфигурация:

spring:
  cloud:
    azure:
      eventhub:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        checkpoint-storage-account: ${AZURE_CHECKPOINT_STORAGE_ACCOUNT_NAME}
        checkpoint-access-key: ${AZURE_CHECKPOINT_ACCOUNT_KEY}
        checkpoint-container: ${AZURE_CHECKPOINT_CONTAINER_NAME}
    stream:
      eventhub:
        bindings:
          <binding-name>:
            consumer:
              max-batch-size: ${AZURE_MAX_BATCH_SIZE}
              max-wait-time: ${AZURE_MAX_WAIT_TIME}
              checkpoint-mode: ${AZURE_CHECKPOINT_MODE}
              checkpoint-count: ${AZURE_CHECKPOINT_COUNT}
              checkpoint-interval: ${AZURE_CHECKPOINT_INTERVAL}
              start-position: EARLIEST

Современная конфигурация:

spring:
  cloud:
    azure:
      eventhubs:
        connection-string: ${AZURE_EVENTHUBS_CONNECTION_STRING}
        processor:
          checkpoint-store:
            container-name: ${AZURE_STORAGE_CONTAINER_NAME}
            account-name:  ${AZURE_STORAGE_ACCOUNT_NAME}
            account-key: ${AZURE_STORAGE_ACCOUNT_KEY}
    stream:
      eventhubs:
        bindings:
          <binding-name>:
            consumer:
              batch:
                max-size: ${AZURE_MAX_BATCH_SIZE}
                max-wait-time: ${AZURE_MAX_WAIT_TIME}
              checkpoint:
                mode: ${AZURE_CHECKPOINT_MODE}
                count: ${AZURE_CHECKPOINT_COUNT}
                interval: ${AZURE_CHECKPOINT_INTERVAL}
              initial-partition-event-position:
                0:
                  offset: earliest
                1:
                  sequence-number: 100
                2:
                  enqueued-date-time: 2022-01-12T13:32:47.650005Z
                4:
                  inclusive: false

Если вместо строк подключения используются субъекты безопасности, в версиях до 4.0 приложение сначала подключается к Azure Resource Manager (ARM) с указанным субъектом безопасности, а затем извлекает connection string указанного пространства имен с помощью ARM. В конце концов приложение использует полученный connection string для подключения к Azure Event Hubs. Таким образом, предоставленный субъект безопасности должен быть предоставлен с помощью роли Contributor для получения связанного пространства имен Azure Event Hubs.

Для Azure Spring Apps 4.0 мы предоставляем два способа использования субъектов безопасности для проверки подлинности. Один по-прежнему использует субъекты для подключения к ARM и получения строк подключения, где для субъектов требуется роль Contributor. Другой использует субъекты безопасности для проверки подлинности для Microsoft Entra ID и последующего подключения к Azure Event Hubs напрямую. В этом случае роль Contributor больше не требуется, а для операций обмена сообщениями требуются другие Data связанные роли. Чтобы убедиться, что субъекту безопасности предоставлено достаточное разрешение на доступ к ресурсу Azure, см. раздел Authorize access with Microsoft Entra ID.

Для проверки подлинности на основе ARM, принимая субъект-службу в качестве примера, миграция конфигурации приведена ниже, где назначенная роль не должна изменяться:

Устаревшая конфигурация:

spring:
  cloud:
    azure:
      client-id: ${AZURE_CLIENT_ID}
      client-secret: ${AZURE_CLIENT_SECRET}
      tenant-id: <tenant>
      resource-group: ${EVENTHUB_RESOURCE_GROUP}
      eventhub:
        namespace: ${EVENTHUB_NAMESPACE}

Требуется современная конфигурация, свойства для идентификатора подписки Azure и группы ресурсов:

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

Вы также можете выполнить миграцию для проверки подлинности и авторизации с помощью Microsoft Entra ID напрямую без обхода в ARM. Обязательно предоставьте субъекту безопасности необходимые роли Data для операций обмена сообщениями. Ниже перечислены примеры конфигурации субъекта-службы и управляемого удостоверения:

• С субъектом-службой

  spring:
    cloud:
      azure:
        credential:
          client-id: ${AZURE_CLIENT_ID}
          client-secret: ${AZURE_CLIENT_SECRET}
        profile:
          tenant-id: <tenant>
        eventhubs:
          namespace: ${EVENTHUB_NAMESPACE}
  

• С управляемым удостоверением

  spring:
    cloud:
      azure:
        credential:
          managed-identity-enabled: true
          client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned managed identity
        eventhubs:
          namespace: ${EVENTHUB_NAMESPACE}
  

Изменения API

В следующей таблице показаны сопоставления классов из azure-spring-cloud-stream-binder-eventhubs в spring-cloud-azure-stream-binder-eventhubs.

От azure-spring-cloud-stream-binder-servicebus-* до spring-cloud-azure-stream-binder-servicebus

Это руководство предназначено для поддержки миграции spring-cloud-azure-stream-binder-servicebus с версии 2 azure-spring-cloud-stream-binder-servicebus-queue или azure-spring-cloud-stream-binder-servicebus-topic.

Для получения общих сведений используйте следующие ссылки:

• Общие сведения об изменениях в версии 4.0 см. в разделах Введение и преимущества миграции.
• Дополнительные сведения о изменениях стратегии в именовании проекта см. в разделе Изменения именования.
• Чтобы узнать, как использовать одну BOM для всех библиотек Azure Spring Cloud, см. раздел BOM.
• Сведения об обработке проверки подлинности в Spring Cloud Azure 4.0 см. в разделе Authentication.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе Настройка каждого пакета SDK.
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе Глобальные конфигурации.

Изменения конфигурации пакета SDK

В следующей таблице перечислены новые свойства конфигурации spring-cloud-azure-stream-binder-servicebus:

В следующей таблице показаны сопоставления свойств из azure-spring-cloud-stream-binder-servicebus-* в spring-cloud-azure-stream-binder-servicebus:

Примеры миграции конфигурации

Устаревшая конфигурация, принимая очередь в качестве примера:

spring:
  cloud:
    azure:
      servicebus:
        connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING}
    stream:
      function:
        definition: consume;supply
      bindings:
        consume-in-0:
          destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
        supply-out-0:
          destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
      servicebus:
        queue:
          bindings:
            consume-in-0:
              consumer:
                checkpoint-mode: MANUAL

Современная конфигурация:

spring:
  cloud:
    azure:
      servicebus:
        connection-string: ${AZURE_SERVICEBUS_BINDER_CONNECTION_STRING}
    stream:
      function:
        definition: consume;supply
      bindings:
        consume-in-0:
          destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
        supply-out-0:
          destination: ${AZURE_SERVICEBUS_QUEUE_NAME}
      servicebus:
        bindings:
          consume-in-0:
            consumer:
              auto-complete: false
          supply-out-0:
            producer:
              entity-type: queue #set as topic if needed

Если вместо строк подключения используются субъекты безопасности, в версиях до 4.0 приложение сначала подключается к Azure Resource Manager (ARM) с указанным субъектом безопасности, а затем извлекает connection string указанного пространства имен с помощью ARM. В конце концов приложение использует полученный connection string для подключения к Azure Service Bus. Таким образом, предоставленный субъект безопасности должен быть предоставлен с помощью роли Contributor для получения связанного пространства имен Azure Service Bus.

Для Azure Spring Apps 4.0 мы предоставляем два способа использования субъектов безопасности для проверки подлинности. Один по-прежнему использует субъекты для подключения к ARM и получения строк подключения, где для субъектов требуется роль Contributor. Другой использует субъекты безопасности для проверки подлинности для Microsoft Entra ID и последующего подключения к Azure Service Bus напрямую. В этом случае роль Contributor больше не требуется, а для операций обмена сообщениями требуются другие Data связанные роли. Чтобы убедиться, что субъекту безопасности предоставлено достаточное разрешение на доступ к ресурсу Azure, см. раздел Authorize access with Microsoft Entra ID.

Для проверки подлинности на основе ARM, принимая субъект-службу в качестве примера, миграция конфигурации приведена ниже, где назначенная роль не должна изменяться:

Устаревшая конфигурация:

spring:
  cloud:
    azure:
      client-id: ${AZURE_CLIENT_ID}
      client-secret: ${AZURE_CLIENT_SECRET}
      tenant-id: <tenant>
      resource-group: ${SERVICEBUS_RESOURCE_GROUP}
      servicebus:
        namespace: ${SERVICEBUS_NAMESPACE}

Требуется современная конфигурация, свойства для идентификатора подписки Azure и группы ресурсов:

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

Вы также можете выполнить миграцию для проверки подлинности и авторизации с помощью Microsoft Entra ID напрямую без обхода в ARM. Обязательно предоставьте субъекту безопасности необходимые роли Data для операций обмена сообщениями. Ниже перечислены примеры конфигурации субъекта-службы и управляемого удостоверения:

• С субъектом-службой

  spring:
    cloud:
      azure:
        credential:
          client-id: ${AZURE_CLIENT_ID}
          client-secret: ${AZURE_CLIENT_SECRET}
        profile:
          tenant-id: <tenant>
        servicebus:
          namespace: ${SERVICEBUS_NAMESPACE}
  

• С управляемым удостоверением

  spring:
    cloud:
      azure:
        credential:
          managed-identity-enabled: true
          client-id: ${AZURE_MANAGED_IDENTITY_CLIENT_ID} # Only needed when using a user-assigned   managed identity
        servicebus:
          namespace: ${SERVICEBUS_NAMESPACE}
  

Изменения API

• Удаление заголовка сообщения AzureHeaders.RAW_ID. Вместо этого используйте ServiceBusMessageHeaders.MESSAGE_ID.

В следующей таблице показаны сопоставления классов из azure-spring-cloud-stream-binder-eventhubs в spring-cloud-azure-stream-binder-eventhubs.

azure-spring-cloud-messaging

Библиотека com.azure.spring:azure-spring-cloud-messaging не готова к версии 4.0. Функция заметок прослушивателя находится в состоянии изменения, поэтому в настоящее время не поддерживаются @AzureMessageListener, @AzureMessageListenersи @EnableAzureMessaging заметки.