Przewodnik migracji dla platformy Spring Cloud Azure 4.0

Ten przewodnik ułatwia migrację do usługi Spring Cloud Azure 4.0 ze starszych bibliotek Azure Spring.

Wprowadzenie

Wywołamy biblioteki, których identyfikator grupy i identyfikator artefaktu są zgodne ze wzorcem com.azure.spring:spring-cloud-azure-*nowoczesnych bibliotek oraz bibliotek z wzorcem com.azure.spring:azure-spring-boot-*, com.azure.spring:azure-spring-cloud-*lub com.azure.spring:azure-spring-integration-*starszych bibliotek.

Ten przewodnik koncentruje się na porównaniach równoległych dla podobnych konfiguracji między nowoczesnymi i starszymi bibliotekami.

Przyjęto znajomość pakietu com.azure.spring:azure-spring-boot-*, com.azure.spring:azure-spring-cloud-* lub com.azure.spring:azure-spring-integration-*.

Jeśli dopiero zaczynasz korzystać z bibliotek platformy Spring Cloud Azure 4.0, zapoznaj się z przewodnikiem dewelopera Spring Cloud Azure a nie w tym przewodniku.

Korzyści z migracji

Naturalne pytanie, które należy zadać podczas rozważania, czy należy przyjąć nową wersję, czy bibliotekę, jest jego korzyścią. Ponieważ Azure dojrzała i została włączona przez bardziej zróżnicowaną grupę deweloperów, skupiliśmy się na uczeniu się wzorców i praktyk, aby jak najlepiej wspierać produktywność deweloperów i zrozumieć luki, które mają biblioteki Spring Cloud Azure.

Było kilka obszarów spójnych opinii wyrażonych w bibliotekach spring cloud Azure. Najważniejsze jest to, że biblioteki dla różnych usług Azure nie włączyły pełnego zestawu konfiguracji. Ponadto niespójność nazw projektów, identyfikatorów artefaktów, wersji i konfiguracji sprawiła, że krzywa nauki jest stroma.

Aby ulepszyć środowisko programistyczne w bibliotekach spring cloud Azure, wprowadzono zestaw wytycznych projektowych zapewniających, że biblioteki spring cloud Azure mają naturalny i idiotyczny charakter w odniesieniu do ekosystemu Spring. Dalsze szczegóły są dostępne w design doc dla osób zainteresowanych.

Usługa Spring Cloud Azure 4.0 udostępnia wspólne środowisko w bibliotekach integrujących się z różnymi projektami Spring, na przykład Spring Boot, Spring Integration, Spring Cloud Stream itd. Wspólne środowisko obejmuje:

• Ujednolicony model BOM obejmujący wszystkie biblioteki spring cloud Azure 4.0.
• Spójna konwencja nazewnictwa artefaktów.
• Ujednolicony sposób konfigurowania poświadczeń, serwera proxy, ponawiania prób, środowiska chmury i ustawień warstwy transportu.
• Obsługa wszystkich metod uwierzytelniania obsługiwanych przez usługę Azure Service lub zestaw SDK usługi Azure.

Przegląd

Ten przewodnik migracji składa się z następujących sekcji:

• Zmiany nazewnictwa aplikacji Spring Cloud Azure 4.0
• Zmiany artefaktów: zmieniono nazwę/dodano/usunięto
• Zmiany zależności
• Zmiany uwierzytelniania
• Właściwości konfiguracji
• Zmiany powodujące niezgodność interfejsu API
• Zmiany w bibliotece

Zmiany nazewnictwa

Nigdy nie było spójnej ani oficjalnej nazwy, aby wywołać wszystkie biblioteki spring cloud Azure. Niektóre z nich zostały nazwane Azure Spring Boot, a niektóre z nich Spring on Azure. Od wersji 4.0 zaczęliśmy używać nazwy projektu Spring Cloud Azure do reprezentowania wszystkich bibliotek Azure Spring.

lista BOM

Kiedyś dostarczaliśmy dwa elementy BOM dla naszych bibliotek, azure-spring-boot-bom i azure-spring-cloud-dependencies, ale połączyliśmy te dwa elementy BOM w jeden BOM od wersji 4.0, spring-cloud-azure-dependencies. Dodaj wpis w sekcji dependencyManagement projektu, aby skorzystać z zarządzania zależnościami.

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

Zmiany artefaktów: zmieniono nazwę/dodano/usunięto

Identyfikatory grup są takie same w przypadku nowoczesnych i starszych bibliotek platformy Spring Cloud Azure. Wszystkie są com.azure.spring. Identyfikatory artefaktów dla nowoczesnych bibliotek platformy Spring Cloud Azure uległy zmianie. Zgodnie z tym, do którego projektu spring należy, Spring Boot, Spring Integration lub Spring Cloud Stream, wzorzec identyfikatorów artefaktów może być spring-cloud-azure-starter-[service], spring-integration-azure-[service]lub spring-cloud-azure-stream-binder-[service]. Starsze szablony startowe dla każdego z nich mają identyfikator artefaktu zgodnie ze wzorcem azure-spring-*. Zapewnia to szybki i dostępny środek ułatwiający zrozumienie, niezależnie od tego, czy używasz nowoczesnych, czy starszych startów.

