Partager via


Démarrage rapide : Utiliser Azure Cache pour Redis en Java avec le client Redis Jedis

Dans ce guide de démarrage rapide, vous allez incorporer le cache Azure pour Redis dans une application Java à l’aide du client Redis Jedis. Votre cache est un cache sécurisé et dédié accessible à partir de n’importe quelle application dans Azure.

Passer au code sur GitHub

Clonez le guide de démarrage rapide Java du référentiel sur GitHub.

Conditions préalables

Créer une instance Azure Managed Redis

  1. Pour créer une instance Redis managée Azure, connectez-vous au portail Azure et sélectionnez Créer une ressource.

  2. Dans la page Nouveau, dans la zone de recherche, tapez Azure Cache pour Redis.

  3. Sous l’onglet Nouveau cache Redis , configurez les paramètres de votre nouveau cache sur les bases .

    Réglage Choisir une valeur Descriptif
    Abonnement Dans la liste déroulante, sélectionnez votre abonnement. L’abonnement sous lequel créer cette nouvelle instance Redis managé Azure.
    Groupe de ressources Dans la liste déroulante, sélectionnez un groupe de ressources ou choisissez Créer nouveau, puis entrez un nouveau nom de groupe de ressources. Nom du groupe de ressources dans lequel créer votre cache et d’autres ressources. En plaçant toutes les ressources de votre application dans un seul groupe de ressources, vous pouvez facilement les gérer ou les supprimer ensemble.
    Nom Entrez un nom unique dans la région. Le nom du cache doit être une chaîne de 1 à 63 caractères qui, une fois associée au nom de région du cache contient uniquement des chiffres, des lettres ou des traits d’union. (Si le nom du cache est inférieur à 45 caractères, il peut fonctionner dans toutes les régions actuellement disponibles.) Le nom doit commencer et se terminer par un chiffre ou une lettre, et ne peut pas contenir de traits d’union consécutifs. Le nom d’hôte de votre instance de cache est \<DNS name\>.\<Azure region\>.redis.azure.net.
    Région Dans la liste déroulante, sélectionnez un emplacement. Redis managé Azure est disponible dans certaines régions Azure.
    Niveau données Sélectionnez in-memory pour les performances élevées ou Flash pour réduire les caches de performances Les niveaux en mémoire incluent l’équilibrage, l’optimisation de la mémoire et l’optimisation du calcul. Utilisez le niveau Flash pour utiliser le stockage de données en mémoire (RAM) et disque (SSD).
    Taille du cache Déroulez et sélectionnez une taille. La taille du cache dépend du niveau. La plus petite taille est un niveau équilibré. La taille la plus grande du niveau en mémoire est un niveau mémoire optimisé.
    Niveau de performance Faites défiler la liste déroulante et sélectionnez une préférence de performances. Les performances dépendent du nombre de processeurs virtuels. Le nombre de processeurs virtuels varie selon le niveau. Les instances optimisées pour le calcul ont le plus grand nombre de processeurs virtuels.

    Pour obtenir des conseils sur le choix du niveau de performances approprié, consultez Choisir le niveau approprié.

    Important

    Tous les niveaux de mémoire qui utilisent plus de 120 Go de stockage sont en aperçu public, y compris Memory Optimized M150 et plus ; Balanced B150 et plus ; et Compute Optimized X150 et plus. Tous ces niveaux et versions ultérieures sont en préversion publique.

    Tous les niveaux flash optimisés sont en préversion publique.

  4. Sélectionnez Suivant : Mise en réseau , puis sélectionnez un point de terminaison public ou un point de terminaison privé.

  5. Sélectionnez Suivant : Géoréplication active. Pour utiliser la géoréplication active, elle doit être activée pendant l’approvisionnement. Les caches sans géoréplication active ne peuvent pas être ajoutés ou joindre des groupes de géoréplication actifs ultérieurement. Pour plus d’informations, consultez Configurer la géoréplication active pour les instances d’Azure Managed Redis.

  6. Sélectionnez l’onglet Suivant : Avancé .

    Configurez les modules Redis que vous souhaitez ajouter à l’instance.

    Par défaut, pour un nouveau cache managé :

    • Microsoft Entra ID est activé.
    • L’authentification avec des clés d’accès est désactivée pour des raisons de sécurité.

    Important

    Pour bénéficier d’une sécurité optimale, nous vous recommandons d’utiliser si possible Microsoft Entra ID avec des identités managées pour autoriser les requêtes sur votre cache. L’autorisation avec Microsoft Entra ID et les identités managées offre davantage de sécurité et de facilité d’utilisation que l’autorisation par clé d’accès partagée. Pour plus d’informations sur l’utilisation d’identités managées avec votre cache, consultez Utiliser Microsoft Entra ID pour l’authentification du cache.

    Définir la stratégie de clustering :

    • Utiliser Enterprise pour utiliser RedisSearch ou d’autres modules
    • Utilisez OSS pour un cache en cluster.
    • Utilisez un cache non cluster (préversion) pour un cache non cluster.

    Pour plus d’informations sur le choix d’une stratégie de clustering, consultez Stratégie de clustering.

    Important

    Vous ne pouvez pas modifier la stratégie de clustering d’une instance Redis managée Azure une fois que vous l’avez créée. Si vous utilisez RediSearch, la stratégie de cluster Entreprise est requise et NoEviction est la seule stratégie d’éviction prise en charge.

    Important

    Si vous utilisez cette instance de cache dans un groupe de géoréplication, les stratégies d’éviction ne peuvent pas être modifiées une fois l’instance créée. Veillez à connaître les stratégies d’éviction de vos nœuds principaux avant de créer le cache. Pour plus d’informations sur la géoréplication active, consultez les Prérequis à la géoréplication active.

    Important

    Vous ne pouvez pas modifier les modules après avoir créé une instance de cache. Les modules doivent être activés au moment où vous créez une instance Azure Cache pour Redis. Il n’existe aucune option permettant d’activer la configuration d’un module après avoir créé un cache.

  7. Sélectionnez Suivant : Étiquettes et ignorez.

  8. Sélectionnez Suivant : Vérifier + créer.

  9. Passez en revue les paramètres, puis sélectionnez Créer.

    La création de l’instance Redis prend plusieurs minutes. Vous pouvez suivre la progression sur la page Vue d’ensemble de Redis managé Azure. Lorsque État indique En cours d’exécution, le cache est prêt pour utilisation.

