Guida introduttiva: Libreria Azure Cosmos DB per NoSQL per Java

Articolo
03/28/2024

SI APPLICA A: NoSQL

Introduzione alla libreria client Di Azure Cosmos DB per NoSQL per Java per eseguire query sui dati nei contenitori ed eseguire operazioni comuni su singoli elementi. Seguire questa procedura per distribuire una soluzione minima nell'ambiente usando Azure Developer CLI.

Documentazione | di riferimento sulle API Pacchetto del codice | sorgente della libreria (Maven) | Interfaccia della riga di comando per sviluppatori di Azure

Prerequisiti

Un account Azure con una sottoscrizione attiva. Creare un account gratuitamente.
Account GitHub

Un account Azure con una sottoscrizione attiva. Creare un account gratuitamente.
Azure Developer CLI
Docker Desktop

Configurazione

Distribuire il contenitore di sviluppo di questo progetto nell'ambiente. Usare quindi Azure Developer CLI (azd) per creare un account Azure Cosmos DB for NoSQL e distribuire un'applicazione di esempio in contenitori. L'applicazione di esempio usa la libreria client per gestire, creare, leggere ed eseguire query sui dati di esempio.

Importante

Gli account GitHub includono un diritto di archiviazione e ore di core senza costi. Per altre informazioni, vedere le ore di archiviazione e i core inclusi per gli account GitHub.

Aprire un terminale nella directory radice del progetto.
Eseguire l'autenticazione in Azure Developer CLI usando azd auth login. Seguire i passaggi specificati dallo strumento per eseguire l'autenticazione all'interfaccia della riga di comando usando le credenziali di Azure preferite.
```
azd auth login
```
Usare azd init per inizializzare il progetto.
```
azd init
```
Durante l'inizializzazione, configurare un nome di ambiente univoco.

Suggerimento

Il nome dell'ambiente verrà usato anche come nome del gruppo di risorse di destinazione. Per questa guida introduttiva, è consigliabile usare msdocs-cosmos-db-.
Distribuire l'account Azure Cosmos DB usando azd up. I modelli Bicep distribuiscono anche un'applicazione Web di esempio.
```
azd up
```
Durante il processo di provisioning, selezionare la sottoscrizione e il percorso desiderato. Attendere il completamento del processo di provisioning. Per il processo sono necessari circa 5 minuti.

Al termine del provisioning delle risorse di Azure, nell'output viene incluso un URL dell'applicazione Web in esecuzione.

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.

Usare l'URL nella console per passare all'applicazione Web nel browser. Osservare l'output dell'app in esecuzione.

Installare la libreria client

La libreria client è disponibile tramite Maven, come azure-spring-data-cosmos pacchetto.

Passare alla /src/web cartella e aprire il file pom.xml .

Se non esiste già, aggiungere una voce per il azure-spring-data-cosmos pacchetto.

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

Aggiungere anche un'altra dipendenza per il azure-identity pacchetto, se non esiste già.

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

Modello a oggetti

Nome	Descrizione
`EnableCosmosRepositories`	Questo tipo è un elemento decorator di metodo usato per configurare un repository per accedere ad Azure Cosmos DB per NoSQL.
`CosmosRepository`	Questa classe è la classe client primaria e viene usata per gestire i dati all'interno di un contenitore.
`CosmosClientBuilder`	Questa classe è una factory usata per creare un client usato dal repository.
`Query`	Questo tipo è un elemento decorator di metodo usato per specificare la query eseguita dal repository.

Il codice di esempio nel modello usa un database denominato cosmicworks e un contenitore denominato products. Il contenitore products contiene dettagli quali nome, categoria, quantità, identificatore univoco e flag di vendita per ogni prodotto. Il contenitore usa la proprietà /category come chiave di partizione logica.

Autenticare il client

Le richieste dell'applicazione per la maggior parte dei servizi di Azure devono essere autorizzate. Usare il tipo DefaultAzureCredential come metodo preferito per implementare una connessione senza password tra le applicazioni e Azure Cosmos DB for NoSQL. DefaultAzureCredential supporta più metodi di autenticazione e determina il metodo da usare in fase di esecuzione.

Importante

È anche possibile autorizzare le richieste ai servizi di Azure usando direttamente password, stringhe di connessione o altre credenziali. Tuttavia, questo approccio deve essere usato con cautela. Gli sviluppatori devono essere diligenti per non esporre mai questi segreti in una posizione non sicura. Chiunque possa accedere alla password o alla chiave privata è in grado di eseguire l'autenticazione al servizio di database. DefaultAzureCredential offre vantaggi di gestione e sicurezza migliorati rispetto alla chiave dell'account per consentire l'autenticazione senza password senza rischi di archiviazione delle chiavi.

In primo luogo, questo esempio crea una nuova classe che eredita da AbstractCosmosConfiguration per configurare la connessione ad Azure Cosmos DB per NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {

All'interno della classe di configurazione, questo esempio crea una nuova istanza della CosmosClientBuilder classe e configura l'autenticazione usando un'istanza DefaultAzureCredential di .

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

Ottenere un database

Nella classe di configurazione l'esempio implementa un metodo per restituire il nome del database esistente denominato cosmicworks.

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

Ottenere un contenitore

Usare il Container metodo Decorator per configurare una classe per rappresentare gli elementi in un contenitore. Creare la classe per includere tutti i membri da serializzare in JSON. In questo esempio il tipo ha un identificatore univoco e i campi per categoria, nome, quantità, prezzo e autorizzazione.

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

    @PartitionKey
    private String category;

Creare un elemento

Creare un elemento nel contenitore 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);

Leggere un elemento

Eseguire un'operazione di lettura dei punti usando sia l'identificatore univoco (id) che i campi chiave di partizione. Usare repository.findById per recuperare in modo efficiente l'elemento specifico.

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  
}

Eseguire query sugli elementi

Eseguire una query su più elementi in un contenitore definendo una query nell'interfaccia del repository. In questo esempio viene utilizzato il Query metodo decorator per definire un metodo che esegue questa query con parametri:

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

Recuperare tutti i risultati della query usando repository.getItemsByCategory. Scorrere i risultati della query.

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

Passaggio successivo

Esercitazione: Creare un'app Web Java