Guia de início rápido: usar o Cache Redis do Azure em Java com o cliente Jedis Redis

Artigo
01/16/2025

Neste início rápido, você incorpora o Cache Redis do Azure em um aplicativo Java usando o cliente Jedis Redis. Seu cache é um cache seguro e dedicado que pode ser acessado a partir de qualquer aplicativo no Azure.

Clone o início rápido do repositório Java no GitHub.

Pré-requisitos

Subscrição do Azure - crie uma gratuitamente
Apache Maven

Criar uma Cache do Azure para Redis

Para criar um cache, entre no portal do Azure. No menu do portal, selecione Criar um recurso.
No painel Introdução, insira Cache Redis do Azure na barra de pesquisa. Nos resultados da pesquisa, localize o Cache do Azure para Redis e selecione Criar.

No painel Novo Cache Redis, na guia Noções básicas, defina as seguintes configurações para o cache:

Definição	Ação	Descrição
Subscrição	Selecione a subscrição do Azure.	A assinatura a ser usada para criar a nova instância do Cache do Azure para Redis.
Grupo de recursos	Selecione um grupo de recursos ou selecione Criar novo e insira um novo nome de grupo de recursos.	Um nome para o grupo de recursos no qual criar seu cache e outros recursos. Ao colocar todos os recursos do seu aplicativo em um grupo de recursos, você pode facilmente gerenciá-los ou excluí-los juntos.
Nome DNS	Introduza um nome exclusivo.	O nome do cache deve ser uma cadeia de caracteres de 1 a 63 caracteres que contenha apenas números, letras e hífenes. O nome deve começar e terminar com um número ou letra, e não pode conter hífenes consecutivas. O nome de host da instância de cache é `\<DNS name>.redis.cache.windows.net`.
Location	Selecione uma localização.	Uma região do Azure que está perto de outros serviços que usam seu cache.
Cache SKU	Selecione uma SKU.	A SKU determina o tamanho, o desempenho e os parâmetros de recurso disponíveis para o cache. Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.
Tamanho do cache	Selecione um tamanho de cache.	Para obter mais informações, consulte Visão geral do Cache do Azure para Redis.

Selecione a guia Rede ou selecione Avançar: Rede.
Na guia Rede, selecione um método de conectividade a ser usado para o cache.
Selecione a guia Avançado ou selecione Avançar: Avançado.
No painel Avançado, verifique ou selecione um método de autenticação com base nas seguintes informações:
- Por padrão, para um novo cache Básico, Standard ou Premium, a Autenticação do Microsoft Entra está habilitada e a Autenticação de Chaves de Acesso está desabilitada.
- Para caches Basic ou Standard, você pode escolher a seleção para uma porta não-TLS.
- Para caches Standard e Premium, você pode optar por habilitar zonas de disponibilidade. Não é possível desativar as zonas de disponibilidade após a criação do cache.
- Para um cache Premium, defina as configurações para porta não-TLS, clustering, identidade gerenciada e persistência de dados.
Importante

Para uma segurança ideal, recomendamos que você use o Microsoft Entra ID com identidades gerenciadas para autorizar solicitações em seu cache, se possível. A autorização usando o ID do Microsoft Entra e identidades gerenciadas oferece segurança superior e facilidade de uso em relação à autorização de chave de acesso compartilhado. Para obter mais informações sobre como usar identidades gerenciadas com seu cache, consulte Usar a ID do Microsoft Entra para autenticação de cache.
(Opcional) Selecione a guia Tags ou selecione Next: Tags.
(Opcional) Na guia Marcas , insira um nome e um valor de tag se quiser categorizar seu recurso de cache.
Selecione o botão Rever + criar.

Na guia Revisão + criação, o Azure valida automaticamente sua configuração.
Depois que a mensagem verde Validação passada for exibida, selecione Criar.

Uma nova implantação de cache ocorre ao longo de vários minutos. Você pode monitorar o progresso da implantação no painel Visão Geral do Cache do Azure para Redis. Quando Status exibe Em execução, o cache está pronto para uso.

Configurar o ambiente de trabalho

As etapas a seguir mostram como configurar o ambiente de trabalho para o aplicativo Java. Você pode optar por autenticar com o Cache Redis do Azure usando a ID do Microsoft Entra (recomendado) ou chaves de acesso.

Autenticação do Microsoft Entra ID (recomendado)
Autenticação de chave de acesso

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

Substitua os espaços reservados pelos seguintes valores:

<your-host-name>: O nome do host DNS. Para obter o nome do host e as portas do cache, selecione Visão geral no menu Recurso . O nome do host é do formato <DNS name>.redis.cache.windows.net.
<user-name>: ID do objeto da sua identidade gerenciada ou entidade de serviço.

Você pode obter o nome de usuário usando as seguintes etapas:
1. No portal do Azure, navegue até sua instância do Cache do Azure para Redis.
2. No painel de navegação, selecione Configuração de Acesso a Dados.
3. Na guia Usuários do Redis, localize a coluna Nome de usuário.

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