Créer une instance Cache Redis Azure

  1. Dans le portail Azure, recherchez et sélectionnez Cache Azure pour Redis.

  2. Dans la page Cache Azure pour Redis , sélectionnez Créer un>cache Azure pour Redis.

  3. Sous l’onglet Informations de base de la page Nouveau cache Redis , configurez les paramètres suivants :

    • Abonnement : sélectionnez l'abonnement souhaité.
    • Groupe de ressources : sélectionnez un groupe de ressources, ou sélectionnez Créer et entrez un nouveau nom de groupe de ressources. La mise en place de toutes vos ressources d’application dans le même groupe de ressources vous permet de les gérer ou de les supprimer facilement ensemble.
    • Nom : entrez un nom de cache unique dans la région. Le nom doit :
      • Doit être une chaîne de 1 à 63 caractères.
      • Contiennent uniquement des chiffres, des lettres et des traits d’union.
      • Commencez et terminez par un nombre ou une lettre.
      • Ne pas contenir des traits d’union consécutifs.
    • Région : sélectionnez une région Azure près d’autres services qui utilisent votre cache.
    • Référence SKU du cache : sélectionnez une référence SKU pour déterminer les tailles disponibles, les performances et les fonctionnalités de votre cache.
    • Taille du cache : sélectionnez une taille de cache. Pour plus d’informations, consultez Présentation d’Azure Cache pour Redis.

    Capture d’écran montrant l’onglet Informations de base de la page Nouveau cache Redis.

  4. Sélectionnez l’onglet Mise en réseau , ou sélectionnez Suivant : Mise en réseau.

  5. Sous l’onglet Mise en réseau, sélectionnez une méthode de connectivité à utiliser pour le cache. Le point de terminaison privé est recommandé pour la sécurité. Si vous sélectionnez Point de terminaison privé, sélectionnez Ajouter un point de terminaison privé et créez le point de terminaison privé.

  6. Sélectionnez l’onglet Avancé , ou sélectionnez Suivant : Avancé.

  7. Dans le volet Avancé , configurez les options suivantes :

    • Sélectionnez Authentification Microsoft Entra ou Authentification par clés d’accès. L’authentification Microsoft Entra est activée par défaut.
    • Choisissez s’il faut activer le port non TLS.
    • Pour un cache Premium, vous pouvez configurer ou désactiver des zones de disponibilité. Vous ne pouvez pas désactiver les zones de disponibilité une fois le cache créé. Pour un cache Standard, les zones de disponibilité sont allouées automatiquement. Les zones de disponibilité ne sont pas disponibles pour la référence SKU de base.
    • Pour un cache Premium, configurez les paramètres pour le nombre de réplicas, le clustering et le nombre de partitions, l’identité managée affectée par le système et la persistance des données.

    L’image suivante montre l’onglet Avancé pour la référence SKU Standard.

    Capture d’écran montrant le volet Avancé pour un cache de référence SKU Standard.

    Important

    Utilisez l’ID Microsoft Entra avec des identités managées pour autoriser les demandes sur votre cache si possible. L’autorisation utilisant l’ID Microsoft Entra et l’identité managée offre une meilleure sécurité et est plus facile à utiliser que l’autorisation de clé d’accès partagé. Pour plus d’informations sur l’utilisation d’identités managées avec votre cache, consultez Utiliser Microsoft Entra ID pour l’authentification du cache.

  8. Si vous le souhaitez, sélectionnez l’onglet Balises ou sélectionnez Suivant : Balises, puis entrez les noms et les valeurs des balises pour catégoriser vos ressources de cache.

  9. Sélectionnez Vérifier + créer, puis une fois la validation réussie, sélectionnez Créer.