W procesie tworzenia platformy Spring Cloud Azure 4.0 zmieniliśmy nazwę niektórych artefaktów, aby były zgodne z nowymi konwencjami nazewnictwa, usunięto niektóre artefakty, aby funkcjonalność mogła zostać umieszczona w bardziej odpowiednim artefaktzie i dodaliśmy nowe artefakty, aby lepiej obsługiwać niektóre scenariusze.

W poniższej tabeli przedstawiono mapowania między starszym identyfikatorem artefaktu a nowoczesnym identyfikatorem artefaktu:

Zmiany zależności

Niektóre niepotrzebne zależności zostały uwzględnione w starszych artefaktach, które zostały usunięte w nowoczesnych bibliotekach Spring Cloud Azure 4.0. Pamiętaj, aby ręcznie dodać usunięte zależności do projektu, aby zapobiec awariom.

Biblioteki, które mają zmiany zależności, obejmują:

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

Zmiany uwierzytelniania

Platforma Spring Cloud Azure 4.0 obsługuje wszystkie metody uwierzytelniania obsługiwane przez każdy zestaw SDK usługi Azure. Umożliwia skonfigurowanie poświadczeń tokenu globalnego, a także podanie poświadczeń tokenu na każdym poziomie usługi. Jednak poświadczenie nie jest wymagane do skonfigurowania usługi Spring Cloud Azure 4.0, ponieważ może stosować poświadczenia przechowywane w lokalnym środowisku deweloperów lub tożsamości zarządzanej w usługach Azure. Upewnij się, że podmiot zabezpieczeń otrzymał wystarczające uprawnienia dostępu do zasobów docelowych Azure.

Poświadczenie łańcuchowe, fasola DefaultAzureCredential jest domyślnie konfigurowana automatycznie i będzie używana przez wszystkie składniki, jeśli nie określono więcej informacji o uwierzytelnianiu. Aby uzyskać więcej informacji, zobacz sekcję DefaultAzureCredential w Azure Identity client library for Java.

Właściwości konfiguracji

Migracja właściwości

Utworzyliśmy plik w additional-spring-configuration-metadata.json celu złagodzenia migracji właściwości podczas korzystania z spring-boot-properties-migratorprogramu . Najpierw dodaj następującą właściwość migracji do aplikacji:

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

Lub, jeśli używasz narzędzia Gradle:

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

Jeśli uruchomisz aplikację, zidentyfikuje właściwości, które nie są już zarządzane przez usługę Spring Cloud Azure. Jeśli istnieje zamiana, tymczasowo ponownie zamapuje właściwość za pomocą ostrzeżenia. Jeśli nie ma zamiany, raport o błędach zawiera więcej informacji. Tak czy inaczej, konfiguracja musi zostać zaktualizowana i zależność usunięta po zaktualizowaniu konfiguracji.

Zanim przejdziesz dalej, warto użyć funkcji wyszukiwania środowiska IDE, aby sprawdzić, czy nie używasz jednej z właściwości, które zostały zmigrowane w teście integracji.

Konfiguracje globalne

Nowoczesny spring-cloud-azure-starter umożliwia zdefiniowanie właściwości, które mają zastosowanie do wszystkich Azure SDKs w przestrzeni nazw spring.cloud.azure. Ta funkcja nie była obsługiwana w starszych azure-spring-boot-starter. Konfiguracje globalne można podzielić na pięć kategorii pokazanych w poniższej tabeli:

Aby uzyskać pełną listę konfiguracji, zobacz Spring Cloud Azure właściwości konfiguracji.

Konfigurowanie każdego zestawu SDK

Aby uzyskać szczegółowe informacje o opcjach konfiguracji na poziomie zestawu SDK, skorzystaj z następujących linków:

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

Zmiany powodujące niezgodność interfejsu API

Aby uzyskać szczegółowe informacje na temat zmian powodujących niezgodność interfejsu API w każdej bibliotece, skorzystaj z następujących linków:

• Od azure-spring-boot-starter-active-directory do spring-cloud-azure-starter-active-directory
• Od azure-spring-boot-starter-active-directory-b2c do spring-cloud-azure-starter-active-directory-b2c
• Od azure-spring-boot-starter-storage do spring-cloud-azure-starter-storage-blob
• Od azure-spring-boot-starter-storage do spring-cloud-azure-starter-storage-file-share
• Od azure-spring-cloud-starter-eventhubs do spring-cloud-azure-starter-integration-eventhubs
• Od azure-spring-integration-eventhubs do spring-integration-azure-eventhubs
• Od azure-spring-cloud-starter-servicebus do spring-cloud-azure-starter-integration-servicebus
• Od azure-spring-integration-servicebus do spring-integration-azure-servicebus
• Od azure-spring-cloud-starter-storage-queue do spring-cloud-azure-starter-integration-storage-queue
• Od azure-spring-integration-storage-queue do spring-integration-azure-storage-queue
• Od azure-spring-cloud-stream-binder-eventhubs do spring-cloud-azure-stream-binder-eventhubs
• Od azure-spring-cloud-stream-binder-servicebus-* do spring-cloud-azure-stream-binder-servicebus

