Utvecklarguide för Spring Cloud Azure

Spring Cloud Azure integrerar Spring Boot-program med Azure tjänster. Den här utvecklarguiden beskriver hur du hanterar beroenden, väljer starter och använder exempel för att påskynda Java programutveckling.

Mer information om vilka versioner som stöds finns i Mappning av Spring-versioner.

Få hjälp

Om du har frågor om den här dokumentationen skapar du ett GitHub problem i någon av följande GitHub lagringsplatser. Pull-begäranden är också välkomna.

GitHub lagringsplatser	Beskrivning
Azure/azure-sdk-for-java	Den här lagringsplatsen innehåller källkoden.
Azure-Samples/azure-spring-boot-samples	Den här lagringsplatsen innehåller de relaterade exemplen.
MicrosoftDocs/azure-dev-docs	Den här lagringsplatsen innehåller dokumentationen.

Komma igång

Konfigurera beroenden

Materiallista (BOM)

Om du använder Maven lägger du till bommen i din pom.xml-fil i avsnittet dependencyManagement, som du ser i följande exempel. När du använder BOM:en behöver du inte ange versioner för några av Maven-beroendena eftersom BOM:en hanterar versionerna.

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

Med Gradle kan du importera spring-cloud-azure-dependencies bom på följande sätt:

• Använd Gradles inbyggda strukturlistestöd genom att lägga till beroenden enligt följande exempel.

  import org.springframework.boot.gradle.plugin.SpringBootPlugin
  
  plugins {
    id("java")
    id("org.springframework.boot") version "4.0.1"
  }
  
  dependencies {
      implementation(platform(SpringBootPlugin.BOM_COORDINATES))
      implementation(platform("com.azure.spring:spring-cloud-azure-dependencies:{version}"))
  }
  

• Använd plugin-programmet io.spring.dependency-management och importera bommen i dependencyManagement, som du ser i följande exempel.

  plugins {
      id("io.spring.dependency-management") version "1.1.7"
  }
  
  dependencyManagement {
      imports {
          mavenBom("com.azure.spring:spring-cloud-azure-dependencies:{version}")
      }
  }
  

Mer information finns i referensguiden för Spring Boot Gradle Plugin.

Obs!

Om du använder Spring Boot 4.0.x anger du spring-cloud-azure-dependencies versionen till 7.4.0.

Om du använder Spring Boot 3.5.x anger du spring-cloud-azure-dependencies versionen till 6.5.0.

Om du använder Spring Boot 3.1.x-3.5.x måste du ange spring-cloud-azure-dependencies versionen till 5.25.0.

Om du använder Spring Boot 2.x måste du ange spring-cloud-azure-dependencies versionen till 4.20.0.

Den här materialspecifikationen (BOM) bör konfigureras i avsnittet <dependencyManagement> i din pom.xml-fil. Detta säkerställer att alla Spring Cloud-Azure beroenden använder samma version.

Mer information om den version som används för den här BOM:en finns i Vilken version av Spring Cloud Azure ska jag använda.

Startberoenden

Spring Cloud Azure Starter är en uppsättning praktiska beroendebeskrivningar som ska ingå i ditt program. Varje starter innehåller alla beroenden och transitiva beroenden som behövs för att börja använda motsvarande Spring Cloud-Azure modul. Dessa startprogram ökar din Spring Boot-programutveckling med Azure tjänster.

Om du till exempel vill komma igång med Spring och Azure Cosmos DB för datapersistens inkluderar du beroendet spring-cloud-azure-starter-cosmos i projektet.

I följande tabell visas startprogram som tillhandahålls av Spring Cloud Azure under gruppen com.azure.spring:

Namn	Beskrivning
spring-cloud-azure-starter	Core Starter, inklusive stöd för automatisk konfiguration.
spring-cloud-azure-starter-active-directory	Startpaketet för att använda Microsoft Entra ID med Spring Security.
spring-cloud-azure-starter-active-directory-b2c	Startprogrammet för att använda Azure Active Directory B2C med Spring Security.
spring-cloud-azure-starter-appconfiguration	Introduktion till att använda Azure App Configuration.
spring-cloud-azure-starter-appconfiguration-config	Startprogrammet för att använda Azure App Configuration Config.
spring-cloud-azure-starter-cosmos	Startprogrammet för att använda Azure Cosmos DB.
spring-cloud-azure-starter-eventhubs	Startprogrammet för att använda Azure Event Hubs.
spring-cloud-azure-starter-eventgrid	Startprogrammet för att använda Azure Event Grid.
spring-cloud-azure-starter-keyvault	Introduktion till att komma igång med Azure Key Vault.
spring-cloud-azure-starter-keyvault-secrets	Introduktion till att använda Azure Key Vault Secrets.
spring-cloud-azure-starter-keyvault-jca	Startpaket för att komma igång med Azure Key Vault JCA.
spring-cloud-azure-starter-keyvault-certificates	Startprogrammet för att använda Azure Key Vault-certifikat.
spring-cloud-azure-starter-servicebus	Startprogrammet för att använda Azure Service Bus.
spring-cloud-azure-starter-servicebus-jms	Startprogrammet för att använda Azure Service Bus och JMS.
spring-cloud-azure-starter-storage	Startprogrammet för att använda Azure Storage.
spring-cloud-azure-starter-storage-blob	Startprogrammet för att använda Azure Storage Blob.
spring-cloud-azure-starter-storage-file-share	Introduktion till användning av Azure Storage-filresurs.
spring-cloud-azure-starter-storage-queue	Startpaketet för användning av Azure Storage Queue.
spring-cloud-azure-starter-actuator	Startpaketet för att använda Spring Boots Actuator, som tillhandahåller produktionsfärdiga funktioner.

