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

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

Введение

Мы вызовем библиотеки, идентификатор группы и артефакты которых соответствуют шаблону com.azure.spring:spring-cloud-azure-*современных библиотек, а также библиотек с шаблоном com.azure.spring:azure-spring-boot-*com.azure.spring:azure-spring-cloud-*или com.azure.spring:azure-spring-integration-* устаревшими библиотеками.

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

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

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

Преимущества переноса

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

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

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

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

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

Обзор

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

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

Изменение имен.

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

Спецификация

Мы использовали для отправки двух 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>4.14.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

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

Идентификаторы групп совпадают с современными и устаревшими библиотеками Azure Spring Cloud. Они все com.azure.spring. Идентификаторы артефактов для современных библиотек Azure Spring Cloud изменились. Согласно проекту 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 для Java.

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

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

Мы создали файл дополнительных 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 позволяет определить свойства, которые применяются ко всем пакетам SDK Azure в пространстве spring.cloud.azureимен. Эта функция не поддерживается в устаревшей azure-spring-boot-starterверсии. Глобальные конфигурации можно разделить на пять категорий, показанных в следующей таблице:

Префикс	Description
spring.cloud.azure.client	Настраивает клиенты транспорта под каждым пакетом SDK Azure.
Spring.cloud.azure.credential	Настраивает проверку подлинности с помощью идентификатора Microsoft Entra.
Spring.cloud.azure.profile	Настраивает облачную среду Azure.
Spring.cloud.azure.proxy	Настраивает параметры прокси-сервера, применяется ко всем клиентам Пакета SDK Azure.
Spring.cloud.azure.retry	Настраивает параметры повторных попыток, применяется ко всем клиентам Пакета SDK Azure. Параметры повторных попыток поддерживают часть пакетов SDK, нет spring.cloud.azure.cosmos.retry.

Полный список конфигураций см. в разделе "Свойства конфигурации 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-secret в spring-cloud-azure-starter-keyvault-secret
• С 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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать 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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

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

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

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

1. Префикс всех имен свойств конфигурации изменился на azure.activedirectoryspring.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:

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

  • 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-directoryspring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

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

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

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

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

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

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

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

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

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

Изменения API

В следующей таблице показаны сопоставления классов от azure-spring-boot-starter-active-directory-b2cspring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

Из azure-spring-boot-starter-keyvault-secret в spring-cloud-azure-starter-keyvault-secret

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

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

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

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

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

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

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

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

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

1. Все имена свойств конфигурации изменили префикс на azure.keyvaultspring.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, , retryproxy, 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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать 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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

Устаревшие свойства	Современные свойства
azure.storage.account-name	spring.cloud.azure.storage.blob.account-name
azure.storage.account-key	spring.cloud.azure.storage.blob.account-key
azure.storage.blob-endpoint	spring.cloud.azure.storage.blob.endpoint

Изменения API

В следующей таблице показаны сопоставления классов от azure-spring-boot-starter-storagespring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

Устаревшие свойства	Современные свойства
azure.storage.account-name	spring.cloud.azure.storage.fileshare.account-name
azure.storage.account-key	spring.cloud.azure.storage.fileshare.account-key
azure.storage.file-endpoint	spring.cloud.azure.storage.fileshare.endpoint

Изменения API

В следующей таблице показаны сопоставления классов от azure-spring-boot-starter-storagespring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

В следующей таблице показаны сопоставления свойств от azure-spring-cloud-starter-eventhubsspring-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