Substitua os espaços reservados pelos seguintes valores:

<your-host-name>: O nome do host DNS. Para obter o nome do host e as portas do cache, selecione Visão geral no menu Recurso . O nome do host é do formato <DNS name>.redis.cache.windows.net.
<your-primary-access-key>: A chave de acesso primária. Para obter as chaves de acesso, selecione Autenticação no menu Recurso . Em seguida, selecione a guia Teclas de acesso.

Criar uma nova aplicação Java

Use o maven para gerar um novo aplicativo de início rápido:

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

Mude para o novo diretório do projeto redis-jedis-test .
Abra o arquivo pom.xml . No arquivo, você vê uma dependência para Jedis:
- Autenticação do Microsoft Entra ID (recomendado)
- Autenticação de chave de acesso
```
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.11.2</version> 
</dependency>

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.1.0</version>  
</dependency>
```
Importante

A Microsoft recomenda o uso da autenticação Microsoft Entra ID para a experiência de autenticação mais segura em vez de usar senhas ou chaves de acesso. A autenticação descrita nesta seção do artigo usa chaves de acesso, que exigem um grau muito alto de confiança no aplicativo e acarreta riscos não presentes ao usar o Microsoft Entra ID. Use a abordagem neste documento somente quando a autenticação do Microsoft Entra ID não for viável.
```
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>5.1.0</version>  
</dependency>
```
Feche o arquivo pom.xml .

Abra App.java e veja o código com o seguinte código:

Autenticação do Microsoft Entra ID (recomendado)
Autenticação de chave de acesso

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");

        // Connect to the Azure Cache for Redis over the TLS/SSL port using the key.
        Jedis jedis = new Jedis(cacheHostname, 6380, 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");

        // Connect to the Azure Cache for Redis over the TLS/SSL port using the key.
        Jedis jedis = new Jedis(cacheHostname, 6380, 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();
    }
}

Este código mostra como se conectar a uma instância do Cache Redis do Azure usando o nome do host do cache e as principais variáveis de ambiente. O código também armazena e obtém um valor de cadeia na cache. Os comandos PING e CLIENT LIST também são executados.

Feche o arquivo App.java .

Compilar e executar a aplicação

Execute o seguinte comando Maven para criar e executar a aplicação:

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

Na saída a seguir, você pode ver que a Message chave anteriormente tinha um valor armazenado em cache. O valor foi atualizado para um novo valor usando jedis.set. A aplicação também executou os comandos PING e 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

Clean up resources (Limpar recursos)

Se você planeja continuar com o próximo tutorial, você pode manter os recursos criados neste início rápido e reutilizá-los.

Caso contrário, se tiver terminado o aplicativo de exemplo de início rápido, você poderá excluir os recursos do Azure criados neste início rápido para evitar cobranças.

Importante

A eliminação de um grupo de recursos é irreversível e o grupo de recursos e todos os recursos contidos no mesmo serão permanentemente eliminados. Confirme que não elimina acidentalmente o grupo de recursos ou recursos errados. Se você criou os recursos para hospedar este exemplo dentro de um grupo de recursos existente que contém recursos que você deseja manter, você pode excluir cada recurso individualmente em vez de excluir o grupo de recursos.

Inicie sessão no Portal do Azure e selecione Grupos de recursos.
Na caixa de texto Filtrar por nome, digite o nome do seu grupo de recursos. As instruções para este artigo usaram um grupo de recursos chamado TestResources. No seu grupo de recursos na lista de resultados, selecione Testar Recursos e, em seguida , Excluir grupo de recursos.
Digite o nome do grupo de recursos para confirmar a exclusão e selecione Excluir.

Após alguns instantes, o grupo de recursos e todos os recursos contidos no mesmo são eliminados.

Próximos passos

Neste guia de início rápido, você aprendeu a usar o Cache Redis do Azure a partir de um aplicativo Java. Continue para o próximo início rápido para usar o Cache Redis do Azure com um aplicativo Web ASP.NET.

Partilhar via

Guia de início rápido: usar o Cache Redis do Azure em Java com o cliente Jedis Redis

Pré-requisitos

Criar uma Cache do Azure para Redis

Configurar o ambiente de trabalho

Criar uma nova aplicação Java

Compilar e executar a aplicação

Clean up resources (Limpar recursos)

Próximos passos

Comentários

Recursos adicionais

Partilhar via

Guia de início rápido: usar o Cache Redis do Azure em Java com o cliente Jedis Redis

Saltar para o código no GitHub

Pré-requisitos

Criar uma Cache do Azure para Redis

Configurar o ambiente de trabalho

Criar uma nova aplicação Java

Compilar e executar a aplicação

Clean up resources (Limpar recursos)

Próximos passos

Comentários

Recursos adicionais