Краткое руководство. Использование Кэш Azure для Redis в Java с клиентом Jedis Redis

2025-05-20
Применяется к: ✅ Azure Cache for Redis, ✅ Azure Managed Redis

В этом кратком руководстве описано, как использовать Кэш Azure для Redis с приложениями Java, использующими клиент Jedis. Ваш кэш выделен специально для вас, он безопасен и доступен из любого приложения в Azure.

Клонируйте репозиторий Краткое руководство для Java на GitHub.

Предпосылки

Подписка Azure — создайте бесплатную учетную запись.
Apache Maven

Создайте управляемый экземпляр Redis в Azure

Чтобы создать экземпляр Azure Managed Redis, войдите на портал Azure и выберите "Создать ресурс".
На новой странице в поле поиска введите Кэш Azure для Redis.

На вкладке "Новый кэш Redis" настройте параметры для нового кэша в основах.

Настройки	Выберите значение	Описание
Подписка	Раскройте список и выберите нужную подписку.	Подписка, в которой создается новый экземпляр Управляемого Redis Azure.
Группа ресурсов	Раскройте список и выберите группу ресурсов или нажмите Создать и введите имя для новой группы ресурсов.	Имя группы ресурсов, в которой будут созданы кэш и другие ресурсы. Поместив все ресурсы приложения в одну группу ресурсов, вы сможете легко управлять ими и/или удалить их вместе.
Имя	Введите уникальное в пределах региона имя.	Имя кэша должно быть строкой от 1 до 63 символов при сочетании с именем региона кэша, содержащим только цифры, буквы или дефисы. (Если имя кэша меньше 45 символов, оно должно работать во всех доступных регионах.) Имя должно начинаться и заканчиваться числом или буквой и не может содержать последовательные дефисы. Имя.
Регион	Раскройте список и выберите место.	Управляемый Redis azure доступен в выбранных регионах Azure.
Уровень данных	Выберите в памяти для высокой производительности или Flash для более низких производительности кэшей	Уровни в памяти включают Balanced, Memory Optimized и Compute Optimized. Используйте уровень Flash для работы с данными в памяти (ОЗУ) и на твердотельном накопителе (SSD).
Размер кэша	Выпадающее меню и выбор размера.	Размер кэша зависит от уровня. Наименьший размер — это сбалансированный уровень. Самый большой уровень в памяти — это оптимизированный для памяти уровень.
Производительность	Разверните список и выберите предпочтение производительности.	Производительность зависит от количества виртуальных ЦП. Количество виртуальных ЦП зависит от уровня. Оптимизированный для вычислений имеет наибольшее количество виртуальных ЦП.

Рекомендации по выбору нужного уровня производительности см. в разделе "Выбор нужного уровня".

Это важно

Все уровни памяти с объемом хранилища более 120 ГБ находятся в общедоступной предварительной версии, включая оптимизированные по памяти M150 и выше; сбалансированные B150 и выше; и оптимизированные по вычислениям X150 и выше. Все эти уровни и выше находятся в общедоступной предварительной версии.

Все уровни, оптимизированные для флэш-памяти, находятся в общедоступном предварительном доступе.

Нажмите кнопку "Далее": сеть и выберите общедоступную конечную точку или частную конечную точку.
Нажмите кнопку "Далее": активная георепликация. Чтобы использовать активную георепликацию, ее необходимо включить во время подготовки. Кэши без активной георепликации нельзя впоследствии добавлять в группы активной георепликации или присоединяться к ним. Дополнительные сведения см. в разделе "Настройка активной георепликации для экземпляров Управляемого Redis Azure".
Нажмите кнопку "Далее": вкладка "Дополнительно ".

Настройте все модули Redis , которые нужно добавить в экземпляр.

По умолчанию для нового управляемого кэша:
- Идентификатор Microsoft Entra включен.
- Проверка подлинности ключей доступа отключена по соображениям безопасности.
Это важно

Для оптимальной безопасности рекомендуется использовать идентификатор Microsoft Entra с управляемыми удостоверениями для авторизации запросов к кэшу, если это возможно. Авторизация с помощью идентификатора Microsoft Entra и управляемых удостоверений обеспечивает более высокую безопасность и удобство использования при авторизации ключа общего доступа. Для получения дополнительной информации об использовании управляемых удостоверений с кэшем см. в разделе Используйте идентификатор Microsoft Entra для проверки подлинности кэша.

Задайте политику кластеризации:
- Использование Enterprise для использования RedisSearch или других модулей
- Используйте OSS для кластеризованного кэша.
- Используйте Некластеризованный (Превью) для некластеризованного кэша.
Дополнительные сведения о выборе политики кластеризации см. в статье "Политика кластера".

Это важно

После создания не удается изменить политику кластеризации управляемого экземпляра Redis Azure. Если вы используете RediSearch, требуется политика кластера Enterprise и NoEviction является единственной поддерживаемой политикой вытеснения.

Это важно