Le nouveau déploiement de cache prend plusieurs minutes. Vous pouvez surveiller la progression du déploiement sur la page Azure Cache pour Redis du portail. Lorsque l’état du cache s’affiche en cours d’exécution, le cache est prêt à être utilisé.

Récupération du nom d’hôte, des ports et des clés d’accès à partir du portail Azure

Pour connecter votre serveur Azure Cache pour Redis, le client de cache a besoin du nom d’hôte, des ports et d’une clé pour le cache. Certains clients peuvent référencer ces éléments par des noms légèrement différents. Vous pouvez récupérer le nom d’hôte, les ports et les clés d’accès à partir du portail Azure.

  • Pour obtenir le nom d’hôte et les ports de votre cache, sélectionnez Vue d’ensemble dans le menu Ressource. Le nom d’hôte est de la forme <DNS name>.redis.cache.windows.net.

    Capture d’écran montrant les propriétés d’Azure Cache pour Redis.

  • Pour obtenir les clés d’accès, sélectionnez Authentification dans le menu Ressource. Sélectionnez ensuite l’onglet Clés d’accès.

    Capture d’écran montrant des clés d’accès à Azure Cache pour Redis.

Configurer l’environnement de travail

Les étapes suivantes montrent comment configurer l’environnement de travail pour l’application Java. Vous pouvez choisir de vous authentifier auprès d’Azure Cache pour Redis à l’aide de Microsoft Entra ID (recommandé) ou de clés d’accès.

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export USER_NAME=<user-name>
export REDIS_CACHE_PORT=10000
export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export USER_NAME=<user-name>
export REDIS_CACHE_PORT=6380

