Mulai cepat: Pustaka Azure Cosmos DB for NoSQL untuk Java

  • Artikel

BERLAKU UNTUK: NoSQL

Mulai menggunakan pustaka klien Azure Cosmos DB for NoSQL untuk Java untuk mengkueri data dalam kontainer Anda dan melakukan operasi umum pada item individual. Ikuti langkah-langkah ini untuk menyebarkan solusi minimal ke lingkungan Anda menggunakan Azure Developer CLI.

Dokumentasi | referensi API Paket kode | sumber pustaka (Maven) | Azure Developer CLI

Prasyarat

Menyiapkan

Sebarkan kontainer pengembangan proyek ini ke lingkungan Anda. Kemudian, gunakan Azure Developer CLI (azd) untuk membuat akun Azure Cosmos DB for NoSQL dan menyebarkan aplikasi sampel dalam kontainer. Aplikasi sampel menggunakan pustaka klien untuk mengelola, membuat, membaca, dan mengkueri data sampel.

Buka di GitHub Codespaces

Buka di Kontainer Dev

Penting

Akun GitHub mencakup pemberian izin penyimpanan dan jam inti tanpa biaya. Untuk informasi selengkapnya, lihat penyimpanan dan jam inti yang disertakan untuk akun GitHub.

  1. Buka terminal di direktori akar proyek.

  2. Autentikasi ke Azure Developer CLI menggunakan azd auth login. Ikuti langkah-langkah yang ditentukan oleh alat untuk mengautentikasi ke CLI menggunakan kredensial Azure pilihan Anda.

    azd auth login

  3. Gunakan azd init untuk menginisialisasi proyek.

    azd init

  4. Selama inisialisasi, konfigurasikan nama lingkungan yang unik.

    Tip

    Nama lingkungan juga akan digunakan sebagai nama grup sumber daya target. Untuk mulai cepat ini, pertimbangkan untuk menggunakan msdocs-cosmos-db-.

  5. Sebarkan akun Azure Cosmos DB menggunakan azd up. Templat Bicep juga menyebarkan aplikasi web sampel.

    azd up

  6. Selama proses provisi, pilih langganan dan lokasi yang Anda inginkan. Tunggu hingga proses provisi selesai. Prosesnya dapat memakan waktu sekitar lima menit.

  7. Setelah provisi sumber daya Azure Anda selesai, URL ke aplikasi web yang sedang berjalan disertakan dalam output.

    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. Gunakan URL di konsol untuk menavigasi ke aplikasi web Anda di browser. Amati output aplikasi yang sedang berjalan.

    Cuplikan layar aplikasi web yang sedang berjalan.

Memasang pustaka klien

Pustaka klien tersedia melalui Maven, sebagai azure-spring-data-cosmos paket.

  1. Navigasi ke /src/web folder dan buka file pom.xml .

  2. Jika belum ada, tambahkan entri untuk azure-spring-data-cosmos paket.

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

  3. Selain itu, tambahkan dependensi lain untuk azure-identity paket jika belum ada.

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

Model objek

Nama Deskripsi
EnableCosmosRepositories Jenis ini adalah dekorator metode yang digunakan untuk mengonfigurasi repositori untuk mengakses Azure Cosmos DB untuk NoSQL.
CosmosRepository Kelas ini adalah kelas klien utama dan digunakan untuk mengelola data dalam kontainer.
CosmosClientBuilder Kelas ini adalah pabrik yang digunakan untuk membuat klien yang digunakan oleh repositori.
Query Jenis ini adalah dekorator metode yang digunakan untuk menentukan kueri yang dijalankan repositori.

Contoh kode

Kode sampel dalam templat menggunakan database bernama cosmicworks dan kontainer bernama products. Kontainer products berisi detail seperti nama, kategori, kuantitas, pengidentifikasi unik, dan bendera penjualan untuk setiap produk. Kontainer menggunakan /category properti sebagai kunci partisi logis.

Mengautentikasi klien

Permintaan aplikasi ke sebagian besar layanan Azure harus diotorisasi. DefaultAzureCredential Gunakan jenis sebagai cara yang disukai untuk menerapkan koneksi tanpa kata sandi antara aplikasi Anda dan Azure Cosmos DB untuk NoSQL. DefaultAzureCredential mendukung beberapa metode autentikasi dan menentukan metode autentikasi yang harus digunakan saat runtime bahasa umum.

Penting

Anda juga dapat mengotorisasi permintaan ke layanan Azure menggunakan kata sandi, string koneksi, atau kredensial lainnya secara langsung. Namun, pendekatan ini harus digunakan dengan hati-hati. Pengembang harus rajin untuk tidak pernah mengekspos rahasia ini di lokasi yang tidak aman. Siapa pun yang mendapatkan akses ke kata sandi atau kunci rahasia dapat mengautentikasi ke layanan database. DefaultAzureCredential menawarkan manfaat manajemen dan keamanan yang ditingkatkan atas kunci akun untuk memungkinkan autentikasi tanpa kata sandi tanpa risiko menyimpan kunci.

Pertama, sampel ini membuat kelas baru yang mewarisi AbstractCosmosConfiguration untuk mengonfigurasi koneksi ke Azure Cosmos DB untuk NoSQL.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {

Dalam kelas konfigurasi, sampel ini membuat instans CosmosClientBuilder baru kelas dan mengonfigurasi autentikasi menggunakan DefaultAzureCredential instans.

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

Mendapatkan database

Di kelas konfigurasi, sampel mengimplementasikan metode untuk mengembalikan nama database yang ada bernama cosmicworks.

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

Mendapatkan kontainer

Container Gunakan dekorator metode untuk mengonfigurasi kelas untuk mewakili item dalam kontainer. Tulis kelas untuk menyertakan semua anggota yang ingin Anda serialkan ke dalam JSON. Dalam contoh ini, jenis memiliki pengidentifikasi unik, dan bidang untuk kategori, nama, kuantitas, harga, dan izin.

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

    @PartitionKey
    private String category;

Membuat item

Buat item dalam kontainer menggunakan repository.save.

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

Baca item

Lakukan operasi baca titik dengan menggunakan bidang pengidentifikasi unik (id) dan kunci partisi. Gunakan repository.findById untuk mengambil item tertentu secara efisien.

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  
}

Buat kueri item

Lakukan kueri atas beberapa item dalam kontainer dengan menentukan kueri di antarmuka repositori. Sampel ini menggunakan Query dekorator metode untuk menentukan metode yang menjalankan kueri berparameter ini:

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

Ambil semua hasil kueri menggunakan repository.getItemsByCategory. Mengulangi hasil kueri.

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

Konten terkait

Langkah selanjutnya

Tutorial: Membangun aplikasi web Java