Если вы используете этот экземпляр кэша в группе георепликации, политики вытеснения нельзя изменить после создания экземпляра. Перед созданием кэша необходимо знать политики вытеснения основных узлов. Дополнительные сведения о активной георепликации см. в разделе "Предварительные требования для активной георепликации".

Это важно

После создания экземпляра кэша нельзя изменять модули. Модули должны быть включены во время создания экземпляра Кэш Azure для Redis. После создания кэша невозможно включить настройку модуля.
Нажмите кнопку "Далее": теги и пропуск.
Нажмите кнопку "Далее": проверка и создание.
Проверьте параметры и выберите Создать.

Создание экземпляра Redis занимает несколько минут. Ход выполнения можно отслеживать на странице обзора Управляемого Redis в Azure. Когда Состояние примет значение Running (Выполняется), кэш будет готов к использованию.

Создание экземпляра кэша Azure для Redis

На портале Azure найдите и выберите кэш Azure для Redis.
На странице кэша Azure для Redis выберите "Создать>кэш Azure для Redis".
На вкладке "Основы" страницы"Новый кэш Redis " настройте следующие параметры:
- Подписка. Выберите нужную подписку.
- Группа ресурсов: выберите группу ресурсов или нажмите кнопку "Создать" и введите новое имя группы ресурсов. Размещение всех ресурсов приложения в одной группе ресурсов позволяет легко управлять и удалять их вместе.
- Имя: введите уникальное имя кэша в регионе. Имя должно быть:
  - Должна быть строка длиной от 1 до 63 символов.
  - Содержит только цифры, буквы и дефисы.
  - Начните и закончите числом или буквой.
  - Не содержит последовательные дефисы.
- Регион. Выберите регион Azure рядом с другими службами, используюющими кэш.
- Номер SKU кэша: выберите номер SKU , чтобы определить доступные размеры, производительность и функции кэша.
- Размер кэша: выберите размер кэша. Дополнительные сведения см. в статье Общие сведения о Кэше Azure для Redis.
Выберите вкладку "Сеть" или нажмите кнопку "Далее: Сеть".
На вкладке "Сеть" выберите метод подключения, используемый для кэша. Для обеспечения безопасности рекомендуется использовать частную конечную точку. Если выбрать частную конечную точку, выберите "Добавить частную конечную точку" и создайте частную конечную точку.
Выберите вкладку "Дополнительно" или нажмите кнопку "Далее".
На панели "Дополнительно" настройте следующие параметры:
- Выберите Microsoft Entra Authentication или Access Keys Authentication. Проверка подлинности Microsoft Entra включена по умолчанию.
- Выберите, следует ли включить порт, отличный от TLS.
- Для кэша уровня "Премиум" можно настроить или отключить зоны доступности. После создания кэша невозможно отключить зоны доступности. Для кэша уровня "Стандартный" зоны доступности выделяются автоматически. Зоны доступности недоступны для базовой SKU.
- Для кэша Premium настройте параметры для числа реплик, кластеризации и числа шардов, управляемого удостоверения, назначаемого системой, и сохранения данных.
На следующем рисунке показана вкладка "Дополнительно " для номера SKU "Стандартный".

Это важно

Используйте Microsoft Entra ID с управляемыми удостоверениями, чтобы авторизовать запросы к кэшу, если это возможно. Авторизация с помощью идентификатора Microsoft Entra и управляемого удостоверения обеспечивает более высокую безопасность и проще использовать, чем авторизация общего ключа доступа. Для получения дополнительной информации об использовании управляемых удостоверений с кэшем см. в разделе Используйте идентификатор Microsoft Entra для проверки подлинности кэша.
При необходимости выберите вкладку "Теги " или нажмите кнопку "Далее" и введите имена тегов и значения, чтобы классифицировать ресурсы кэша.
Выберите "Просмотр и создание" и после прохождения проверки нажмите кнопку "Создать".

Развертывание нового кэша занимает несколько минут. Ход развертывания можно отслеживать на странице кэша Azure для Redis на портале. Когда состояние кэша отображается запущено, кэш готов к использованию.

Получение имени узла, портов и ключей доступа с помощью портала Azure

Чтобы подключить сервер Кэша Azure для Redis, для клиента кэша необходимо указать имя узла, порты и ключ для кэша. Некоторые клиенты могут ссылаться на эти элементы с помощью незначительно различающихся имен. Вы можете получить имя узла, порты и ключи на портале Azure.

Чтобы получить имя узла и порты для кэша, выберите "Обзор " в меню "Ресурс ". Имя узла имеет форму <DNS name>.redis.cache.windows.net.
Чтобы получить ключи доступа, выберите "Проверка подлинности " в меню "Ресурс ". Затем откройте вкладку "Ключи доступа".

Настройка рабочей среды

Ниже показано, как настроить рабочую среду для приложения Java. Вы можете пройти проверку подлинности с помощью Кэш Azure для Redis с помощью идентификатора Microsoft Entra (рекомендуется) или ключей доступа.

Проверка подлинности идентификатора Microsoft Entra (рекомендуется)
Проверка подлинности ключа доступа

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