Zmiany w bibliotece

Zmiany powodujące niezgodność w każdej bibliotece są wprowadzane w następujący sposób.

Z azure-spring-boot-starter do spring-cloud-azure-starter

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter wersji 3 programu azure-spring-boot-starter.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany zależności

Niektóre niepotrzebne zależności zostały uwzględnione w starszych artefaktach, które zostały usunięte w nowoczesnych bibliotekach Spring Cloud Azure 4.0. Pamiętaj, aby ręcznie dodać usunięte zależności do projektu, aby zapobiec przypadkowej awarii.

W poniższej tabeli przedstawiono usunięte zależności:

Z azure-spring-boot-starter-active-directory do spring-cloud-azure-starter-active-directory

Ten przewodnik ma na celu pomoc w migracji z spring-cloud-azure-starter-active-directory wersji 3 programu azure-spring-boot-starter-active-directory.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany zależności

Niektóre niepotrzebne zależności w starszej wersji artefaktu zostały usunięte od czasu nowoczesnej biblioteki Spring Cloud Azure 4.0. Dodaj te usunięte zależności do projektu, aby zapobiec przypadkowemu awarii.

W poniższej tabeli przedstawiono usunięte zależności:

Zmiany konfiguracji zestawu SDK

Ta sekcja zawiera zmiany dotyczące dodanych, usuniętych i zmienionych właściwości.

• Poniżej przedstawiono dwa główne kwestie, które należy zwrócić uwagę na:

1. Prefiks wszystkich nazw właściwości konfiguracji został zmieniony z azure.activedirectory na spring.cloud.azure.active-directory.
2. Dodano nową właściwość spring.cloud.azure.active-directory.enabled w celu włączenia/wyłączenia Microsoft Entra powiązanych funkcji. Domyślna wartość to false.

W poniższej tabeli przedstawiono mapowania właściwości między azure-spring-boot-starter-active-directory a spring-cloud-azure-starter-active-directory:

• Typ wartości następujących właściwości jest zmieniany z long na Duration:

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

• Następujące właściwości są usuwane:

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

• Dodawane są następujące właściwości:

  • 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

Oto kilka przykładów migracji:

• Przykład 1. Przypadek 1

  • W przypadku starszej wersji: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/memberOf

  • Dla nowoczesnych: 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

• Przykład 2. Przypadek 2

  • W przypadku starszej wersji: azure.activedirectory.graph-membership-uri=https://graph.microsoft.com/v1.0/me/transitiveMemberOf

  • Dla nowoczesnych: 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

Zmiany interfejsu API

W poniższej tabeli przedstawiono mapowania klas z azure-spring-boot-starter-active-directory na spring-cloud-azure-starter-active-directory:

W tej sekcji wymieniono usunięte klasy z azure-spring-boot-starter-active-directoryklasy .

• Usunięto starszą klasę

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

Z azure-spring-boot-starter-active-directory-b2c do spring-cloud-azure-starter-active-directory-b2c

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter-active-directory-b2c wersji 3 programu azure-spring-boot-starter-active-directory-b2c.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany zależności

Niektóre niepotrzebne zależności zostały uwzględnione w starszych artefaktach, które zostały usunięte w nowoczesnych bibliotekach Spring Cloud Azure 4.0. Pamiętaj, aby ręcznie dodać usunięte zależności do projektu, aby zapobiec przypadkowej awarii.

W poniższej tabeli przedstawiono usunięte zależności:

Zmiany konfiguracji zestawu SDK

Ta sekcja zawiera zmiany dotyczące dodanych, usuniętych i zmienionych właściwości.

• Poniżej przedstawiono dwa główne kwestie, które należy zwrócić uwagę na:

1. Wszystkie nazwy właściwości konfiguracji zmieniły prefiks z azure.activedirectory.b2c na spring.cloud.azure.active-directory.b2c.
2. Dodano nową właściwość spring.cloud.azure.active-directory.b2c.enabled w celu zezwalania na włączanie/wyłączanie funkcji powiązanych z usługą AD B2C Azure. Wartość domyślna to false.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-boot-starter-active-directory-b2c na spring-cloud-azure-starter-active-directory-b2c:

• Usunięto właściwości z :azure-spring-boot-starter-active-directory-b2c

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

• Typ wartości następujących właściwości jest zmieniany z long na Duration:

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

Zmiany interfejsu API

W poniższej tabeli przedstawiono mapowania klas z azure-spring-boot-starter-active-directory-b2c na spring-cloud-azure-starter-active-directory-b2c:

Z azure-spring-boot-starter-cosmos do spring-cloud-azure-starter-data-cosmos

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter-data-cosmos wersji 3 programu azure-spring-boot-starter-cosmos.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Wszystkie nazwy właściwości konfiguracji zmieniły prefiks z azure.cosmos na spring.cloud.azure.cosmos.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-boot-starter-cosmos na spring-cloud-azure-starter-data-cosmos:

Z azure-spring-boot-starter-keyvault-secrets do spring-cloud-azure-starter-keyvault-secrets

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter-keyvault-secrets wersji 3 programu azure-spring-boot-starter-keyvault-secrets.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Ta sekcja zawiera zmiany dotyczące dodanych, usuniętych i zmienionych właściwości.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-boot-starter-keyvault-secrets na spring-cloud-azure-starter-keyvault-secrets:

• Usunięto właściwości z :spring-cloud-azure-starter-keyvault-secrets

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

Należy zwrócić uwagę na następujące kwestie:

1. Wszystkie nazwy właściwości konfiguracji zmieniły prefiks z azure.keyvault na spring.cloud.azure.keyvault.secret.
2. spring.cloud.azure.keyvault.secret.enabled służy do włączania wszystkich funkcji wpisu tajnego Key Vault, dołączania Key Vault tajnych fasoli klienta (takich jak SecretClient i SecretAsyncClient) i dodaj KeyVaultPropertySource w ConfigurableEnvironment.
3. spring.cloud.azure.keyvault.secret.property-source-enabled służy do włączania wszystkich KeyVaultPropertySource. Zacznie obowiązywać tylko wtedy, gdy spring.cloud.azure.keyvault.secret.enabled=true.
4. W przypadku Azure typowych właściwości (takich jak client, proxy, retry, credential, profile) i właściwości Key Vault (takich jak endpoint, service-version). Jeśli spring.cloud.azure.keyvault.secret.property-sources[n].PROPERTY_NAME nie jest skonfigurowana, spring.cloud.azure.keyvault.secret.PROPERTY_NAME zostanie użyta.
5. spring.cloud.azure.keyvault.secret.property-sources[n].resource jest specyficzny dla unikatowego zasobu Azure, więc jeśli nie jest skonfigurowany, nie otrzyma wartości z innych miejsc.

Z azure-spring-boot-starter-servicebus-jms do spring-cloud-azure-starter-servicebus-jms

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter-servicebus-jms wersji 3 programu azure-spring-boot-starter-servicebus-jms.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Typ konfiguracji zmieniony spring.jms.servicebus.idle-timeout z long (milisekund) na Duration wzorzec umożliwiający czytelność.

Z azure-spring-boot-starter-storage do spring-cloud-azure-starter-storage-blob

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter-storage-blob wersji 3 programu azure-spring-boot-starter-storage.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Wszystkie nazwy właściwości konfiguracji zmieniły prefiks z azure.storage na spring.cloud.azure.storage.blob.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-boot-starter-storage na spring-cloud-azure-starter-storage-blob:

Zmiany interfejsu API

W poniższej tabeli przedstawiono mapowania klas z azure-spring-boot-starter-storage na spring-cloud-azure-starter-storage-blob:

Z azure-spring-boot-starter-storage do spring-cloud-azure-starter-storage-file-share

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-starter-storage-file-share wersji 3 programu azure-spring-boot-starter-storage.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Wszystkie nazwy właściwości konfiguracji zmieniły prefiks z azure.storage na spring.cloud.azure.storage.fileshare.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-boot-starter-storage na spring-cloud-azure-starter-storage-file-share:

Zmiany interfejsu API

W poniższej tabeli przedstawiono mapowania klas z azure-spring-boot-starter-storage na spring-cloud-azure-starter-storage-file-share:

Z azure-spring-cloud-starter-eventhubs do spring-cloud-azure-starter-integration-eventhubs

Ten przewodnik ma na celu pomoc w migracji z spring-cloud-azure-starter-integration-eventhubs wersji 2 programu azure-spring-cloud-starter-eventhubs.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Aby uzyskać zmiany w wpisów podrzędnych dla tego prefiksu, zobacz następujące tabele:

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-cloud-starter-eventhubs na spring-cloud-azure-starter-integration-eventhubs:

Na przykład zmień wartość z:

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}

do:

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}

Zmiany interfejsu API

