Hızlı Başlangıç: Java için NoSQL için Azure Cosmos DB kitaplığı
UYGULANANLAR: NoSQL
Kapsayıcılarınızdaki verileri sorgulamak ve tek tek öğelerde ortak işlemler gerçekleştirmek için Java için Azure Cosmos DB istemci kitaplığını kullanmaya başlayın. Azure Geliştirici CLI'sını kullanarak ortamınıza en düşük çözümü dağıtmak için bu adımları izleyin.
API başvuru belgeleri | Kitaplık kaynak kodu | Paketi (Maven) | Azure Geliştirici CLI
Önkoşullar
- Etkin aboneliği olan bir Azure hesabı. Ücretsiz hesap oluşturun.
- GitHub hesabı
- Etkin aboneliği olan bir Azure hesabı. Ücretsiz hesap oluşturun.
- Azure Geliştirici CLI'sı
- Docker Desktop
Ayarlama
Bu projenin geliştirme kapsayıcısını ortamınıza dağıtın. Ardından Azure Geliştirici CLI'sını (azd
) kullanarak NoSQL için Azure Cosmos DB hesabı oluşturun ve kapsayıcılı örnek bir uygulama dağıtın. Örnek uygulama örnek verileri yönetmek, oluşturmak, okumak ve sorgulamak için istemci kitaplığını kullanır.
Önemli
GitHub hesapları, hiçbir ücret ödemeden depolama ve çekirdek saat yetkilendirmesi içerir. Daha fazla bilgi için bkz . GitHub hesapları için dahil edilen depolama ve çekirdek saatler.
Projenin kök dizininde bir terminal açın.
kullanarak
azd auth login
Azure Geliştirici CLI'sinde kimlik doğrulaması Tercih ettiğiniz Azure kimlik bilgilerini kullanarak CLI'da kimlik doğrulaması yapmak için araç tarafından belirtilen adımları izleyin.azd auth login
Projeyi başlatmak için kullanın
azd init
.azd init --template cosmos-db-nosql-java-quickstart
Not
Bu hızlı başlangıçta azure-samples/cosmos-db-nosql-java-quickstart şablonu GitHub deposu kullanılmaktadır. Azure Geliştirici CLI'sı, henüz orada değilse bu projeyi otomatik olarak makinenize klonlar.
Başlatma sırasında benzersiz bir ortam adı yapılandırın.
İpucu
Ortam adı, hedef kaynak grubu adı olarak da kullanılır. Bu hızlı başlangıç için kullanmayı
msdocs-cosmos-db
göz önünde bulundurun.Kullanarak
azd up
Azure Cosmos DB hesabını dağıtın. Bicep şablonları ayrıca örnek bir web uygulaması dağıtır.azd up
Sağlama işlemi sırasında aboneliğinizi ve istediğiniz konumu seçin. Sağlama işleminin tamamlanmasını bekleyin. İşlem yaklaşık beş dakika sürebilir.
Azure kaynaklarınızın sağlanması tamamlandıktan sonra, çalışan web uygulamasının URL'si çıktıya eklenir.
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.
Tarayıcıda web uygulamanıza gitmek için konsoldaki URL'yi kullanın. Çalışan uygulamanın çıkışını gözlemleyin.
İstemci kitaplığını yükleme
İstemci kitaplığı, paket olarak azure-spring-data-cosmos
Maven aracılığıyla kullanılabilir.
Klasöre
/src/web
gidin ve pom.xml dosyasını açın.Henüz yoksa paket için
azure-spring-data-cosmos
bir girdi ekleyin.<dependency> <groupId>com.azure</groupId> <artifactId>azure-spring-data-cosmos</artifactId> </dependency>
Ayrıca, henüz yoksa paket için
azure-identity
başka bir bağımlılık ekleyin.<dependency> <groupId>com.azure</groupId> <artifactId>azure-identity</artifactId> </dependency>
Nesne modeli
Veri Akışı Adı | Açıklama |
---|---|
EnableCosmosRepositories |
Bu tür, NoSQL için Azure Cosmos DB'ye erişmek üzere bir depo yapılandırmak için kullanılan bir yöntem dekoratörüdür. |
CosmosRepository |
Bu sınıf birincil istemci sınıfıdır ve kapsayıcı içindeki verileri yönetmek için kullanılır. |
CosmosClientBuilder |
Bu sınıf, depo tarafından kullanılan bir istemci oluşturmak için kullanılan bir fabrikadır. |
Query |
Bu tür, deponun yürüttüğü sorguyu belirtmek için kullanılan bir yöntem dekoratörüdür. |
Kod örnekleri
Şablondaki örnek kod adlı bir veritabanı ve adlı cosmicworks
products
kapsayıcıyı kullanır. Kapsayıcı ad products
, kategori, miktar, benzersiz tanımlayıcı ve her ürün için satış bayrağı gibi ayrıntıları içerir. Kapsayıcı, mantıksal bölüm anahtarı olarak özelliğini kullanır /category
.
İstemcinin kimliğini doğrulama
Çoğu Azure hizmeti için uygulama istekleri yetkilendirilmelidir. DefaultAzureCredential
Uygulamalarınız ile NoSQL için Azure Cosmos DB arasında parolasız bağlantı uygulamak için tercih edilen yol olarak türünü kullanın. DefaultAzureCredential
birden çok kimlik doğrulama yöntemini destekler ve çalışma zamanında hangi yöntemin kullanılacağını belirler.
Önemli
Ayrıca parolaları, bağlantı dizesi veya diğer kimlik bilgilerini kullanarak Azure hizmetlerine yönelik istekleri doğrudan yetkilendirilebilirsiniz. Ancak bu yaklaşım dikkatli kullanılmalıdır. Geliştiriciler bu gizli dizileri güvenli olmayan bir konumda asla açığa çıkarmamak için dikkatli olmalıdır. Parolaya veya gizli anahtara erişim kazanan herkes veritabanı hizmetinde kimlik doğrulaması yapabilir. DefaultAzureCredential
, anahtarları depolama riski olmadan parolasız kimlik doğrulamasına izin vermek için hesap anahtarına göre gelişmiş yönetim ve güvenlik avantajları sunar.
İlk olarak bu örnek, NoSQL için Azure Cosmos DB bağlantısını yapılandırmak üzere öğesinden AbstractCosmosConfiguration
devralan yeni bir sınıf oluşturur.
@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {
Yapılandırma sınıfı içinde, bu örnek sınıfın CosmosClientBuilder
yeni bir örneğini oluşturur ve bir DefaultAzureCredential
örnek kullanarak kimlik doğrulamasını yapılandırılır.
@Bean
public CosmosClientBuilder getCosmosClientBuilder() {
DefaultAzureCredential azureTokenCredential = new DefaultAzureCredentialBuilder()
.build();
return new CosmosClientBuilder()
.endpoint(uri)
.credential(azureTokenCredential);
}
Veritabanı alma
Yapılandırma sınıfında, örnek adlı cosmicworks
mevcut veritabanının adını döndürmek için bir yöntem uygular.
@Override
protected String getDatabaseName() {
return "cosmicworks";
}
Kapsayıcı alma
Kapsayıcıdaki Container
öğeleri temsil eden bir sınıf yapılandırmak için yöntem dekoratörunu kullanın. JSON'da seri hale getirmek istediğiniz tüm üyeleri dahil etmek için sınıfını yazın. Bu örnekte, türün benzersiz bir tanımlayıcısı ve kategori, ad, miktar, fiyat ve boşluk alanları vardır.
@Container(containerName = "products", autoCreateContainer = false)
public class Item {
private String id;
private String name;
private Integer quantity;
private Boolean sale;
@PartitionKey
private String category;
Öğe oluşturma
kullanarak repository.save
kapsayıcıda bir öğe oluşturun.
Item item = new Item(
"70b63682-b93a-4c77-aad2-65501347265f",
"gear-surf-surfboards",
"Yamba Surfboard",
12,
false
);
Item created_item = repository.save(item);
Öğe okuma
Hem benzersiz tanımlayıcıyı (id
) hem de bölüm anahtarı alanlarını kullanarak nokta okuma işlemi gerçekleştirin. Belirli bir öğeyi verimli bir şekilde almak için kullanın repository.findById
.
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
}
Sorgu öğeleri
Deponun arabiriminde bir sorgu tanımlayarak bir kapsayıcıdaki birden çok öğe üzerinde sorgu gerçekleştirin. Bu örnekte, bu parametreli sorguyu Query
yürüten bir yöntem tanımlamak için yöntem dekoratörü kullanılır:
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);
}
kullanarak repository.getItemsByCategory
sorgunun tüm sonuçlarını getirin. Sorgunun sonuçları arasında döngü yapın.
List<Item> items = repository.getItemsByCategory("gear-surf-surfboards");
for (Item item : items) {
// Do something
}