빠른 시작: Java용 Azure Cosmos DB for NoSQL 라이브러리

적용 대상: NoSQL

• .NET
• JavaScript/Node.js
• Java
• Python
• Go

Java용 Azure Cosmos DB for NoSQL 클라이언트 라이브러리를 시작하여 컨테이너의 데이터를 쿼리하고 개별 항목에 대한 일반적인 작업을 수행합니다. Azure 개발자 CLI를 사용하여 환경에 최소 솔루션을 배포하려면 다음 단계를 따릅니다.

API 참조 설명서 | 라이브러리 소스 코드 | 패키지(Maven) | Azure 개발자 CLI

필수 조건

• 활성 구독이 있는 Azure 계정. 체험 계정을 만듭니다.
• GitHub 계정

• 활성 구독이 있는 Azure 계정. 체험 계정을 만듭니다.
• Azure Developer CLI
• Docker Desktop

설정

이 프로젝트의 개발 컨테이너를 환경에 배포합니다. 그런 다음, Azure 개발자 CLI(azd)를 사용하여 Azure Cosmos DB for NoSQL 계정을 만들고 컨테이너화된 샘플 애플리케이션을 배포합니다. 샘플 애플리케이션은 클라이언트 라이브러리를 사용하여 샘플 데이터를 관리, 만들기, 읽기 및 쿼리합니다.

Important

GitHub 계정에는 무료로 스토리지 및 핵심 시간에 대한 권한이 포함됩니다. 자세한 내용은 GitHub 계정에 포함된 스토리지 및 핵심 시간을 참조하세요.

1. 프로젝트의 루트 디렉터리에서 터미널을 엽니다.

2. azd auth login을 사용하여 Azure 개발자 CLI에 인증합니다. 원하는 Azure 자격 증명을 사용하여 CLI에 인증하려면 도구에 지정된 단계를 따릅니다.

   azd auth login
   

3. 프로젝트를 초기화하려면 azd init를 사용합니다.

   azd init
   

4. 초기화 중에 고유한 환경 이름을 구성합니다.

   팁

   환경 이름은 대상 리소스 그룹 이름으로도 사용됩니다. 이 빠른 시작에서는 msdocs-cosmos-db 사용을 고려해보세요.

5. azd up을 사용하여 Azure Cosmos DB 계정을 배포합니다. Bicep 템플릿은 샘플 웹 애플리케이션도 배포합니다.

   azd up
   

6. 프로비전 과정에서 구독과 원하는 위치를 선택합니다. 프로비저닝 프로세스가 완료될 때까지 기다립니다. 이 과정은 약 5분 정도 소요됩니다.

7. Azure 리소스 프로비전이 완료되면 실행 중인 웹 애플리케이션에 대한 URL이 출력에 포함됩니다.

   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. 콘솔의 URL을 사용하여 브라우저에서 웹 애플리케이션으로 이동합니다. 실행 중인 앱의 출력을 관찰합니다.

   

클라이언트 라이브러리 설치

클라이언트 라이브러리는 Maven을 통해 azure-spring-data-cosmos 패키지로 제공됩니다.

1. /src/web 폴더로 이동하여 pom.xml 파일을 엽니다.

2. 아직 존재하지 않는 경우 azure-spring-data-cosmos 패키지에 대한 항목을 추가합니다.

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

3. 또한 아직 존재하지 않는 경우 azure-identity 패키지에 대한 다른 종속성을 추가합니다.

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

개체 모델

이름	설명
EnableCosmosRepositories	이 형식은 Azure Cosmos DB for NoSQL에 액세스하도록 리포지토리를 구성하는 데 사용되는 메서드 데코레이터입니다.
CosmosRepository	이 클래스는 기본 클라이언트 클래스이며 컨테이너 내의 데이터를 관리하는 데 사용됩니다.
CosmosClientBuilder	이 클래스는 리포지토리에서 사용되는 클라이언트를 만드는 데 사용되는 팩터리입니다.
Query	이 형식은 리포지토리가 실행하는 쿼리를 지정하는 데 사용되는 메서드 데코레이터입니다.