• Aby uzyskać informacje o zmianach w adnotacjach odbiornika, zobacz przewodnik migracji biblioteki <<migration-azure-spring-cloud-messaging, azure-spring-cloud-messaging>>.
• Upuść EventHubOperation z funkcją subskrybowania przeniesioną do klasy EventHubsMessageListenerContainer, a funkcja wysyłająca została przeniesiona do EventHubsTemplate.
• Zmień nazwę EventHubInboundChannelAdapter na EventHubsInboundChannelAdapter, aby zachować spójność z usługą Azure Event Hubs.
• Zmień konstruktor z EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) na EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) i EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Zmień styl tworzenia wystąpienia CheckpointConfig na prosty konstruktor zamiast stylu kompilacji.
• Usuwanie EventHubOperation#setCheckpointConfiginterfejsu API. Aby ustawić konfigurację punktu kontrolnego dla karty kanału przychodzącego, użytkownicy mogą wywołać metodę EventHubsContainerProperties#setCheckpointConfig.
• Usuwanie EventHubOperation#setBatchConsumerConfiginterfejsu API. Aby ustawić konfigurację zużywaną wsadowo dla karty kanału przychodzącego, użytkownicy mogą w międzyczasie wywoływać dwie metody EventHubsContainerProperties#getBatch#setMaxSize i EventHubsContainerProperties#getBatch#setMaxWaitTime.
• W przypadku trybu przetwarzania wsadowego zmień nazwy nagłówków komunikatów przekonwertowane z komunikatów wsadowych.
  • Zmień nagłówek wiadomości z azure_eventhub_enqueued_time na azure_eventhubs_batch_converted_enqueued_time.
  • Zmień nagłówek wiadomości z azure_eventhub_offset na azure_eventhubs_batch_converted_offset.
  • Zmień nagłówek wiadomości z azure_eventhub_sequence_number na azure_eventhubs_batch_converted_sequence_number.
  • Zmień nagłówek wiadomości z azure_partition_key na azure_batch_converted_partition_key.
• Podczas publikowania komunikatów w usłudze Event Hubs zignoruj wszystkie nagłówki komunikatów przekonwertowane z komunikatów wsadowych. Nagłówki obejmują:
  • 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
• Tryb punktu kontrolnego BATCH działa teraz tylko w trybie przetwarzania wsadowego, który można włączyć, przekazując ListenerMode.BATCH do konstruktora EventHubsInboundChannelAdapter.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-cloud-starter-eventhubs na spring-cloud-azure-starter-integration-eventhubs:

Przykładowy fragment kodu

• EventHubsInboundChannelAdapter przykładowy kod:

  Starszy kod:

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

  Nowoczesny kod:

  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 przykładowy kod:

  Starszy kod:

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

  Nowoczesny kod:

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

Z azure-spring-integration-eventhubs do spring-integration-azure-eventhubs

Ten przewodnik ma na celu pomoc w migracji z spring-integration-azure-eventhubs wersji 2 programu azure-spring-integration-eventhubs.

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.

Zmiany interfejsu API

• Upuść EventHubOperation z funkcją subskrybowania przeniesioną do klasy EventHubsMessageListenerContainer, a funkcja wysyłająca została przeniesiona do EventHubsTemplate.
• Zmień nazwę EventHubInboundChannelAdapter na EventHubsInboundChannelAdapter, aby zachować spójność z usługą Azure Event Hubs.
• Zmień konstruktor z EventHubInboundChannelAdapter(String, SubscribeByGroupOperation, String) na EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer) i EventHubsInboundChannelAdapter(EventHubsMessageListenerContainer, ListenerMode).
• Zmień styl tworzenia wystąpienia CheckpointConfig na prosty konstruktor zamiast stylu kompilacji.
• Usuwanie EventHubOperation#setCheckpointConfiginterfejsu API. Aby ustawić konfigurację punktu kontrolnego dla karty kanału przychodzącego, użytkownicy mogą wywołać metodę EventHubsContainerProperties#setCheckpointConfig.
• Usuwanie EventHubOperation#setBatchConsumerConfiginterfejsu API. Aby ustawić konfigurację zużywaną wsadowo dla karty kanału przychodzącego, użytkownicy mogą w międzyczasie wywoływać dwie metody EventHubsContainerProperties#getBatch#setMaxSize i EventHubsContainerProperties#getBatch#setMaxWaitTime.
• W przypadku trybu przetwarzania wsadowego zmień nazwy nagłówków komunikatów przekonwertowane z komunikatów wsadowych.
  • Zmień nagłówek wiadomości z azure_eventhub_enqueued_time na azure_eventhubs_batch_converted_enqueued_time.
  • Zmień nagłówek wiadomości z azure_eventhub_offset na azure_eventhubs_batch_converted_offset.
  • Zmień nagłówek wiadomości z azure_eventhub_sequence_number na azure_eventhubs_batch_converted_sequence_number.
  • Zmień nagłówek wiadomości z azure_partition_key na azure_batch_converted_partition_key.
• Podczas publikowania komunikatów w usłudze Event Hubs zignoruj wszystkie nagłówki komunikatów przekonwertowane z komunikatów wsadowych. Nagłówki obejmują:
  • 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
• Tryb punktu kontrolnego BATCH działa teraz tylko w trybie przetwarzania wsadowego, który można włączyć, przekazując ListenerMode.BATCH do konstruktora EventHubsInboundChannelAdapter.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-integration-eventhubs na spring-integration-azure-eventhubs:

Z azure-spring-cloud-starter-servicebus do spring-cloud-azure-starter-integration-servicebus

Ten przewodnik ma na celu pomoc w migracji z spring-cloud-azure-starter-integration-servicebus wersji 2 programu azure-spring-cloud-starter-servicebus.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

