Qu’est-ce que Spring Cloud Azure ?

Article
08/28/2024

Spring Cloud Azure est un projet code source ouvert qui facilite l’utilisation des services Azure dans les applications Spring.

Spring Cloud Azure est un projet code source ouvert, avec toutes les ressources disponibles pour le public. La liste suivante fournit des liens vers ces ressources :

Code source : Azure/azure-sdk-for-java.
Exemples : Azure-Samples/azure-spring-boot-samples.
Documentation : Spring Cloud Azure.

Qu’est-ce qu’Azure Spring Cloud utilisé pour ?

Spring Cloud Azure peut faciliter l’accomplissement des tâches suivantes dans les applications Spring :

Gestion des propriétés de configuration avec Azure App Configuration.
Envoi et réception de messages avec Azure Event Hubs, Azure Service Bus et file d’attente Stockage Azure.
Gestion des secrets et des certificats avec Azure Key Vault.
Prise en charge de la connexion utilisateur avec des comptes professionnels ou scolaires approvisionnés avec l’ID Microsoft Entra.
Prise en charge de la connexion utilisateur avec des comptes sociaux comme Facebook et Google avec Azure Active Directory B2C.
Protection de vos API web et accès aux API protégées comme Microsoft Graph pour travailler avec les données de vos utilisateurs et de votre organisation avec l’ID Microsoft Entra et Azure Active Directory B2C.
Stockage de données structurées avec Azure Cosmos DB.
Stockage de données non structurées telles que du texte ou des données binaires avec Stockage Blob Azure.
Stockage de fichiers avec Azure Files.

Avantages de l’utilisation de Spring Cloud Azure

La section suivante présente les avantages de l’utilisation de Spring Cloud Azure. Dans cette section, la récupération des secrets stockés dans Azure Key Vault est utilisée comme exemple. Cette section compare les différences entre le développement d’une application Spring Boot et sans Spring Cloud Azure.

Sans Spring Cloud Azure

Sans Spring Cloud Azure, si vous souhaitez récupérer des secrets stockés dans Azure Key Vault, vous devez effectuer les étapes suivantes :

Ajoutez les dépendances suivantes à votre fichier pom.xml :

<dependency>
   <groupId>com.azure</groupId>
   <artifactId>azure-security-keyvault-secrets</artifactId>
   <version>4.5.2</version>
</dependency>

Construisez une SecretClient instance de classe à l’aide du code similaire à l’exemple suivant :

public class DemoClass {
    public static void main(String... args) {
    SecretClient client = new SecretClientBuilder()
        .vaultUrl("vaultUrl")
        .credential(new ClientSecretCredentialBuilder()
            .tenantId("tenantId")
            .clientId("clientId")
            .clientSecret("clientSecret")
            .build())
        .buildClient();
    }
}

Évitez les informations de codage en dur, telles que client-id et client-secret en rendant ces propriétés configurables, comme illustré dans l’exemple suivant :

@ConfigurationProperties("azure.keyvault")
public class KeyVaultProperties {
    private String vaultUrl;
    private String tenantId;
    private String clientId;
    private String clientSecret;

    public KeyVaultProperties(String vaultUrl, String tenantId, String clientId, String clientSecret) {
        this.vaultUrl = vaultUrl;
        this.tenantId = tenantId;
        this.clientId = clientId;
        this.clientSecret = clientSecret;
    }

    public String getVaultUrl() {
        return vaultUrl;
    }

    public void setVaultUrl(String vaultUrl) {
        this.vaultUrl = vaultUrl;
    }

    public String getTenantId() {
        return tenantId;
    }

    public void setTenantId(String tenantId) {
        this.tenantId = tenantId;
    }

    public String getClientId() {
        return clientId;
    }

    public void setClientId(String clientId) {
        this.clientId = clientId;
    }

    public String getClientSecret() {
        return clientSecret;
    }

    public void setClientSecret(String clientSecret) {
        this.clientSecret = clientSecret;
    }
}

Mettez à jour votre code d’application comme indiqué dans cet exemple :

@SpringBootApplication
@EnableConfigurationProperties(KeyVaultProperties.class)
public class SecretClientApplication implements CommandLineRunner {
    private KeyVaultProperties properties;

    public SecretClientApplication(KeyVaultProperties properties) {
        this.properties = properties;
    }

    public static void main(String[] args) {
        SpringApplication.run(SecretClientApplication.class, args);
    }