Remplacez les espaces réservés par les valeurs suivantes :

  • <your-host-name> : nom de l’hôte DNS. Pour obtenir le nom d’hôte et les ports de votre cache, sélectionnez Vue d’ensemble dans le menu Ressource. Le nom d’hôte est de la forme <DNS name>.redis.cache.windows.net.

    Capture d’écran montrant les propriétés d’Azure Cache pour Redis.

  • <user-name> : ID d’objet de votre identité managée ou de votre principal de service.

    Vous pouvez obtenir le nom d’utilisateur en procédant comme suit :

    1. Dans le Portail Azure, accédez à votre instance Azure Cache pour Redis.

    2. Dans le volet de navigation, sélectionnez Configuration de l’accès aux données.

    3. Sous l’onglet Utilisateurs Redis, recherchez la colonne Nom d’utilisateur.

      Capture d’écran du portail Azure montrant la page Configuration de l’accès aux données du Cache Azure pour Redis avec l’onglet Utilisateurs Redis et une valeur de nom d’utilisateur mise en surbrillance.

Créer une nouvelle application Java

  1. Utilisez maven pour générer une nouvelle application de démarrage rapide :

    mvn archetype:generate \
        -DarchetypeGroupId=org.apache.maven.archetypes \
        -DarchetypeArtifactId=maven-archetype-quickstart \
        -DarchetypeVersion=1.3 \
        -DinteractiveMode=false \
        -DgroupId=example.demo \
        -DartifactId=redis-jedis-test \
        -Dversion=1.0
    
  2. Accédez au nouveau répertoire de projet redis-jedis-test.

  3. Ouvrez le fichier pom.xml. Dans le fichier, vous voyez une dépendance pour Jedis:

    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-identity</artifactId>
        <version>1.15.0</version> <!-- {x-version-update;com.azure:azure-identity;dependency} -->
    </dependency>
    
    <dependency>
        <groupId>redis.clients</groupId>
        <artifactId>jedis</artifactId>
        <version>5.2.0</version> <!-- {x-version-update;redis.clients:jedis;external_dependency} -->
    </dependency>
    
  4. Fermez le fichier pom.xml.

  5. Ouvrez App.java et remplacez le code par le code suivant :

    package example.demo;
    
    import com.azure.identity.DefaultAzureCredential;
    import com.azure.identity.DefaultAzureCredentialBuilder;
    import com.azure.core.credential.TokenRequestContext;
    import redis.clients.jedis.DefaultJedisClientConfig;
    import redis.clients.jedis.Jedis;
    
    /**
     * Redis test
     *
     */
    public class App
    {
        public static void main( String[] args )
        {
    
            boolean useSsl = true;
    
            //Construct a Token Credential from Identity library, e.g. DefaultAzureCredential / ClientSecretCredential / Client CertificateCredential / ManagedIdentityCredential etc.
            DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().build();
    
            // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
                    String token = defaultAzureCredential
                            .getToken(new TokenRequestContext()
                                    .addScopes("https://redis.azure.com/.default")).block().getToken();
    
            String cacheHostname = System.getenv("REDIS_CACHE_HOSTNAME");
            String username = System.getenv("USER_NAME");
            int port = Integer.parseInt(System.getenv().getOrDefault("REDIS_CACHE_PORT", "6380"));
    
            // Connect to the Azure Cache for Redis over the TLS/SSL port using the key.
            Jedis jedis = new Jedis(cacheHostname, port, DefaultJedisClientConfig.builder()
                    .password(token) // Microsoft Entra access token as password is required.
                    .user(username) // Username is Required
                    .ssl(useSsl) // SSL Connection is Required
                    .build());
            // Perform cache operations using the cache connection object...
    
            // Simple PING command
            System.out.println( "\nCache Command  : Ping" );
            System.out.println( "Cache Response : " + jedis.ping());
    
            // Simple get and put of integral data types into the cache
            System.out.println( "\nCache Command  : GET Message" );
            System.out.println( "Cache Response : " + jedis.get("Message"));
    
            System.out.println( "\nCache Command  : SET Message" );
            System.out.println( "Cache Response : " + jedis.set("Message", "Hello! The cache is working from Java!"));
    
            // Demonstrate "SET Message" executed as expected...
            System.out.println( "\nCache Command  : GET Message" );
            System.out.println( "Cache Response : " + jedis.get("Message"));
    
            // Get the client list, useful to see if connection list is growing...
            System.out.println( "\nCache Command  : CLIENT LIST" );
            System.out.println( "Cache Response : " + jedis.clientList());
    
            jedis.close();
        }
    }
    

    Ce code vous montre comment se connecter à une instance de cache Azure pour Redis à l’aide du nom d’hôte de cache et des variables d’environnement de la clé. Le code stocke et récupère également une valeur de chaîne dans le cache. Les commandes PING et CLIENT LIST sont également exécutées.

  6. Fermez le fichier App.java.