W przypadku wszystkich opcji konfiguracji obsługiwanych w spring-cloud-azure-starter-integration-servicebusprefiks pozostaje spring.cloud.azure.servicebus.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-cloud-starter-servicebus na spring-cloud-azure-starter-integration-servicebus:

Zmiany interfejsu API

• Upuść ServiceBusQueueOperation i ServiceBusTopicOperation z funkcją subskrybowania przeniesioną do klasy ServiceBusMessageListenerContainer, a funkcja wysyłająca została przeniesiona do ServiceBusTemplate.
• Upuść ServiceBusQueueInboundChannelAdapter i ServiceBusTopicInboundChannelAdapter i przenieś funkcje, aby nasłuchiwać jednostki kolejki/tematu Service Bus do usługi ServiceBusInboundChannelAdapter.
• Zmień konstruktor z ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) na ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) i ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Zmień konstruktor z ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) na ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) i ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Upuść interfejsy API ServiceBusQueueOperation#setCheckpointConfig i ServiceBusTopicOperation#setCheckpointConfig. Aby ustawić konfigurację punktu kontrolnego dla karty kanału przychodzącego, użytkownicy mogą wywołać metodę ServiceBusContainerProperties#setAutoComplete. Aby wyłączyć tryb automatycznego uzupełniania jest odpowiednikiem trybu MANUAL punktu kontrolnego i włączenia go spowoduje wyzwolenie trybu RECORD.
• Upuść interfejsy API ServiceBusQueueOperatio#setClientConfig i ServiceBusTopicOperation#setClientConfig. Aby skonfigurować podstawową ServiceBusProcessorClient używaną przez adapter kanału przychodzącego, użytkownicy mogą zamiast tego używać ServiceBusContainerProperties.
• Porzucanie obsługi CompletableFuture w usługach ServiceBusTemplate i DefaultMessageHandlerobsługuje Reactor.
• Dodaj nowy interfejs API ServiceBusTemplate#setDefaultEntityType, aby określić typ jednostki, który jest wymagany, gdy dla PropertiesSupplier<String, ProducerProperties>nie podano fasoli ProducerProperties#entityType .
• Upuść nagłówek wiadomości AzureHeaders.RAW_ID. Użyj ServiceBusMessageHeaders.MESSAGE_ID zamiast tego.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-cloud-starter-servicebus na spring-cloud-azure-starter-integration-servicebus:

Przykładowy fragment kodu

• ServiceBusInboundChannelAdapter przykładowy kod:

  Starszy kod używania ServiceBusQueueInboundChannelAdapter lub 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;
      }
  
  }
  

  Nowoczesny kod:

  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 przykładowy kod:

  Starszy kod, przyjmując kolejkę jako przykład:

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

  Nowoczesny kod:

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

Z azure-spring-integration-servicebus do spring-integration-azure-servicebus

Ten przewodnik ma na celu pomoc w migracji z spring-integration-azure-servicebus wersji 2 programu azure-spring-integration-servicebus.

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.

Zmiany interfejsu API

• Upuść ServiceBusQueueOperation i ServiceBusTopicOperation z funkcją subskrybowania przeniesioną do klasy ServiceBusMessageListenerContainer, a funkcja wysyłająca została przeniesiona do ServiceBusTemplate.
• Upuść ServiceBusQueueInboundChannelAdapter i ServiceBusTopicInboundChannelAdapter i przenieś funkcje, aby nasłuchiwać jednostki kolejki/tematu Service Bus do usługi ServiceBusInboundChannelAdapter.
• Zmień konstruktor z ServiceBusQueueInboundChannelAdapter(String, SubscribeByGroupOperation, String) na ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) i ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Zmień konstruktor z ServiceBusTopicInboundChannelAdapter(String, SubscribeByGroupOperation, String) na ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer) i ServiceBusInboundChannelAdapter(ServiceBusMessageListenerContainer, ListenerMode).
• Upuść interfejsy API ServiceBusQueueOperation#setCheckpointConfig i ServiceBusTopicOperation#setCheckpointConfig. Aby ustawić konfigurację punktu kontrolnego dla karty kanału przychodzącego, użytkownicy mogą wywołać metodę ServiceBusContainerProperties#setAutoComplete. Aby wyłączyć tryb automatycznego uzupełniania jest odpowiednikiem trybu MANUAL punktu kontrolnego i włączenia go spowoduje wyzwolenie trybu RECORD.
• Upuść interfejsy API ServiceBusQueueOperation#setClientConfig i ServiceBusTopicOperation#setClientConfig. Aby skonfigurować podstawową ServiceBusProcessorClient używaną przez adapter kanału przychodzącego, użytkownicy mogą zamiast tego używać ServiceBusContainerProperties.
• Porzucanie obsługi CompletableFuture w usługach ServiceBusTemplate i DefaultMessageHandlerobsługuje Reactor.
• Dodaj nowy interfejs API ServiceBusTemplate#setDefaultEntityType, aby określić typ jednostki, który jest wymagany, gdy dla PropertiesSupplier<String, ProducerProperties>nie podano fasoli ProducerProperties#entityType .
• Upuść nagłówek wiadomości AzureHeaders.RAW_ID. Użyj ServiceBusMessageHeaders.MESSAGE_ID zamiast tego.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-integration-servicebus na spring-integration-azure-servicebus:

