快速入门:使用 Azure Cosmos DB SQL API 帐户构建 Java 应用程序

本快速入门介绍如何使用 Java 应用程序创建和管理 Azure Cosmos DB SQL API 帐户的资源。 首先,请使用 Azure 门户创建 Azure Cosmos DB SQL API 帐户,使用 SQL Java SDK 创建 Java 应用,使用 Java 应用程序将资源添加到 Cosmos DB 帐户。 本快速入门中的说明适用于任何能够运行 Java 的操作系统。 完成本快速入门以后,你就会熟悉如何通过 UI 或编程方式(以首选方式为准)创建和修改 Cosmos DB 数据库和集合。

先决条件

如果没有 Azure 订阅,可在开始前创建一个试用帐户

可以使用 URI 为 https://localhost:8081 的 Azure Cosmos DB 模拟器对请求进行身份验证中提供了主密钥。

此外:

  • Java 开发工具包 (JDK) 1.8+
    • 在 Ubuntu 上运行 apt-get install default-jdk,以便安装 JDK。
    • 请确保设置 JAVA_HOME 环境变量,使之指向在其中安装了 JDK 的文件夹。
  • 下载安装 Maven 二进制存档
    • 在 Ubuntu 上,可以通过运行 apt-get install maven 来安装 Maven。
  • Git
    • 在 Ubuntu 上,可以通过运行 sudo apt-get install git 来安装 Git。

创建数据库帐户

在创建文档数据库之前,需通过 Azure Cosmos DB 创建 SQL API 帐户。

  1. 在新浏览器窗口中,登录到 Azure 门户

  2. 选择“创建资源” > “数据库” > “Azure Cosmos DB”。

    Azure 门户“数据库”窗格

  3. 在“创建 Azure Cosmos DB 帐户”页上,输入新 Azure Cosmos DB 帐户的基本设置。

    设置 说明
    订阅 订阅 选择要用于此 Azure Cosmos DB 帐户的 Azure 订阅。
    资源组 新建

    然后输入在 ID 中提供的同一唯一名称
    选择“新建”。 然后输入帐户的新资源组名称。 为简单起见,可以使用与 ID 相同的名称。
    帐户名 输入唯一的名称 输入标识此 Azure Cosmos DB 帐户的唯一名称。 由于 documents.azure.cn 字符串将追加到所提供的 ID 后面以创建 URI,因此,请使用唯一的 ID。

    ID 只能包含小写字母、数字和连字符 (-) 字符。 它的长度必须介于 3 到 31 个字符之间。
    API Core(SQL) API 确定要创建的帐户的类型。 Azure Cosmos DB 提供两种 API:适用于文档数据库的 Core(SQL) 和适用于文档数据库的 MongoDB。 目前,你必须为每种 API 创建单独的帐户。

    之所以选择 Core(SQL) 是因为本文将使用 SQL 语法创建文档数据库并进行查询。

    详细了解 SQL API
    位置 选择离用户最近的区域 选择用于托管 Azure Cosmos DB 帐户的地理位置。 使用离用户最近的位置,使他们能够以最快的速度访问数据。

    选择“查看 + 创建”。 可以跳过“网络”和“标记”部分。

    Azure Cosmos DB 的“新建帐户”页

  4. 创建帐户需要几分钟时间。 等待门户中显示“祝贺你!已创建 Azure Cosmos DB 帐户”页。

    Azure 门户“通知”窗格

添加集合

现在可以在 Azure 门户中使用数据资源管理器工具来创建数据库和集合。

  1. 单击“数据资源管理器” > “新建集合”。

    “添加集合”区域显示在最右侧,可能需要向右滚动才能看到它。

    Azure 门户“数据资源管理器”,“添加集合”窗格

  2. 在“添加集合”页上,输入新集合的设置。

    设置 建议的值 说明
    数据库 ID 任务 输入 Tasks 作为新数据库的名称。 数据库名称必须包含 1 到 255 个字符,不能包含 /, \\, #, ? 或尾随空格。
    集合 ID Items 输入 Items 作为新集合的名称。 集合 ID 与数据库名称的字符要求相同。
    分区键 输入分区键,例如 /userid。
    吞吐量 400 RU 将吞吐量更改为每秒 400 个请求单位 (RU/s)。 如果想要减少延迟,以后可以增加吞吐量。

    除了前面的设置,还可以选择为集合添加“唯一键”。 在此示例中,请将此字段留空。 开发人员可以使用唯一键向数据库添加一层数据完整性。 创建集合时,通过创建唯一键策略,可确保每个分区键的一个或多个值的唯一性。 若要了解详细信息,请参阅 Azure Cosmos DB 中的唯一键一文。

    单击“确定”。

    数据资源管理器将显示新的数据库和集合。

    显示新的数据库和集合的 Azure 门户数据资源管理器