Замените заполнители следующими значениями:

<your-host-name>: DNS-имя узла. Чтобы получить имя узла и порты для кэша, выберите "Обзор " в меню "Ресурс ". Имя узла имеет форму <DNS name>.redis.cache.windows.net.
<user-name>: идентификатор объекта управляемого удостоверения или субъекта-службы.

Вы можете получить имя пользователя, выполнив следующие действия.
1. В портал Azure перейдите к экземпляру Кэш Azure для Redis.
2. На панели навигации выберите "Конфигурация доступа к данным".
3. На вкладке "Пользователи Redis" найдите столбец "Имя пользователя ".

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export REDIS_CACHE_KEY=<your-primary-access-key>
export REDIS_CACHE_PORT=10000

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export REDIS_CACHE_KEY=<your-primary-access-key>
export REDIS_CACHE_PORT=6380

Замените заполнители следующими значениями:

<your-host-name>: DNS-имя узла. Чтобы получить имя узла и порты для кэша, выберите "Обзор " в меню "Ресурс ". Имя узла имеет форму <DNS name>.redis.cache.windows.net.
<your-primary-access-key>: первичный ключ доступа. Чтобы получить ключи доступа, выберите "Проверка подлинности " в меню "Ресурс ". Затем откройте вкладку "Ключи доступа".

Создание нового приложения Java

Используйте maven для создания нового приложения быстрого запуска:

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

Перейдите в новый каталог проекта redis-jedis-test .
Откройте файл pom.xml. В файле отображается зависимость для Jedis:
- Проверка подлинности идентификатора Microsoft Entra (рекомендуется)
- Проверка подлинности ключа доступа
```
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.15.0</version> 
</dependency>

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.2.0</version> 
</dependency>
```
Это важно

Корпорация Майкрософт рекомендует использовать проверку подлинности Идентификатора Microsoft Entra для наиболее безопасной проверки подлинности вместо использования паролей или ключей доступа. Ключи доступа требуют высокой степени доверия к приложению и несут риски, которые не присутствуют при использовании идентификатора Microsoft Entra. Используйте ключи доступа, только если проверка подлинности идентификатора Microsoft Entra невозможна.
```
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.2.0</version> 
</dependency>
```
Закройте файл pom.xml.

Откройте файл App.java и ознакомьтесь с представленным ниже кодом:

Проверка подлинности идентификатора Microsoft Entra (рекомендуется)
Проверка подлинности ключа доступа

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

package example.demo;

import redis.clients.jedis.DefaultJedisClientConfig;
import redis.clients.jedis.Jedis;

/**
 * Redis test
 *
 */
public class App
{
    public static void main( String[] args )
    {

        boolean useSsl = true;
        String cacheHostname = System.getenv("REDIS_CACHE_HOSTNAME");
        String cachekey = System.getenv("REDIS_CACHE_KEY");
        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(cachekey)
            .ssl(useSsl)
            .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();
    }
}

Этот код показывает, как подключиться к экземпляру кэша Redis для Azure, используя имя узла кэша и переменные среды ключа. Код также хранит строковое значение в кэше и извлекает его. Также выполняются команды PING и CLIENT LIST.

Закройте файл App.java.

Создание и запуск приложения

Выполните следующую команду Maven для построения и запуска приложения:

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

В следующих выходных данных видно, что Message ключ ранее имел кэшированное значение. Оно было обновлено до нового значения с помощью jedis.set. Кроме того, оно выполнило команды PING и 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

Очистите ресурсы

Если вы планируете продолжить работу со следующим руководством, вы можете сохранить ресурсы, созданные в этом кратком руководстве, и повторно использовать их.

В противном случае, если вы закончили работу с примером приложения из краткого руководства, вы можете удалить ресурсы Azure, созданные в текущем руководстве, чтобы избежать ненужных расходов.

Это важно

Удаление группы ресурсов — необратимая операция, и все соответствующие ресурсы удаляются окончательно. Будьте внимательны, чтобы случайно не удалить не ту группу ресурсов или не те ресурсы. Если вы создали ресурсы для размещения этого примера в существующей группе ресурсов, содержащей ресурсы, которые необходимо сохранить, можно удалить каждый ресурс по отдельности, а не удалить группу ресурсов.

Войдите в портал Azure и выберитеГруппы ресурсов.
Введите имя группы ресурсов в текстовое поле Фильтровать по имени. Инструкции для этой статьи использовали группу ресурсов с именем TestResources. В группе ресурсов в списке результатов выберите "Тестовые ресурсы " и "Удалить группу ресурсов".
Введите имя группы ресурсов, чтобы подтвердить удаление, а затем нажмите кнопку "Удалить".

Через некоторое время группа ресурсов и все ее ресурсы будут удалены.

Дальнейшие шаги

Из этого краткого руководства вы узнали, как использовать кэш Redis для Azure в приложениях Java. Переходите к следующему краткому руководству по использованию кэша Azure для Redis в веб-приложениях ASP.NET.