Z azure-spring-cloud-starter-storage-queue do spring-cloud-azure-starter-integration-storage-queue

Ten przewodnik ma na celu pomoc w migracji z spring-cloud-azure-starter-integration-storage-queue wersji 2 programu azure-spring-cloud-starter-storage-queue.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Wszystkie nazwy właściwości konfiguracji zmieniły prefiks z spring.cloud.azure.storage na spring.cloud.azure.storage.queue.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-cloud-starter-storage-queue na spring-cloud-azure-starter-integration-storage-queue:

Zmiany interfejsu API

• Upuść StorageQueueOperation i podaj StorageQueueTemplate.
• Porzucanie konfiguracji checkpoint-mode w programie StorageQueueTemplateobsługuje tylko tryb MANUAL.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-cloud-starter-storage-queue na spring-cloud-azure-starter-integration-storage-queue.

Z azure-spring-integration-storage-queue do spring-integration-azure-storage-queue

Ten przewodnik ma na celu pomoc w migracji z spring-integration-azure-storage-queue wersji 2 programu azure-spring-integration-storage-queue.

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.

Zmiany interfejsu API

• Upuść StorageQueueOperation i podaj StorageQueueTemplate.
• Porzucanie konfiguracji checkpoint-mode w programie StorageQueueTemplateobsługuje tylko tryb MANUAL.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-integration-storage-queue na spring-integration-azure-storage-queue.

Z azure-spring-cloud-stream-binder-eventhubs do spring-cloud-azure-stream-binder-eventhubs

Ten przewodnik ma na celu pomoc w migracji z spring-cloud-azure-stream-binder-eventhubs wersji 2 programu azure-spring-cloud-stream-binder-eventhubs.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

Aby uzyskać zmiany w wpisów podrzędnych dla następującego prefiksu, zobacz poniższą tabelę.

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-cloud-stream-binder-eventhubs na spring-cloud-azure-stream-binder-eventhubs:

Przykłady migracji konfiguracji

Aby użyć connection string do uwierzytelniania i zmigrować wymienione powyżej właściwości, zmiany konfiguracji są wymienione poniżej:

Starsza konfiguracja:

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

Nowoczesna konfiguracja:

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

Jeśli używasz podmiotów zabezpieczeń zamiast parametrów połączenia, w wersjach wcześniejszych niż 4.0 aplikacja najpierw połączy się z Azure Resource Manager (ARM) z podanym podmiotem zabezpieczeń, a następnie pobierze connection string określonej przestrzeni nazw z usługą ARM. Na końcu aplikacja używa pobranego connection string, aby nawiązać połączenie z Azure Event Hubs. W ten sposób należy udzielić podanego podmiotu zabezpieczeń z Contributor do pobrania skojarzonej przestrzeni nazw Azure Event Hubs.

W przypadku Azure Spring Apps 4.0 udostępniamy dwa sposoby wykorzystania podmiotów zabezpieczeń do uwierzytelniania. Nadal używa się podmiotów zabezpieczeń do nawiązywania połączenia z usługą ARM i pobierania parametrów połączenia, w których rola Contributor jest wymagana dla podmiotów zabezpieczeń. Inne wykorzystują podmioty zabezpieczeń do uwierzytelniania w Microsoft Entra ID, a następnie łączą się bezpośrednio z Azure Event Hubs. W takim przypadku rola Contributor nie jest już konieczna, podczas gdy inne Data powiązane role są wymagane w przypadku operacji obsługi komunikatów. Aby upewnić się, że podmiot zabezpieczeń otrzymał wystarczające uprawnienia dostępu do zasobu Azure, zobacz Authorize access with Microsoft Entra ID (Dostęp Microsoft Entra ID

W przypadku uwierzytelniania opartego na usłudze ARM na przykład migracja konfiguracji jest wymieniona poniżej, w której przypisana rola nie powinna ulec zmianie:

Starsza konfiguracja:

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}

Wymagana jest nowoczesna konfiguracja, właściwości identyfikatora subskrypcji Azure i grupy zasobów:

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}

Możesz również przeprowadzić migrację do uwierzytelniania i autoryzacji za pomocą Microsoft Entra ID bezpośrednio bez wprowadzania objazdu do usługi ARM. Upewnij się, że podmiot zabezpieczeń musi mieć niezbędne role Data dla operacji obsługi komunikatów. Poniżej przedstawiono przykłady konfiguracji jednostki usługi i tożsamości zarządzanej:

• Z jednostką usługi

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

• Przy użyciu tożsamości zarządzanej

  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}
  

Zmiany interfejsu API

W poniższej tabeli przedstawiono mapowania klas z azure-spring-cloud-stream-binder-eventhubs na spring-cloud-azure-stream-binder-eventhubs.