添加示例数据

现在可以使用数据资源管理器将数据添加到新集合。

  1. 在数据资源管理器中,新数据库会显示在“集合”窗格中。 展开 Tasks 数据库,展开 Items 集合,单击“文档”,然后单击“新建文档”。

    在 Azure 门户的数据资源管理器中创建新文档

  2. 现在,将文档添加到具有以下结构的集合。

    {
        "id": "1",
        "category": "personal",
        "name": "groceries",
        "description": "Pick up apples and strawberries.",
        "isComplete": false
    }
    
  3. 将 json 添加到“文档”选项卡以后,单击“保存”。

    通过复制添加 json 数据,然后在 Azure 门户的数据资源管理器中单击“保存”

  4. 再创建并保存一个文档,在其中插入 id 属性的唯一值,并将其他属性更改为适当值。 新文档可以具有所需的任何结构,因为 Azure Cosmos DB 不对数据施加任何架构。

查询数据

现在可以在数据资源管理器中使用查询来检索和筛选数据。

  1. 请注意,查询默认设置为 SELECT * FROM c。 此默认查询检索并显示集合中的所有文档。

    数据资源管理器中的默认查询是“SELECT * FROM c”

  2. 在“文档”选项卡上,单击“编辑筛选器”按钮,将 ORDER BY c._ts DESC 添加到查询谓词框中,再单击“应用筛选器”,从而更改查询。

    添加“ORDER BY c._ts DESC”并单击“应用筛选器”,更改默认查询

此修改后的查询根据文档的时间戳按降序列出文档,所以现在最先列出的是第二个文档。 如果熟悉 SQL 语法,可以在此框中输入任何受支持的 SQL 查询

数据资源管理器中的工作到此结束。 继续处理代码前,请注意,还可以使用数据资源管理器创建存储过程、UDF 和触发器,实现服务器端业务逻辑和缩放吞吐量。 数据资源管理器公开 API 中提供的所有内置编程数据访问,但你可以使用它轻松访问 Azure 门户中的数据。

克隆示例应用程序

现在,让我们转到如何使用代码上来。 接下来,克隆 GitHub 中的 SQL API 应用程序,设置连接字符串,并运行应用程序。 会看到以编程方式处理数据是多么容易。

  1. 运行下列命令以克隆示例存储库。 此命令在计算机上创建示例应用程序的副本。

    git clone https://github.com/Azure-Samples/azure-cosmos-db-sql-api-async-java-getting-started
    

查看代码

此步骤是可选的。 如果有意了解如何使用代码创建数据库资源,可以查看以下代码片段。 否则,可以跳到运行应用

  • AsyncDocumentClient 初始化。 AsyncDocumentClient 为 Azure Cosmos DB 数据库服务提供客户端逻辑表示。 此客户端用于对服务配置和执行请求。

    client = new AsyncDocumentClient.Builder()
             .withServiceEndpoint(YOUR_COSMOS_DB_ENDPOINT)
             .withMasterKeyOrResourceToken(YOUR_COSMOS_DB_MASTER_KEY)
             .withConnectionPolicy(ConnectionPolicy.GetDefault())
             .withConsistencyLevel(ConsistencyLevel.Eventual)
             .build();
    
  • Database 创建。

    Database databaseDefinition = new Database();
    databaseDefinition.setId(databaseName);
    
    client.createDatabase(databaseDefinition, null)
            .toCompletable()
            .await();
    
  • DocumentCollection 创建。

    DocumentCollection collectionDefinition = new DocumentCollection();
    collectionDefinition.setId(collectionName);
    
    //...
    
    client.createCollection(databaseLink, collectionDefinition, requestOptions)
            .toCompletable()
            .await();
    
  • 使用 createDocument 方法创建文档。

    // Any Java object within your code
    // can be serialized into JSON and written to Azure Cosmos DB
    Family andersenFamily = new Family();
    andersenFamily.setId("Andersen.1");
    andersenFamily.setLastName("Andersen");
    // More properties
    
    String collectionLink = String.format("/dbs/%s/colls/%s", databaseName, collectionName);
    client.createDocument(collectionLink, family, null, true)
            .toCompletable()
            .await();
    
    
  • 使用 queryDocuments 方法,对 JSON 执行 SQL 查询。

    FeedOptions queryOptions = new FeedOptions();
    queryOptions.setPageSize(-1);
    queryOptions.setEnableCrossPartitionQuery(true);
    queryOptions.setMaxDegreeOfParallelism(-1);
    
    String collectionLink = String.format("/dbs/%s/colls/%s",
            databaseName,
            collectionName);
    Iterator<FeedResponse<Document>> it = client.queryDocuments(
            collectionLink,
            "SELECT * FROM Family WHERE Family.lastName = 'Andersen'",
            queryOptions).toBlocking().getIterator();
    
    System.out.println("Running SQL query...");
    while (it.hasNext()) {
        FeedResponse<Document> page = it.next();
        System.out.println(
                String.format("\tRead a page of results with %d items",
                        page.getResults().size()));
        for (Document doc : page.getResults()) {
            System.out.println(String.format("\t doc %s", doc));
        }
    }
    

