Dela via

Snabbstart: Använda Azure Cosmos DB för NoSQL med Azure SDK för Java

  • Artikel
  • Gäller för:
    ✅ NoSQL

I den här snabbstarten distribuerar du ett grundläggande Azure Cosmos DB for Table-program med hjälp av Azure SDK för Java. Azure Cosmos DB for Table är ett schemalöst datalager som gör att program kan lagra strukturerade tabelldata i molnet. Du lär dig hur du skapar tabeller, rader och utför grundläggande uppgifter i din Azure Cosmos DB-resurs med hjälp av Azure SDK för Java.

API-referensdokumentation Biblioteks källkodspaket | (Maven) | Azure Developer CLI |

Förutsättningar

  • Azure Developer CLI
  • Docker Desktop
  • Java 21

Om du inte har något Azure-konto skapar du ett kostnadsfritt konto innan du börjar.

Initiera projektet

Använd Azure Developer CLI (azd) för att skapa ett Azure Cosmos DB för tabellkonto och distribuera ett containerbaserat exempelprogram. Exempelprogrammet använder klientbiblioteket för att hantera, skapa, läsa och fråga efter exempeldata.

  1. Öppna en terminal i en tom katalog.

  2. Om du inte redan är autentiserad autentiserar du till Azure Developer CLI med .azd auth login Följ stegen som anges av verktyget för att autentisera till CLI med dina önskade Azure-autentiseringsuppgifter.

    azd auth login

  3. Använd azd init för att initiera projektet.

    azd init --template cosmos-db-nosql-java-quickstart

  4. Under initieringen konfigurerar du ett unikt miljönamn.

  5. Distribuera Azure Cosmos DB-kontot med .azd up Bicep-mallarna distribuerar också ett exempelwebbprogram.

    azd up

  6. Under etableringsprocessen väljer du din prenumeration, önskad plats och målresursgrupp. Vänta tills etableringsprocessen har slutförts. Processen kan ta ungefär fem minuter.

  7. När etableringen av dina Azure-resurser är klar inkluderas en URL till det webbprogram som körs i utdata.

    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.

  8. Använd URL:en i konsolen för att navigera till webbprogrammet i webbläsaren. Observera utdata från appen som körs.

Skärmbild av webbprogrammet som körs.

Installera klientbiblioteket

Klientbiblioteket är tillgängligt via Maven som azure-spring-data-cosmos paket.

  1. Gå till /src/web mappen och öppna filen pom.xml .

  2. Om den inte redan finns lägger du till en post för azure-spring-data-cosmos paketet.

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

  3. Lägg också till ett annat beroende för azure-identity paketet om det inte redan finns.

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

Objektmodell

Name beskrivning
EnableCosmosRepositories Den här typen är en metoddekoratör som används för att konfigurera en lagringsplats för åtkomst till Azure Cosmos DB för NoSQL.
CosmosRepository Den här klassen är den primära klientklassen och används för att hantera data i en container.
CosmosClientBuilder Den här klassen är en fabrik som används för att skapa en klient som används av lagringsplatsen.
Query Den här typen är en metoddekoratör som används för att ange frågan som lagringsplatsen kör.

Kodexempel

Exempelkoden i mallen använder en databas med namnet cosmicworks och containern med namnet products. Containern products innehåller information som namn, kategori, kvantitet, en unik identifierare och en försäljningsflagga för varje produkt. Containern använder egenskapen /category som en logisk partitionsnyckel.

Autentisera klienten

Först skapar det här exemplet en ny klass som ärver från AbstractCosmosConfiguration för att konfigurera anslutningen till Azure Cosmos DB för NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {
}

I konfigurationsklassen skapar det här exemplet en ny instans av klassen och konfigurerar autentisering med hjälp av CosmosClientBuilder en DefaultAzureCredential instans.

@Bean
public CosmosClientBuilder getCosmosClientBuilder() {
    DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
        .build();
        
    return new CosmosClientBuilder()
        .endpoint("<azure-cosmos-db-nosql-account-endpoint>")
        .credential(credential);
}

Hämta en databas

I konfigurationsklassen implementerar exemplet en metod för att returnera namnet på den befintliga databasen med namnet cosmicworks.

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

Hämta en container

Använd metoddekoratören Container för att konfigurera en klass för att representera objekt i en container. Skapa klassen för att inkludera alla medlemmar som du vill serialisera i JSON. I det här exemplet har typen en unik identifierare och fält för kategori, namn, kvantitet, pris och klarering.

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

    @PartitionKey
    private String category;

    // Extra members omitted for brevity
}

Skapa ett objekt

Skapa ett objekt i containern med .repository.save

Item item = new Item(
    "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "gear-surf-surfboards",
    "Yamba Surfboard",
    12,
    false
);
Item created_item = repository.save(item);

Läsa ett objekt

Utför en punktläsningsåtgärd med hjälp av både de unika identifierarna (id) och partitionsnyckelfälten. Använd repository.findById för att effektivt hämta det specifika objektet.

PartitionKey partitionKey = new PartitionKey("gear-surf-surfboards");
Optional<Item> existing_item = repository.findById("aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb", partitionKey);
if (existing_item.isPresent()) {
    // Do something
}

Frågeobjekt

Utför en fråga över flera objekt i en container genom att definiera en fråga i lagringsplatsens gränssnitt. Det här exemplet använder metoddekoratören Query för att definiera en metod som kör den här parameteriserade frågan:

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

}

Hämta alla resultat av frågan med hjälp repository.getItemsByCategoryav . Loopa igenom resultatet av frågan.

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

Rensa resurser

När du inte längre behöver exempelprogrammet eller resurserna tar du bort motsvarande distribution och alla resurser.

azd down

Relaterat innehåll