Z azure-spring-cloud-stream-binder-servicebus-* do spring-cloud-azure-stream-binder-servicebus

Ten przewodnik ma pomóc w migracji do spring-cloud-azure-stream-binder-servicebus wersji 2 programu azure-spring-cloud-stream-binder-servicebus-queue lub azure-spring-cloud-stream-binder-servicebus-topic.

Aby uzyskać ogólne informacje, użyj następujących linków:

• Aby zapoznać się z omówieniem zmian w wersji 4.0, zobacz sekcje Introduction and Migration benefits (Korzyści z migracji w wersji 4.0).
• Aby dowiedzieć się więcej o zmianach strategii w nazewnictwie projektu, zobacz sekcję Zmiany nazewnictwa.
• Aby dowiedzieć się, jak używać jednego modelu BOM dla wszystkich bibliotek usługi Spring Cloud Azure, zobacz sekcję BOM.
• Aby dowiedzieć się, jak obsługiwać uwierzytelnianie w usłudze Spring Cloud Azure 4.0, zobacz sekcję Authentication.
• Aby dowiedzieć się, jak korzystać z podczas migracji, zobacz sekcję Configure each SDK (Konfigurowanie poszczególnych zestawów SDK).
• Aby dowiedzieć się więcej na temat globalnych i typowych zmian konfiguracji, zobacz sekcję Globalne konfiguracje.

Zmiany konfiguracji zestawu SDK

W poniższej tabeli wymieniono nowe właściwości konfiguracji spring-cloud-azure-stream-binder-servicebus:

W poniższej tabeli przedstawiono mapowania właściwości z azure-spring-cloud-stream-binder-servicebus-* na spring-cloud-azure-stream-binder-servicebus:

Przykłady migracji konfiguracji

Starsza konfiguracja, używając kolejki jako przykładu:

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

Nowoczesna konfiguracja:

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

Jeśli używasz podmiotów zabezpieczeń zamiast parametrów połączenia, w wersjach wcześniejszych niż 4.0 aplikacja najpierw połączy się z Azure Resource Manager (ARM) z podanym podmiotem zabezpieczeń, a następnie pobierze connection string określonej przestrzeni nazw z usługą ARM. W końcu aplikacja używa pobranego connection string do nawiązania połączenia z Azure Service Bus. W ten sposób należy przyznać podanemu podmiotowi zabezpieczeń rolę Contributor w celu pobrania skojarzonej przestrzeni nazw Azure Service Bus.

W przypadku Azure Spring Apps 4.0 udostępniamy dwa sposoby wykorzystania podmiotów zabezpieczeń do uwierzytelniania. Nadal używa się podmiotów zabezpieczeń do nawiązywania połączenia z usługą ARM i pobierania parametrów połączenia, w których rola Contributor jest wymagana dla podmiotów zabezpieczeń. Inne wykorzystują podmioty zabezpieczeń do uwierzytelniania w Microsoft Entra ID, a następnie łączą się bezpośrednio z Azure Service Bus. W takim przypadku rola Contributor nie jest już konieczna, podczas gdy inne Data powiązane role są wymagane w przypadku operacji obsługi komunikatów. Aby upewnić się, że podmiot zabezpieczeń otrzymał wystarczające uprawnienia dostępu do zasobu Azure, zobacz Authorize access with Microsoft Entra ID (Dostęp Microsoft Entra ID

W przypadku uwierzytelniania opartego na usłudze ARM na przykład migracja konfiguracji jest wymieniona poniżej, w której przypisana rola nie powinna ulec zmianie:

Starsza konfiguracja:

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}

Wymagana jest nowoczesna konfiguracja, właściwości identyfikatora subskrypcji Azure i grupy zasobów:

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}

Możesz również przeprowadzić migrację do uwierzytelniania i autoryzacji za pomocą Microsoft Entra ID bezpośrednio bez wprowadzania objazdu do usługi ARM. Upewnij się, że podmiot zabezpieczeń musi mieć niezbędne role Data dla operacji obsługi komunikatów. Poniżej przedstawiono przykłady konfiguracji jednostki usługi i tożsamości zarządzanej:

• Z jednostką usługi

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

• Przy użyciu tożsamości zarządzanej

  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}
  

Zmiany interfejsu API

• Upuść nagłówek wiadomości AzureHeaders.RAW_ID. Użyj ServiceBusMessageHeaders.MESSAGE_ID zamiast tego.

W poniższej tabeli przedstawiono mapowania klas z azure-spring-cloud-stream-binder-eventhubs na spring-cloud-azure-stream-binder-eventhubs.

azure-spring-cloud-messaging

Biblioteka com.azure.spring:azure-spring-cloud-messaging nie jest gotowa dla wersji 4.0. Funkcja adnotacji odbiornika jest w trakcie ponownego projektowania, dlatego adnotacje @AzureMessageListener, @AzureMessageListenersi @EnableAzureMessaging nie są obecnie obsługiwane.