    @Override
    public void run(String... args) {
        SecretClient client = new SecretClientBuilder()
            .vaultUrl(properties.getVaultUrl())
            .credential(new ClientSecretCredentialBuilder()
                .tenantId(properties.getTenantId())
                .clientId(properties.getClientId())
                .clientSecret(properties.getClientSecret())
                .build())
            .buildClient();
        System.out.println("sampleProperty: " + client.getSecret("sampleProperty").getValue());
    }
}

Ajoutez les propriétés nécessaires à votre fichier application.yml , comme illustré dans l’exemple suivant :
```
azure:
  keyvault:
    vault-url:
    tenant-id:
    client-id:
    client-secret:
```
Si vous devez utiliser SecretClient dans plusieurs emplacements, définissez un SecretClient haricot. Ensuite, le fil SecretClient automatique dans les endroits appropriés.

Avec Spring Cloud Azure

Avec Spring Cloud Azure, si vous souhaitez récupérer des secrets stockés dans Azure Key Vault, les exigences sont plus simples, comme indiqué dans les étapes suivantes :

Ajoutez les dépendances suivantes à votre fichier pom.xml :

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

Utilisez une facture de matériaux (BOM) pour gérer la version De Spring Cloud Azure, comme illustré dans l’exemple suivant :
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Remarque

Si vous utilisez Spring Boot 2.x, veillez à définir la spring-cloud-azure-dependencies version 4.19.0sur . Cette facture de matériel (BOM) doit être configurée dans la <dependencyManagement> section de votre fichier pom.xml . Cela garantit que toutes les dépendances Azure Spring Cloud utilisent la même version. Pour plus d’informations sur la version utilisée pour ce boM, consultez La version de Spring Cloud Azure à utiliser.

Ajoutez les propriétés suivantes dans votre fichier application.yml :

spring:
  cloud:
    azure:
      keyvault:
        secret:
          endpoint:

Connectez-vous avec Azure CLI à l’aide de la commande suivante. Vos informations d’identification seront ensuite fournies par Azure CLI. Vous n’aurez donc pas besoin d’ajouter d’autres informations d’identification telles que client-id et client-secret.
```
az login
```

SecretClient Câble automatique dans les emplacements appropriés, comme illustré dans l’exemple suivant :

@SpringBootApplication
public class SecretClientApplication implements CommandLineRunner {

    private final SecretClient secretClient;

    public SecretClientApplication(SecretClient secretClient) {
        this.secretClient = secretClient;
    }

    public static void main(String[] args) {
        SpringApplication.run(SecretClientApplication.class, args);
    }

    @Override
    public void run(String... args) {
        System.out.println("sampleProperty: " + secretClient.getSecret("sampleProperty").getValue());
    }
}

Spring Cloud Azure fournit d’autres fonctionnalités en plus de la configuration SecretClientautomatique. Par exemple, vous pouvez utiliser @Value pour obtenir la valeur secrète, comme illustré dans l’exemple suivant :

@SpringBootApplication
public class PropertySourceApplication implements CommandLineRunner {

    @Value("${sampleProperty1}")
    private String sampleProperty1;

    public static void main(String[] args) {
        SpringApplication.run(PropertySourceApplication.class, args);
    }

    public void run(String[] args) {
        System.out.println("sampleProperty1: " + sampleProperty1);
    }

}

Composants d’Azure Spring Cloud

Support Azure

Fournit la prise en charge de la configuration automatique pour les services Azure, tels que Service Bus, Stockage, Active Directory, etc.

Microsoft Entra ID

Fournit une prise en charge de l’intégration de Spring Security avec Microsoft Entra ID pour l’authentification. Pour plus d’informations, consultez support Spring Cloud Azure pour Spring Security.

Azure Key Vault

Fournit la prise en charge de l’annotation Spring @Value pour l’intégration avec les secrets Azure Key Vault. Pour plus d’informations, consultez la gestion des secrets Azure Spring Cloud.

Stockage Azure

Fournit une prise en charge de Spring Boot pour les services Azure Storage. Pour plus d’informations, consultez gestion des ressources Azure Spring Cloud.

Obtenir du support

Si vous avez besoin de support pour Spring Cloud Azure, vous pouvez demander de l’aide de la manière suivante :

Créez des tickets support Azure. Les clients disposant d’un plan de support Azure peuvent ouvrir un ticket de support Azure. Nous vous recommandons cette option si votre problème nécessite une attention immédiate.
Problèmes GitHub de fichier dans le référentiel Azure/azure-sdk-for-java. Nous utilisons des problèmes GitHub pour suivre les bogues, les questions et les demandes de fonctionnalités. Les problèmes GitHub sont gratuits, mais le temps de réponse n’est pas garanti. Pour plus d’informations, consultez le processus de support des problèmes GitHub.

Partager via