I följande tabell visas startpunkter för Spring Data-stöd:

Namn	Beskrivning
spring-cloud-azure-starter-data-cosmos	Startprogrammet för att använda Spring Data för Azure Cosmos DB.

I följande tabell visas startpunkter för Stöd för Spring Data Redis:

Namn	Beskrivning
spring-cloud-azure-starter-data-redis-lettuce	Startpaket för användning av Spring Data och Azure Cache for Redis med Lettuce.

I följande tabell visas startpunkter för Spring Integration-stöd:

Namn	Beskrivning
spring-cloud-azure-starter-integration-eventhubs	Startprogrammet för att använda Azure Event Hubs och Spring Integration.
spring-cloud-azure-starter-integration-servicebus	Startprogrammet för att använda Azure Service Bus och Spring Integration.
spring-cloud-azure-starter-integration-storage-queue	Startprogrammet för att använda Azure Storage Queue och Spring Integration.

I följande tabell visas startpunkter för Spring Cloud Stream-stöd:

Namn	Beskrivning
spring-cloud-azure-starter-stream-eventhubs	Startprogrammet för att använda Azure Event Hubs och Spring Cloud Stream Binder.
spring-cloud-azure-starter-stream-servicebus	Startprogrammet för att använda Azure Service Bus och Spring Cloud Stream Binder.

I följande tabell visas startpunkter för MySQL-stöd:

Namn	Beskrivning
spring-cloud-azure-starter-jdbc-mysql	Startprogrammet för att använda Azure MySQLs och JDBC via Microsoft Entra-autentisering.

I följande tabell visas startpunkter för PostgreSQL-stöd:

Namn	Beskrivning
spring-cloud-azure-starter-jdbc-postgresql	Startprogrammet för att använda Azure PostgreSQL och JDBC via Microsoft Entra autentisering.

Lär dig Spring Cloud Azure

En fullständig lista över exempel som visar användning finns i Spring Cloud Azure Samples.

Nyheter i 4.0 sedan 3.10.x

Den här dokumentationen beskriver ändringar som gjorts i 4.0 sedan 3.10. Den här huvudversionen ger bättre säkerhet, färre beroenden, stöd för att göra systemet produktionsklart med mera.

Tips

Mer information om hur du migrerar till 4.0 finns i Migreringsguide för 4.0.

I följande lista sammanfattas några av de ändringar som Spring Cloud Azure 4.0 innehåller:

• En enhetlig utvecklingsupplevelse med enhetligt projektnamn, artefakt-ID och egenskaper.
• Förenklad beroendehantering med en enda spring-cloud-azure-dependencies BOM-fil.
• Expanderade Azure support på Spring Initializr för att täcka Kafka, Event Hubs, Azure Cache for Redis och Azure App Configuration.
• Omskapade Spring-modulberoenden för att ta bort överflödiga lager och sammanflätning.
• Stöd för hanterad identitet för Azure App Configuration, Event Hubs, Service Bus, Azure Cosmos DB, Key Vault, Storage Blob och Storage Queue.
• Fortsatt stöd för autentiseringsmetoder i underliggande Azure SDKs från våra Spring-bibliotek, till exempel SAS-token och tokenautentisering med Service Bus och Event Hubs.
• Autentiseringskedjan är nu aktiverad som standard, vilket gör det möjligt för program att hämta autentiseringsuppgifter från programegenskaper, miljövariabler, hanterad identitet, IDE:er och så vidare. Mer information finns i avsnittet DefaultAzureCredential i klientbiblioteket Azure Identity för Java.
• Detaljerad åtkomstkontroll på resursnivå (till exempel Service Bus kö) för bättre säkerhetsstyrning och efterlevnad av IT-principer.
• Fler alternativ som exponeras på ett Spring-idiomatiskt sätt genom förbättrad automatisk konfigurationstäckning av Azure SDKs klienter för både synkrona och asynkrona scenarier.
• Hälsoindikatorer har lagts till för Azure App Configuration, Event Hubs, Azure Cosmos DB, Key Vault, Storage Blob, Storage Queue och Storage File.
• Stöd för Spring Cloud Sleuth för alla HTTP-baserade Azure-SDK:er.