코드 예제

• 클라이언트 인증
• 데이터베이스 가져오기
• 컨테이너 가져오기
• 항목 만들기
• 항목 가져오기
• 쿼리 항목

템플릿의 샘플 코드는 cosmicworks라는 데이터베이스와 products라는 컨테이너를 사용합니다. products 컨테이너에는 각 제품의 이름, 범주, 수량, 고유 식별자 및 판매 플래그와 같은 세부 정보가 포함되어 있습니다. 컨테이너는 /category 속성을 논리 파티션 키로 사용합니다.

클라이언트 인증

대부분의 Azure 서비스에 대한 애플리케이션 요청은 승인되어야 합니다. 애플리케이션과 Azure Cosmos DB for NoSQL 간에 암호 없는 연결을 구현하는 기본 방법으로 DefaultAzureCredential 형식을 사용합니다. DefaultAzureCredential은 여러 인증 방법을 지원하고 런타임에 사용해야 하는 방법을 결정합니다.

Important

암호, 연결 문자열 또는 기타 자격 증명을 직접 사용하여 Azure 서비스에 대한 요청에 권한을 부여할 수도 있습니다. 그러나 이 방법은 신중하게 사용해야 합니다. 개발자는 이러한 비밀을 안전하지 않은 위치에 절대 노출하지 않도록 끊임없이 노력해야 합니다. 암호나 비밀 키에 액세스할 수 있는 사용자는 누구나 데이터베이스 서비스에 인증할 수 있습니다. DefaultAzureCredential은 계정 키에 비해 개선된 관리 및 보안 이점을 제공하므로 키를 저장할 위험 없이 암호 없는 인증이 가능합니다.

먼저 이 샘플은 Azure Cosmos DB for NoSQL에 대한 연결을 구성하기 위해 AbstractCosmosConfiguration에서 상속되는 새 클래스를 만듭니다.

@Configuration
@EnableCosmosRepositories
public class CosmosConfiguration extends AbstractCosmosConfiguration {

구성 클래스 내에서 이 샘플은 CosmosClientBuilder 클래스의 새 인스턴스를 만들고 DefaultAzureCredential 인스턴스를 사용하여 인증을 구성합니다.

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

데이터베이스 가져오기

구성 클래스에서 샘플은 cosmicworks라는 기존 데이터베이스의 이름을 반환하는 메서드를 구현합니다.

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

컨테이너 가져오기

컨테이너의 항목을 나타내도록 클래스를 구성하려면 Container 메서드 데코레이터를 사용합니다. JSON으로 직렬화하려는 모든 멤버를 포함하도록 클래스를 작성합니다. 이 예에서 형식에는 고유 식별자와 범주, 이름, 수량, 가격 및 재고 정리에 대한 필드가 있습니다.

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

    @PartitionKey
    private String category;

항목 만들기

repository.save을 사용하여 컨테이너에 항목을 만듭니다.

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

항목 읽기

고유 식별자(id)와 파티션 키 필드를 모두 사용하여 포인트 읽기 작업을 수행합니다. 특정 항목을 효율적으로 검색하려면 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  
}

쿼리 항목

리포지토리 인터페이스에서 쿼리를 정의하여 컨테이너의 여러 항목에 대해 쿼리를 수행합니다. 이 샘플은 Query 메서드 데코레이터를 사용하여 매개 변수가 있는 쿼리를 실행하는 메서드를 정의합니다.

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

repository.getItemsByCategory를 사용하여 쿼리 결과를 모두 가져옵니다. 쿼리 결과를 반복합니다.

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

관련 콘텐츠

• .NET 빠른 시작
• JavaScript/Node.js 빠른 시작
• Java 빠른 시작
• 빠른 시작으로 이동

다음 단계

자습서: Java 웹앱 빌드