• Сведения об изменениях примечаний прослушивателя см. в руководстве <<по миграции в библиотеке сообщений migration-azure-spring-cloud-messaging, azure-spring-cloud-messaging>> .
• Удалите EventHubOperation с функцией подписки, перемещенной в класс EventHubsMessageListenerContainer , и функция отправки перемещена в EventHubsTemplate.
• Переименуйте EventHubInboundChannelAdapter имя EventHubsInboundChannelAdapter в соответствии со службой Центры событий Azure.
• Изменение конструктора на EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String)EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) и EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Измените CheckpointConfig стиль экземпляра на простой конструктор вместо стиля сборки.
• Удалить API EventHubOperation#setCheckpointConfig. Чтобы задать конфигурацию проверка point для адаптера входящего канала, пользователи могут вызвать методEventHubsContainerProperties#setCheckpointConfig.
• Удалить API EventHubOperation#setBatchConsumerConfig. Чтобы задать конфигурацию пакетного использования для адаптера входящего канала, пользователи могут вызывать два метода EventHubsContainerProperties#getBatch#setMaxSize и EventHubsContainerProperties#getBatch#setMaxWaitTime между тем.
• Для режима использования пакетной службы измените имена заголовков сообщений, преобразованные из пакетных сообщений.
  • Измените заголовок сообщения на azure_eventhub_enqueued_timeazure_eventhubs_batch_converted_enqueued_time.
  • Измените заголовок сообщения на azure_eventhub_offsetazure_eventhubs_batch_converted_offset.
  • Измените заголовок сообщения на azure_eventhub_sequence_numberazure_eventhubs_batch_converted_sequence_number.
  • Измените заголовок сообщения на azure_partition_keyazure_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 проверка point работает только в пакетном режиме, который можно включить, передав ListenerMode.BATCH в конструктор EventHubsInboundChannelAdapter.

В следующей таблице показаны сопоставления классов от azure-spring-cloud-starter-eventhubsspring-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.
• Изменение конструктора на EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String)EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) и EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Измените CheckpointConfig стиль экземпляра на простой конструктор вместо стиля сборки.
• Удалить API EventHubOperation#setCheckpointConfig. Чтобы задать конфигурацию проверка point для адаптера входящего канала, пользователи могут вызвать методEventHubsContainerProperties#setCheckpointConfig.
• Удалить API EventHubOperation#setBatchConsumerConfig. Чтобы задать конфигурацию пакетного использования для адаптера входящего канала, пользователи могут вызывать два метода EventHubsContainerProperties#getBatch#setMaxSize и EventHubsContainerProperties#getBatch#setMaxWaitTime между тем.
• Для режима использования пакетной службы измените имена заголовков сообщений, преобразованные из пакетных сообщений.
  • Измените заголовок сообщения на azure_eventhub_enqueued_timeazure_eventhubs_batch_converted_enqueued_time.
  • Измените заголовок сообщения на azure_eventhub_offsetazure_eventhubs_batch_converted_offset.
  • Измените заголовок сообщения на azure_eventhub_sequence_numberazure_eventhubs_batch_converted_sequence_number.
  • Измените заголовок сообщения на azure_partition_keyazure_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 проверка point работает только в пакетном режиме, который можно включить, передав 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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

Изменения API

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

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

В следующей таблице показаны сопоставления классов от azure-spring-integration-servicebusspring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

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

Изменения API

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

В следующей таблице показаны сопоставления классов с azure-spring-cloud-starter-storage-queuespring-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

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

В следующей таблице показаны сопоставления классов с azure-spring-integration-storage-queuespring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать spring-boot-properties-migrator во время миграции, см. в разделе "Настройка каждого пакета SDK ".
• Дополнительные сведения о глобальных и распространенных изменениях конфигурации см. в разделе "Глобальные конфигурации ".

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

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

В следующей таблице показаны сопоставления свойств от azure-spring-cloud-stream-binder-eventhubsspring-cloud-azure-stream-binder-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}
    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) с указанным субъектом безопасности, а затем извлекает строка подключения указанного пространства имен с помощью ARM. В конце концов приложение использует полученный строка подключения для подключения к Центры событий Azure. Таким образом, предоставленный субъект безопасности должен быть предоставлен ролью участника для получения связанного пространства имен Центры событий Azure.

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

Для проверки подлинности на основе 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-eventhubsspring-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 см. в разделе об изменениях проверки подлинности.
• Сведения о том, как использовать 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) с указанным субъектом безопасности, а затем извлекает строка подключения указанного пространства имен с помощью ARM. В конце концов приложение использует полученный строка подключения для подключения к Служебная шина Azure. Таким образом, предоставленный субъект безопасности должен быть предоставлен роли участника для получения связанного пространства имен Служебная шина Azure.

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

Для проверки подлинности на основе 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-eventhubsspring-cloud-azure-stream-binder-eventhubs.

azure-spring-cloud-messaging

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