运行应用

现在返回到 Azure 门户,获取连接字符串信息,并使用终结点信息启动应用。 这样,应用程序就可以与托管的数据库进行通信。

  1. 在 git 终端窗口中,通过 cd 转至示例代码文件夹。

    cd azure-cosmos-db-sql-api-async-java-getting-started/azure-cosmosdb-get-started
    
  2. 在 git 终端窗口中,使用以下命令安装所需的 Java 包。

    mvn package
    
  3. 在 git 终端窗口中,使用以下命令启动 Java 应用程序(将 YOUR_COSMOS_DB_HOSTNAME 替换为门户中带引号的 URI 值,将 YOUR_COSMOS_DB_MASTER_KEY 替换为门户中带引号的主键)

    mvn exec:java -DACCOUNT_HOST=YOUR_COSMOS_DB_HOSTNAME -DACCOUNT_KEY=YOUR_COSMOS_DB_MASTER_KEY
    
    

    此时,终端窗口显示通知,提示 FamilyDB 数据库已创建。

  4. 按下某个键创建数据库,然后按下另一个键创建集合。

    在浏览器中切换回到数据资源管理器,可以看到,帐户中现在包含 FamilyDB 数据库和 FamilyCollection 集合。

  5. 切换到控制台窗口,按下某个键创建第一个文档,再按下另一个键创建第二个文档。 然后切换回到数据资源管理器以查看这些资源。

  6. 按下某个键运行查询,并在控制台窗口中查看输出。

  7. 应用不删除创建的资源。 切换回门户,以便在帐户中清理资源, 以免产生费用。

    控制台输出

在 Azure 门户中查看 SLA

在 Azure 门户中监视帐户中资源的吞吐量、存储空间、可用性、延迟和一致性。 让我们快速了解一下这些指标。

  1. 在导航菜单中单击“指标”。

    Azure 门户中的指标

  2. 单击每个选项卡,以便了解 Azure Cosmos DB 提供的指标。

    Azure Cosmos DB 服务级别协议 (SLA) 关联的每个图表都提供了一行,显示是否违反了任何 SLA。 Azure Cosmos DB 通过此套指标使监视 SLA 的操作更透明。

    Azure Cosmos DB 指标套件

清理资源

如果不打算继续使用此应用,请按照以下步骤删除本快速入门中创建的所有资源,以免产生任何费用:

  1. 在 Azure 门户的最左侧选择“资源组”,,然后选择创建的资源组。

    如果左侧菜单处于折叠状态,请单击 “展开”按钮 将其展开。

    Azure 门户中的指标

  2. 在新窗口中选择资源组,然后单击“删除资源组”。

    Azure 门户中的指标

  3. 在新窗口中键入要删除的资源组的名称,然后单击“删除”。

后续步骤

本快速入门介绍了如何使用数据资源管理器创建 Azure Cosmos DB 帐户、文档数据库和集合,以及如何通过运行应用以编程方式执行同一操作。 现在可以将其他数据导入 Azure Cosmos DB 集合。