Générer et exécuter l’application

Exécutez la commande Maven suivante pour générer et exécuter l’application :

mvn compile exec:java -D exec.mainClass=example.demo.App

Dans la sortie suivante, vous pouvez voir que la clé Message avait précédemment une valeur mise en cache. La valeur a été mise à jour vers une nouvelle valeur à l’aide de jedis.set. Elle a également exécuté les commandes PING et CLIENT LIST.

Cache Command  : Ping
Cache Response : PONG

Cache Command  : GET Message
Cache Response : Hello! The cache is working from Java!

Cache Command  : SET Message
Cache Response : OK

Cache Command  : GET Message
Cache Response : Hello! The cache is working from Java!

Cache Command  : CLIENT LIST
Cache Response : id=777430 addr=             :58989 fd=22 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=32768 obl=0 oll=0 omem=0 ow=0 owmem=0 events=r cmd=client numops=6

Nettoyer les ressources

Si vous envisagez de continuer avec le tutoriel suivant, vous pouvez conserver les ressources créées dans le cadre de ce démarrage rapide afin de les réutiliser.

Sinon, si vous avez terminé l’exemple d’application de démarrage rapide, vous pouvez supprimer les ressources Azure créées dans ce démarrage rapide afin d’éviter les frais.

Important

La suppression d’un groupe de ressources est définitive ; le groupe de ressources et l’ensemble des ressources qu’il contient sont supprimés de manière permanente. Veillez à ne pas supprimer accidentellement des ressources ou un groupe de ressources incorrects. Si vous avez créé les ressources pour l'hébergement de cet exemple dans un groupe de ressources existant contenant des ressources que vous souhaitez conserver, vous pouvez supprimer chaque ressource individuellement, au lieu de supprimer l'intégralité du groupe de ressources.

  1. Connectez-vous au portail Azure, puis sélectionnez Groupes de ressources.

  2. Dans la zone de texte Filtrer par nom, saisissez le nom de votre groupe de ressources. Les instructions relatives à cet article ont utilisé un groupe de ressources nommé TestResources. Sur votre groupe de ressources dans la liste des résultats, sélectionnez Tester les ressources, puis Supprimer le groupe de ressources.

    Capture d’écran du portail Azure montrant la page Groupe de ressources avec le bouton Supprimer le groupe de ressources mis en surbrillance.

  3. Saisissez le nom de votre groupe de ressources pour confirmer la suppression, puis sélectionnez Supprimer.

Après quelques instants, le groupe de ressources et toutes les ressources qu’il contient sont supprimés.

Étapes suivantes

Dans ce guide de démarrage rapide, vous avez appris à utiliser le cache Azure pour Redis à partir d’une application Java. Passez au guide de démarrage rapide suivant pour utiliser le cache Azure pour Redis avec une application web ASP.NET.