Início Rápido: Biblioteca do Azure Cosmos DB for NoSQL para Java

Artigo
01/12/2024

APLICA-SE A: NoSQL

Comece a usar a biblioteca de clientes do Azure Cosmos DB for NoSQL para Java, a fim de consultar dados nos seus contêineres e realizar operações comuns em itens individuais. Siga estas etapas para implantar uma solução mínima no seu ambiente usando o Azure Developer CLI.

Documentação de referência da API | Código-fonte da biblioteca | Pacote (Maven) | Azure Developer CLI

Pré-requisitos

Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
Conta do GitHub

Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
CLI do Desenvolvedor do Azure
Docker Desktop

Configurando

Implante o contêiner de desenvolvimento deste projeto no seu ambiente. Depois, use o Azure Developer CLI (azd) para criar uma conta do Azure Cosmos DB for NoSQL e implantar um aplicativo de exemplo conteinerizado. O aplicativo de exemplo usa a biblioteca de clientes para gerenciar, criar, ler e consultar dados de exemplo.

Importante

As contas do GitHub incluem um direito a horas de armazenamento e núcleo sem nenhum custo. Para obter mais informações, confira Horas de armazenamento e núcleo incluídas nas contas do GitHub.

Abra um terminal no diretório raiz do projeto.
Autentique-se no Azure Developer CLI usando azd auth login. Siga as etapas especificadas pela ferramenta para se autenticar na CLI usando suas credenciais preferenciais do Azure.
```
azd auth login
```
Execute azd init para inicializar o projeto.
```
azd init
```
Durante a inicialização, configure um nome de ambiente exclusivo.

Dica

O nome do ambiente também será usado como o nome do grupo de recursos de destino. Neste início rápido, considere o uso de msdocs-cosmos-db-.
Implante a conta do Azure Cosmos DB usando azd up. Os modelos do Bicep também implantam um aplicativo Web de exemplo.
```
azd up
```
Durante o processo de provisionamento, selecione sua assinatura e o local desejado. Aguarde o processo de provisionamento ser concluído. O processo pode levar aproximadamente cinco minutos.

Depois que o provisionamento dos recursos do Azure for concluído, uma URL para o aplicativo Web em execução será incluída na saída.

Deploying services (azd deploy)

  (✓) Done: Deploying service web
- Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>

SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.

Use a URL no console para navegar até seu aplicativo Web no navegador. Observe a saída do aplicativo em execução.

Instalar a biblioteca de clientes

A biblioteca de clientes está disponível por meio do Maven, como o pacote azure-spring-data-cosmos.

Navegue até a pasta /src/web e abra o arquivo pom.xml.

Caso ela ainda não exista, adicione uma entrada ao pacote azure-spring-data-cosmos.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-spring-data-cosmos</artifactId>
</dependency>

Além disso, adicione outra dependência ao pacote azure-identity, caso ela ainda não exista.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
</dependency>

Modelo de objeto

Nome	Descrição
`EnableCosmosRepositories`	Esse tipo é um decorador de método usado para configurar um repositório para acessar o Azure Cosmos DB for NoSQL.
`CosmosRepository`	Essa classe é a classe de cliente principal e é usada para gerenciar dados em um contêiner.
`CosmosClientBuilder`	Essa classe é um alocador usado para criar um cliente usado pelo repositório.
`Query`	Esse tipo é um decorador de método usado para especificar a consulta executada pelo repositório.

O código de exemplo do modelo usa um banco de dados chamado cosmicworks e um contêiner chamado products. O contêiner products traz detalhes como o nome, a categoria, a quantidade, um identificador exclusivo e um sinalizador de venda para cada produto. O contêiner usa a propriedade /category como uma chave de partição lógica.

Autenticar o cliente

As solicitações do aplicativo para a maioria dos serviços do Azure precisam ser autorizadas. Use o tipo DefaultAzureCredential como a maneira preferencial de implementar uma conexão sem senha entre seus aplicativos e o Azure Cosmos DB for NoSQL. DefaultAzureCredential dá suporte a vários métodos de autenticação e determina quais métodos devem ser usados no runtime.

Importante

Você também pode autorizar solicitações para serviços do Azure usando senhas, cadeias de conexão ou outras credenciais diretamente. No entanto, essa abordagem deve ser usada com cautela. Os desenvolvedores devem ser diligentes para nunca expor esses segredos em um local não seguro. Qualquer pessoa que tenha acesso à senha ou à chave secreta poderá se autenticar no serviço de banco de dados. A DefaultAzureCredential oferece benefícios aprimorados de gerenciamento e segurança em relação à chave de conta para permitir a autenticação sem senha, sem o risco de armazenar as chaves.

Primeiro, essa amostra cria uma classe que herda de AbstractCosmosConfiguration para configurar a conexão com o Azure Cosmos DB for NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {

Dentro da classe de configuração, a amostra cria uma instância da classe CosmosClientBuilder e configura a autenticação usando uma instância de DefaultAzureCredential.

@Bean
public CosmosClientBuilder getCosmosClientBuilder() {
    DefaultAzureCredential azureTokenCredential = new DefaultAzureCredentialBuilder()
        .build();
        
    return new CosmosClientBuilder()
        .endpoint(uri)
        .credential(azureTokenCredential);
}

Obter um banco de dados

Na classe de configuração, a amostra implementa um método para retornar o nome do banco de dados existente chamado cosmicworks.

@Override
protected String getDatabaseName() {
    return "cosmicworks";
}

Obter um contêiner

Use o decorador de método Container para configurar uma classe, a fim de representar os itens de um contêiner. Crie a classe para incluir todos os membros que deseja serializar em JSON. Neste exemplo, o tipo tem um identificador exclusivo e campos para categoria, nome, quantidade, preço e liberação.

@Container(containerName = "products", autoCreateContainer = false)
public class Item {
    private String id;
    private String name;
    private Integer quantity;
    private Boolean sale;

    @PartitionKey
    private String category;

Criar um item

Crie um item no contêiner usando repository.save.

Item item = new Item(
    "70b63682-b93a-4c77-aad2-65501347265f",
    "gear-surf-surfboards",
    "Yamba Surfboard",
    12,
    false
);
Item created_item = repository.save(item);

Ler um item

Realize uma operação de leitura de ponto usando o identificador exclusivo (id) e os campos de chave de partição. Use repository.findById para recuperar com eficiência o item específico.

PartitionKey partitionKey = new PartitionKey("gear-surf-surfboards");
Optional<Item> existing_item = repository.findById("70b63682-b93a-4c77-aad2-65501347265f", partitionKey);
if (existing_item.isPresent()) {
    // Do something  
}

Itens de consulta

Execute uma consulta em vários itens de um contêiner definindo uma consulta na interface do repositório. Esta amostra usa o decorador de método Query para definir um método que executa esta consulta parametrizada:

SELECT * FROM products p WHERE p.category = @category

@Repository
public interface ItemRepository extends CosmosRepository<Item, String> {
    @Query("SELECT * FROM products p WHERE p.category = @category")
    List<Item> getItemsByCategory(@Param("category") String category);
}

Busce todos os resultados da consulta usando repository.getItemsByCategory. Execute um loop pelos resultados da consulta.

List<Item> items = repository.getItemsByCategory("gear-surf-surfboards");
for (Item item : items) {
    // Do something
}

Próxima etapa

Tutorial: Criar um aplicativo Web Java